This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Integrate build parts of mainline
[perl5.git] / cop.h
CommitLineData
a0d0e21e 1/* cop.h
79072805 2 *
bc89e66f 3 * Copyright (c) 1991-2001, 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 */
ac27b0f5 24 SV * cop_io; /* lexical IO defaults */
79072805
LW
25};
26
27#define Nullcop Null(COP*)
28
57843af0
GS
29#ifdef USE_ITHREADS
30# define CopFILE(c) ((c)->cop_file)
31# define CopFILEGV(c) (CopFILE(c) \
32 ? gv_fetchfile(CopFILE(c)) : Nullgv)
f4dd75d9 33# define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
57843af0
GS
34# define CopFILESV(c) (CopFILE(c) \
35 ? GvSV(gv_fetchfile(CopFILE(c))) : Nullsv)
36# define CopFILEAV(c) (CopFILE(c) \
37 ? GvAV(gv_fetchfile(CopFILE(c))) : Nullav)
57843af0 38# define CopSTASHPV(c) ((c)->cop_stashpv)
7b910cb8 39# define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = ((pv) ? savepv(pv) : Nullch))
11faa288
GS
40# define CopSTASH(c) (CopSTASHPV(c) \
41 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : Nullhv)
7b910cb8 42# define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME(hv) : Nullch)
f4dd75d9 43# define CopSTASH_eq(c,hv) ((hv) \
ed094faf
GS
44 && (CopSTASHPV(c) == HvNAME(hv) \
45 || (CopSTASHPV(c) && HvNAME(hv) \
46 && strEQ(CopSTASHPV(c), HvNAME(hv)))))
57843af0
GS
47#else
48# define CopFILEGV(c) ((c)->cop_filegv)
f4dd75d9
GS
49# define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
50# define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
57843af0
GS
51# define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : Nullsv)
52# define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : Nullav)
53# define CopFILE(c) (CopFILESV(c) ? SvPVX(CopFILESV(c)) : Nullch)
54# define CopSTASH(c) ((c)->cop_stash)
f4dd75d9 55# define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
57843af0 56# define CopSTASHPV(c) (CopSTASH(c) ? HvNAME(CopSTASH(c)) : Nullch)
f4dd75d9
GS
57 /* cop_stash is not refcounted */
58# define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
59# define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
57843af0
GS
60#endif /* USE_ITHREADS */
61
ed094faf 62#define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
cc49e20b 63#define CopLINE(c) ((c)->cop_line)
57843af0
GS
64#define CopLINE_inc(c) (++CopLINE(c))
65#define CopLINE_dec(c) (--CopLINE(c))
66#define CopLINE_set(c,l) (CopLINE(c) = (l))
cc49e20b 67
79072805
LW
68/*
69 * Here we have some enormously heavy (or at least ponderous) wizardry.
70 */
71
72/* subroutine context */
73struct block_sub {
74 CV * cv;
75 GV * gv;
463ee0b2 76 GV * dfoutgv;
4d1ff10f 77#ifndef USE_5005THREADS
79072805 78 AV * savearray;
4d1ff10f 79#endif /* USE_5005THREADS */
79072805
LW
80 AV * argarray;
81 U16 olddepth;
82 U8 hasargs;
cd06dffe 83 U8 lval; /* XXX merge lval and hasargs? */
7032098e 84 SV ** oldcurpad;
79072805
LW
85};
86
87#define PUSHSUB(cx) \
88 cx->blk_sub.cv = cv; \
79072805 89 cx->blk_sub.olddepth = CvDEPTH(cv); \
cd06dffe
GS
90 cx->blk_sub.hasargs = hasargs; \
91 cx->blk_sub.lval = PL_op->op_private & \
92 (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
79072805
LW
93
94#define PUSHFORMAT(cx) \
95 cx->blk_sub.cv = cv; \
96 cx->blk_sub.gv = gv; \
4633a7c4 97 cx->blk_sub.hasargs = 0; \
3280af22 98 cx->blk_sub.dfoutgv = PL_defoutgv; \
4633a7c4 99 (void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
79072805 100
4d1ff10f 101#ifdef USE_5005THREADS
7766f137 102# define POP_SAVEARRAY() NOOP
6d4ff0d2 103#else
7766f137 104# define POP_SAVEARRAY() \
6d4ff0d2 105 STMT_START { \
3280af22 106 SvREFCNT_dec(GvAV(PL_defgv)); \
a8bba7fa 107 GvAV(PL_defgv) = cx->blk_sub.savearray; \
6d4ff0d2 108 } STMT_END
4d1ff10f 109#endif /* USE_5005THREADS */
6d4ff0d2 110
ecf8e9dd 111/* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
8e09340b
GS
112 * leave any (a fast av_clear(ary), basically) */
113#define CLEAR_ARGARRAY(ary) \
114 STMT_START { \
115 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
116 SvPVX(ary) = (char*)AvALLOC(ary); \
117 AvFILLp(ary) = -1; \
118 } STMT_END
7766f137 119
b0d9ce38
GS
120#define POPSUB(cx,sv) \
121 STMT_START { \
a8bba7fa 122 if (cx->blk_sub.hasargs) { \
7766f137 123 POP_SAVEARRAY(); \
d8b46c1b 124 /* abandon @_ if it got reified */ \
a8bba7fa
GS
125 if (AvREAL(cx->blk_sub.argarray)) { \
126 SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
127 SvREFCNT_dec(cx->blk_sub.argarray); \
128 cx->blk_sub.argarray = newAV(); \
129 av_extend(cx->blk_sub.argarray, fill); \
130 AvFLAGS(cx->blk_sub.argarray) = AVf_REIFY; \
7032098e 131 cx->blk_sub.oldcurpad[0] = (SV*)cx->blk_sub.argarray; \
d8b46c1b 132 } \
7766f137 133 else { \
8e09340b 134 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
7766f137 135 } \
79072805 136 } \
b0d9ce38
GS
137 sv = (SV*)cx->blk_sub.cv; \
138 if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \
139 sv = Nullsv; \
140 } STMT_END
141
142#define LEAVESUB(sv) \
143 STMT_START { \
144 if (sv) \
145 SvREFCNT_dec(sv); \
146 } STMT_END
79072805
LW
147
148#define POPFORMAT(cx) \
4633a7c4
LW
149 setdefout(cx->blk_sub.dfoutgv); \
150 SvREFCNT_dec(cx->blk_sub.dfoutgv);
79072805
LW
151
152/* eval context */
153struct block_eval {
154 I32 old_in_eval;
155 I32 old_op_type;
0f79a09d 156 SV * old_namesv;
79072805 157 OP * old_eval_root;
748a9306 158 SV * cur_text;
2090ab20 159 CV * cv;
79072805
LW
160};
161
8990e307 162#define PUSHEVAL(cx,n,fgv) \
0f79a09d 163 STMT_START { \
3280af22 164 cx->blk_eval.old_in_eval = PL_in_eval; \
a8bba7fa 165 cx->blk_eval.old_op_type = PL_op->op_type; \
0f79a09d 166 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : Nullsv); \
a8bba7fa 167 cx->blk_eval.old_eval_root = PL_eval_root; \
0f79a09d 168 cx->blk_eval.cur_text = PL_linestr; \
2090ab20 169 cx->blk_eval.cv = Nullcv; /* set by doeval(), as applicable */ \
0f79a09d 170 } STMT_END
79072805
LW
171
172#define POPEVAL(cx) \
0f79a09d 173 STMT_START { \
3280af22 174 PL_in_eval = cx->blk_eval.old_in_eval; \
79072805 175 optype = cx->blk_eval.old_op_type; \
7766f137 176 PL_eval_root = cx->blk_eval.old_eval_root; \
0f79a09d
GS
177 if (cx->blk_eval.old_namesv) \
178 sv_2mortal(cx->blk_eval.old_namesv); \
179 } STMT_END
79072805
LW
180
181/* loop context */
182struct block_loop {
183 char * label;
184 I32 resetsp;
185 OP * redo_op;
186 OP * next_op;
187 OP * last_op;
7766f137
GS
188#ifdef USE_ITHREADS
189 void * iterdata;
9e509370 190 SV ** oldcurpad;
7766f137 191#else
79072805 192 SV ** itervar;
7766f137 193#endif
79072805 194 SV * itersave;
5f05dabc 195 SV * iterlval;
79072805 196 AV * iterary;
89ea2908
GA
197 IV iterix;
198 IV itermax;
79072805
LW
199};
200
7766f137
GS
201#ifdef USE_ITHREADS
202# define CxITERVAR(c) \
203 ((c)->blk_loop.iterdata \
204 ? (CxPADLOOP(cx) \
e830ead6 205 ? &((c)->blk_loop.oldcurpad)[INT2PTR(PADOFFSET, (c)->blk_loop.iterdata)] \
7766f137
GS
206 : &GvSV((GV*)(c)->blk_loop.iterdata)) \
207 : (SV**)NULL)
208# define CX_ITERDATA_SET(cx,idata) \
9e509370 209 cx->blk_loop.oldcurpad = PL_curpad; \
155aba94 210 if ((cx->blk_loop.iterdata = (idata))) \
7766f137
GS
211 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
212#else
213# define CxITERVAR(c) ((c)->blk_loop.itervar)
214# define CX_ITERDATA_SET(cx,ivar) \
155aba94 215 if ((cx->blk_loop.itervar = (SV**)(ivar))) \
7766f137
GS
216 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
217#endif
218
219#define PUSHLOOP(cx, dat, s) \
38a230cb
GS
220 cx->blk_loop.label = PL_curcop->cop_label; \
221 cx->blk_loop.resetsp = s - PL_stack_base; \
79072805
LW
222 cx->blk_loop.redo_op = cLOOP->op_redoop; \
223 cx->blk_loop.next_op = cLOOP->op_nextop; \
224 cx->blk_loop.last_op = cLOOP->op_lastop; \
44a8e56a
PP
225 cx->blk_loop.iterlval = Nullsv; \
226 cx->blk_loop.iterary = Nullav; \
7766f137
GS
227 cx->blk_loop.iterix = -1; \
228 CX_ITERDATA_SET(cx,dat);
79072805
LW
229
230#define POPLOOP(cx) \
a8bba7fa 231 SvREFCNT_dec(cx->blk_loop.iterlval); \
7766f137
GS
232 if (CxITERVAR(cx)) { \
233 SV **s_v_p = CxITERVAR(cx); \
234 sv_2mortal(*s_v_p); \
235 *s_v_p = cx->blk_loop.itersave; \
44a8e56a 236 } \
a8bba7fa
GS
237 if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
238 SvREFCNT_dec(cx->blk_loop.iterary);
79072805
LW
239
240/* context common to subroutines, evals and loops */
241struct block {
242 I32 blku_oldsp; /* stack pointer to copy stuff down to */
243 COP * blku_oldcop; /* old curcop pointer */
244 I32 blku_oldretsp; /* return stack index */
245 I32 blku_oldmarksp; /* mark stack index */
246 I32 blku_oldscopesp; /* scope stack index */
247 PMOP * blku_oldpm; /* values of pattern match vars */
248 U8 blku_gimme; /* is this block running in list context? */
249
250 union {
251 struct block_sub blku_sub;
252 struct block_eval blku_eval;
253 struct block_loop blku_loop;
254 } blk_u;
255};
256#define blk_oldsp cx_u.cx_blk.blku_oldsp
257#define blk_oldcop cx_u.cx_blk.blku_oldcop
258#define blk_oldretsp cx_u.cx_blk.blku_oldretsp
259#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
260#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
261#define blk_oldpm cx_u.cx_blk.blku_oldpm
262#define blk_gimme cx_u.cx_blk.blku_gimme
263#define blk_sub cx_u.cx_blk.blk_u.blku_sub
264#define blk_eval cx_u.cx_blk.blk_u.blku_eval
265#define blk_loop cx_u.cx_blk.blk_u.blku_loop
266
267/* Enter a block. */
8990e307 268#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805 269 cx->cx_type = t, \
3280af22
NIS
270 cx->blk_oldsp = sp - PL_stack_base, \
271 cx->blk_oldcop = PL_curcop, \
1aff0e91 272 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22 273 cx->blk_oldscopesp = PL_scopestack_ix, \
1aff0e91 274 cx->blk_oldretsp = PL_retstack_ix, \
3280af22 275 cx->blk_oldpm = PL_curpm, \
79072805 276 cx->blk_gimme = gimme; \
bf49b057 277 DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
1aff0e91 278 (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
79072805
LW
279
280/* Exit a block (RETURN and LAST). */
a0d0e21e 281#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
1aff0e91 282 newsp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
283 PL_curcop = cx->blk_oldcop, \
284 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
285 PL_scopestack_ix = cx->blk_oldscopesp, \
286 PL_retstack_ix = cx->blk_oldretsp, \
287 pm = cx->blk_oldpm, \
288 gimme = cx->blk_gimme; \
bf49b057 289 DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
22c35a8c 290 (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
79072805
LW
291
292/* Continue a block elsewhere (NEXT and REDO). */
3280af22 293#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
1aff0e91 294 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
295 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
296 PL_scopestack_ix = cx->blk_oldscopesp, \
2158dd9b
GS
297 PL_retstack_ix = cx->blk_oldretsp, \
298 PL_curpm = cx->blk_oldpm
79072805
LW
299
300/* substitution context */
301struct subst {
302 I32 sbu_iters;
303 I32 sbu_maxiters;
22e551b9 304 I32 sbu_rflags;
4633a7c4 305 I32 sbu_oldsave;
71be2cbc
PP
306 bool sbu_once;
307 bool sbu_rxtainted;
79072805
LW
308 char * sbu_orig;
309 SV * sbu_dstr;
310 SV * sbu_targ;
311 char * sbu_s;
312 char * sbu_m;
313 char * sbu_strend;
c90c0ff4 314 void * sbu_rxres;
c07a80fd 315 REGEXP * sbu_rx;
79072805
LW
316};
317#define sb_iters cx_u.cx_subst.sbu_iters
318#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9 319#define sb_rflags cx_u.cx_subst.sbu_rflags
4633a7c4 320#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc
PP
321#define sb_once cx_u.cx_subst.sbu_once
322#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805
LW
323#define sb_orig cx_u.cx_subst.sbu_orig
324#define sb_dstr cx_u.cx_subst.sbu_dstr
325#define sb_targ cx_u.cx_subst.sbu_targ
326#define sb_s cx_u.cx_subst.sbu_s
327#define sb_m cx_u.cx_subst.sbu_m
328#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4 329#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd 330#define sb_rx cx_u.cx_subst.sbu_rx
79072805
LW
331
332#define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
333 cx->sb_iters = iters, \
334 cx->sb_maxiters = maxiters, \
22e551b9 335 cx->sb_rflags = r_flags, \
4633a7c4 336 cx->sb_oldsave = oldsave, \
71be2cbc
PP
337 cx->sb_once = once, \
338 cx->sb_rxtainted = rxtainted, \
79072805
LW
339 cx->sb_orig = orig, \
340 cx->sb_dstr = dstr, \
341 cx->sb_targ = targ, \
342 cx->sb_s = s, \
343 cx->sb_m = m, \
344 cx->sb_strend = strend, \
c90c0ff4 345 cx->sb_rxres = Null(void*), \
c07a80fd 346 cx->sb_rx = rx, \
c90c0ff4
PP
347 cx->cx_type = CXt_SUBST; \
348 rxres_save(&cx->sb_rxres, rx)
79072805 349
c90c0ff4
PP
350#define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
351 rxres_free(&cx->sb_rxres)
79072805
LW
352
353struct context {
6b35e009 354 U32 cx_type; /* what kind of context this is */
79072805
LW
355 union {
356 struct block cx_blk;
357 struct subst cx_subst;
358 } cx_u;
359};
6b35e009
GS
360
361#define CXTYPEMASK 0xff
79072805
LW
362#define CXt_NULL 0
363#define CXt_SUB 1
364#define CXt_EVAL 2
365#define CXt_LOOP 3
366#define CXt_SUBST 4
367#define CXt_BLOCK 5
7766f137 368#define CXt_FORMAT 6
79072805 369
6b35e009
GS
370/* private flags for CXt_EVAL */
371#define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
1d76a5c3 372#define CXp_TRYBLOCK 0x00000200 /* eval{}, not eval'' or similar */
6b35e009 373
7766f137
GS
374#ifdef USE_ITHREADS
375/* private flags for CXt_LOOP */
376# define CXp_PADVAR 0x00000100 /* itervar lives on pad, iterdata
377 has pad offset; if not set,
378 iterdata holds GV* */
379# define CxPADLOOP(c) (((c)->cx_type & (CXt_LOOP|CXp_PADVAR)) \
380 == (CXt_LOOP|CXp_PADVAR))
381#endif
382
6b35e009 383#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
7766f137
GS
384#define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL|CXp_REAL)) \
385 == (CXt_EVAL|CXp_REAL))
1d76a5c3
GS
386#define CxTRYBLOCK(c) (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK)) \
387 == (CXt_EVAL|CXp_TRYBLOCK))
6b35e009 388
79072805
LW
389#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
390
ccfc67b7
JH
391/*
392=head1 "Gimme" Values
393*/
954c1994
GS
394
395/*
396=for apidoc AmU||G_SCALAR
397Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
398L<perlcall>.
399
400=for apidoc AmU||G_ARRAY
91e74348 401Used to indicate list context. See C<GIMME_V>, C<GIMME> and
954c1994
GS
402L<perlcall>.
403
404=for apidoc AmU||G_VOID
405Used to indicate void context. See C<GIMME_V> and L<perlcall>.
406
407=for apidoc AmU||G_DISCARD
408Indicates that arguments returned from a callback should be discarded. See
409L<perlcall>.
410
411=for apidoc AmU||G_EVAL
412
413Used to force a Perl C<eval> wrapper around a callback. See
414L<perlcall>.
415
416=for apidoc AmU||G_NOARGS
417
418Indicates that no arguments are being sent to a callback. See
419L<perlcall>.
420
421=cut
422*/
423
a0d0e21e
LW
424#define G_SCALAR 0
425#define G_ARRAY 1
54310121 426#define G_VOID 128 /* skip this bit when adding flags below */
79072805 427
864dbfa3 428/* extra flags for Perl_call_* routines */
a0d0e21e
LW
429#define G_DISCARD 2 /* Call FREETMPS. */
430#define G_EVAL 4 /* Assume eval {} around subroutine call. */
431#define G_NOARGS 8 /* Don't construct a @_ array. */
54310121 432#define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
491527d0 433#define G_NODEBUG 32 /* Disable debugging at toplevel. */
968b3946 434#define G_METHOD 64 /* Calling method. */
e336de0d 435
faef0170
HS
436/* flag bits for PL_in_eval */
437#define EVAL_NULL 0 /* not in an eval */
438#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
439#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3 440#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
6dc8a9e4 441#define EVAL_INREQUIRE 8 /* The code is being required. */
faef0170 442
e336de0d
GS
443/* Support for switching (stack and block) contexts.
444 * This ensures magic doesn't invalidate local stack and cx pointers.
445 */
446
e788e7d3
GS
447#define PERLSI_UNKNOWN -1
448#define PERLSI_UNDEF 0
449#define PERLSI_MAIN 1
450#define PERLSI_MAGIC 2
451#define PERLSI_SORT 3
452#define PERLSI_SIGNAL 4
453#define PERLSI_OVERLOAD 5
454#define PERLSI_DESTROY 6
455#define PERLSI_WARNHOOK 7
456#define PERLSI_DIEHOOK 8
457#define PERLSI_REQUIRE 9
e336de0d
GS
458
459struct stackinfo {
460 AV * si_stack; /* stack for current runlevel */
461 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
462 I32 si_cxix; /* current context index */
463 I32 si_cxmax; /* maximum allocated index */
464 I32 si_type; /* type of runlevel */
465 struct stackinfo * si_prev;
466 struct stackinfo * si_next;
ce2f7c3b 467 I32 si_markoff; /* offset where markstack begins for us.
e336de0d
GS
468 * currently used only with DEBUGGING,
469 * but not #ifdef-ed for bincompat */
470};
471
472typedef struct stackinfo PERL_SI;
473
3280af22
NIS
474#define cxstack (PL_curstackinfo->si_cxstack)
475#define cxstack_ix (PL_curstackinfo->si_cxix)
476#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d
GS
477
478#ifdef DEBUGGING
ce2f7c3b
GS
479# define SET_MARK_OFFSET \
480 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
e336de0d 481#else
ce2f7c3b 482# define SET_MARK_OFFSET NOOP
e336de0d
GS
483#endif
484
d3acc0f7 485#define PUSHSTACKi(type) \
e336de0d 486 STMT_START { \
3280af22 487 PERL_SI *next = PL_curstackinfo->si_next; \
e336de0d
GS
488 if (!next) { \
489 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22
NIS
490 next->si_prev = PL_curstackinfo; \
491 PL_curstackinfo->si_next = next; \
e336de0d
GS
492 } \
493 next->si_type = type; \
494 next->si_cxix = -1; \
495 AvFILLp(next->si_stack) = 0; \
3280af22
NIS
496 SWITCHSTACK(PL_curstack,next->si_stack); \
497 PL_curstackinfo = next; \
ce2f7c3b 498 SET_MARK_OFFSET; \
e336de0d
GS
499 } STMT_END
500
e788e7d3 501#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7 502
3095d977
GS
503/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
504 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7 505#define POPSTACK \
e336de0d 506 STMT_START { \
39644a26 507 dSP; \
3280af22 508 PERL_SI *prev = PL_curstackinfo->si_prev; \
e336de0d 509 if (!prev) { \
bf49b057 510 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
e336de0d
GS
511 my_exit(1); \
512 } \
3280af22 513 SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d 514 /* don't free prev here, free them all at the END{} */ \
3280af22 515 PL_curstackinfo = prev; \
e336de0d
GS
516 } STMT_END
517
518#define POPSTACK_TO(s) \
519 STMT_START { \
3280af22 520 while (PL_curstack != s) { \
bac4b2ad 521 dounwind(-1); \
d3acc0f7 522 POPSTACK; \
bac4b2ad 523 } \
e336de0d 524 } STMT_END