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