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