This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Abstract all the accesses to cop_arybase (apart from ByteLoader)
[perl5.git] / cop.h
CommitLineData
a0d0e21e 1/* cop.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
acde74e1 4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006 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 *
a3985cdc 9 * Control ops (cops) are one of the three ops OP_NEXTSTATE, OP_DBSTATE,
3ffa1527
JH
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,
a3985cdc 13 * and thus can be used to determine our current state.
79072805
LW
14 */
15
0d2925a6
DM
16/* A jmpenv packages the state required to perform a proper non-local jump.
17 * Note that there is a start_env initialized when perl starts, and top_env
18 * points to this initially, so top_env should always be non-null.
19 *
20 * Existence of a non-null top_env->je_prev implies it is valid to call
21 * longjmp() at that runlevel (we make sure start_env.je_prev is always
22 * null to ensure this).
23 *
24 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
25 * establish a local jmpenv to handle exception traps. Care must be taken
26 * to restore the previous value of je_mustcatch before exiting the
27 * stack frame iff JMPENV_PUSH was not called in that stack frame.
28 * GSAR 97-03-27
29 */
30
31struct jmpenv {
32 struct jmpenv * je_prev;
33 Sigjmp_buf je_buf; /* only for use if !je_throw */
34 int je_ret; /* last exception thrown */
35 bool je_mustcatch; /* need to call longjmp()? */
36};
37
38typedef struct jmpenv JMPENV;
39
40#ifdef OP_IN_REGISTER
41#define OP_REG_TO_MEM PL_opsave = op
42#define OP_MEM_TO_REG op = PL_opsave
43#else
44#define OP_REG_TO_MEM NOOP
45#define OP_MEM_TO_REG NOOP
46#endif
47
48/*
49 * How to build the first jmpenv.
50 *
51 * top_env needs to be non-zero. It points to an area
52 * in which longjmp() stuff is stored, as C callstack
53 * info there at least is thread specific this has to
54 * be per-thread. Otherwise a 'die' in a thread gives
55 * that thread the C stack of last thread to do an eval {}!
56 */
57
58#define JMPENV_BOOTSTRAP \
59 STMT_START { \
60 Zero(&PL_start_env, 1, JMPENV); \
61 PL_start_env.je_ret = -1; \
62 PL_start_env.je_mustcatch = TRUE; \
63 PL_top_env = &PL_start_env; \
64 } STMT_END
65
66/*
67 * PERL_FLEXIBLE_EXCEPTIONS
68 *
69 * All the flexible exceptions code has been removed.
70 * See the following threads for details:
71 *
72 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2004-07/msg00378.html
73 *
74 * Joshua's original patches (which weren't applied) and discussion:
75 *
76 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01396.html
77 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01489.html
78 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01491.html
79 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01608.html
80 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02144.html
81 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02998.html
82 *
83 * Chip's reworked patch and discussion:
84 *
85 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html
86 *
87 * The flaw in these patches (which went unnoticed at the time) was
88 * that they moved some code that could potentially die() out of the
89 * region protected by the setjmp()s. This caused exceptions within
90 * END blocks and such to not be handled by the correct setjmp().
91 *
92 * The original patches that introduces flexible exceptions were:
93 *
94 * http://public.activestate.com/cgi-bin/perlbrowse?patch=3386
95 * http://public.activestate.com/cgi-bin/perlbrowse?patch=5162
96 */
97
98#define dJMPENV JMPENV cur_env
99
100#define JMPENV_PUSH(v) \
101 STMT_START { \
102 DEBUG_l(Perl_deb(aTHX_ "Setting up jumplevel %p, was %p\n", \
103 &cur_env, PL_top_env)); \
104 cur_env.je_prev = PL_top_env; \
105 OP_REG_TO_MEM; \
106 cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK); \
107 OP_MEM_TO_REG; \
108 PL_top_env = &cur_env; \
109 cur_env.je_mustcatch = FALSE; \
110 (v) = cur_env.je_ret; \
111 } STMT_END
112
113#define JMPENV_POP \
114 STMT_START { \
115 DEBUG_l(Perl_deb(aTHX_ "popping jumplevel was %p, now %p\n", \
116 PL_top_env, cur_env.je_prev)); \
117 PL_top_env = cur_env.je_prev; \
118 } STMT_END
119
120#define JMPENV_JUMP(v) \
121 STMT_START { \
122 OP_REG_TO_MEM; \
123 if (PL_top_env->je_prev) \
124 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
125 if ((v) == 2) \
37038d91 126 PerlProc_exit(STATUS_EXIT); \
0d2925a6
DM
127 PerlIO_printf(PerlIO_stderr(), "panic: top_env\n"); \
128 PerlProc_exit(1); \
129 } STMT_END
130
131#define CATCH_GET (PL_top_env->je_mustcatch)
132#define CATCH_SET(v) (PL_top_env->je_mustcatch = (v))
133
134
135
79072805
LW
136struct cop {
137 BASEOP
a0d0e21e 138 char * cop_label; /* label for this construct */
57843af0 139#ifdef USE_ITHREADS
11faa288 140 char * cop_stashpv; /* package line was compiled in */
57843af0
GS
141 char * cop_file; /* file name the following line # is from */
142#else
11faa288 143 HV * cop_stash; /* package line was compiled in */
79072805 144 GV * cop_filegv; /* file the following line # is from */
57843af0 145#endif
a0d0e21e
LW
146 U32 cop_seq; /* parse sequence number */
147 I32 cop_arybase; /* array base this line was compiled with */
79072805 148 line_t cop_line; /* line # of this command */
599cee73 149 SV * cop_warnings; /* lexical warnings bitmask */
ac27b0f5 150 SV * cop_io; /* lexical IO defaults */
b3ca2e83
NC
151 /* compile time state of %^H. See the comment in op.c for how this is
152 used to recreate a hash to return from caller. */
153 struct refcounted_he * cop_hints;
79072805
LW
154};
155
57843af0
GS
156#ifdef USE_ITHREADS
157# define CopFILE(c) ((c)->cop_file)
158# define CopFILEGV(c) (CopFILE(c) \
a0714e2c 159 ? gv_fetchfile(CopFILE(c)) : NULL)
083fcd59 160
7e4e8c89
NC
161# ifdef NETWARE
162# define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
163# else
164# define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
165# endif
083fcd59 166
57843af0 167# define CopFILESV(c) (CopFILE(c) \
a0714e2c 168 ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
57843af0 169# define CopFILEAV(c) (CopFILE(c) \
7d49f689 170 ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
8688788e
SH
171# ifdef DEBUGGING
172# define CopFILEAVx(c) (assert(CopFILE(c)), \
36c7798d 173 GvAV(gv_fetchfile(CopFILE(c))))
8688788e
SH
174# else
175# define CopFILEAVx(c) (GvAV(gv_fetchfile(CopFILE(c))))
176# endif
57843af0 177# define CopSTASHPV(c) ((c)->cop_stashpv)
083fcd59 178
7e4e8c89 179# ifdef NETWARE
bd61b366 180# define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = ((pv) ? savepv(pv) : NULL))
7e4e8c89
NC
181# else
182# define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = savesharedpv(pv))
183# endif
083fcd59 184
11faa288 185# define CopSTASH(c) (CopSTASHPV(c) \
5c284bb0 186 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : NULL)
bd61b366 187# define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME_get(hv) : NULL)
ed221c57 188# define CopSTASH_eq(c,hv) ((hv) && stashpv_hvname_match(c,hv))
7e4e8c89
NC
189# ifdef NETWARE
190# define CopSTASH_free(c) SAVECOPSTASH_FREE(c)
7e4e8c89
NC
191# define CopFILE_free(c) SAVECOPFILE_FREE(c)
192# else
ed221c57 193# define CopSTASH_free(c) PerlMemShared_free(CopSTASHPV(c))
bd61b366 194# define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
7e4e8c89 195# endif
57843af0
GS
196#else
197# define CopFILEGV(c) ((c)->cop_filegv)
f4dd75d9
GS
198# define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
199# define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
a0714e2c 200# define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
7d49f689 201# define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
8688788e
SH
202# ifdef DEBUGGING
203# define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
204# else
205# define CopFILEAVx(c) (GvAV(CopFILEGV(c)))
206# endif
bd61b366 207# define CopFILE(c) (CopFILESV(c) ? SvPVX(CopFILESV(c)) : NULL)
57843af0 208# define CopSTASH(c) ((c)->cop_stash)
f4dd75d9 209# define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
bd61b366 210# define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
f4dd75d9
GS
211 /* cop_stash is not refcounted */
212# define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
213# define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
05ec9bb3 214# define CopSTASH_free(c)
a0714e2c 215# define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
05ec9bb3 216
57843af0
GS
217#endif /* USE_ITHREADS */
218
ed094faf 219#define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
cc49e20b 220#define CopLINE(c) ((c)->cop_line)
57843af0
GS
221#define CopLINE_inc(c) (++CopLINE(c))
222#define CopLINE_dec(c) (--CopLINE(c))
223#define CopLINE_set(c,l) (CopLINE(c) = (l))
cc49e20b 224
248c2a4d
CN
225/* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
226#ifdef MACOS_TRADITIONAL
227# define OutCopFILE(c) MacPerl_MPWFileName(CopFILE(c))
228#else
229# define OutCopFILE(c) CopFILE(c)
230#endif
231
fc15ae8f
NC
232/* CopARYBASE is likely to be removed soon. */
233#define CopARYBASE(c) ((c)->cop_arybase)
234#define CopARYBASE_get(c) ((c)->cop_arybase + 0)
235#define CopARYBASE_set(c, b) STMT_START { (c)->cop_arybase = (b); } STMT_END
236
79072805
LW
237/*
238 * Here we have some enormously heavy (or at least ponderous) wizardry.
239 */
240
241/* subroutine context */
242struct block_sub {
243 CV * cv;
244 GV * gv;
463ee0b2 245 GV * dfoutgv;
79072805
LW
246 AV * savearray;
247 AV * argarray;
bb172083 248 I32 olddepth;
79072805 249 U8 hasargs;
cd06dffe 250 U8 lval; /* XXX merge lval and hasargs? */
f3548bdc 251 PAD *oldcomppad;
f39bc417 252 OP * retop; /* op to execute on exit from sub */
79072805
LW
253};
254
b36bdeca
DM
255/* base for the next two macros. Don't use directly.
256 * Note that the refcnt of the cv is incremented twice; The CX one is
257 * decremented by LEAVESUB, the other by LEAVE. */
258
ee98a1d6 259#define PUSHSUB_BASE(cx) \
79072805 260 cx->blk_sub.cv = cv; \
b8f55b69 261 cx->blk_sub.olddepth = CvDEPTH(cv); \
b36bdeca 262 cx->blk_sub.hasargs = hasargs; \
5f66b61c 263 cx->blk_sub.retop = NULL; \
b36bdeca 264 if (!CvDEPTH(cv)) { \
b37c2d43
AL
265 SvREFCNT_inc_void(cv); \
266 SvREFCNT_inc_void(cv); \
b36bdeca
DM
267 SAVEFREESV(cv); \
268 }
269
ee98a1d6
DM
270
271#define PUSHSUB(cx) \
272 PUSHSUB_BASE(cx) \
cd06dffe
GS
273 cx->blk_sub.lval = PL_op->op_private & \
274 (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
79072805 275
ee98a1d6
DM
276/* variant for use by OP_DBSTATE, where op_private holds hint bits */
277#define PUSHSUB_DB(cx) \
278 PUSHSUB_BASE(cx) \
279 cx->blk_sub.lval = 0;
280
281
79072805
LW
282#define PUSHFORMAT(cx) \
283 cx->blk_sub.cv = cv; \
284 cx->blk_sub.gv = gv; \
5f66b61c 285 cx->blk_sub.retop = NULL; \
4633a7c4 286 cx->blk_sub.hasargs = 0; \
3280af22 287 cx->blk_sub.dfoutgv = PL_defoutgv; \
b37c2d43 288 SvREFCNT_inc_void(cx->blk_sub.dfoutgv)
79072805 289
3db8f154 290#define POP_SAVEARRAY() \
6d4ff0d2 291 STMT_START { \
3280af22 292 SvREFCNT_dec(GvAV(PL_defgv)); \
a8bba7fa 293 GvAV(PL_defgv) = cx->blk_sub.savearray; \
6d4ff0d2 294 } STMT_END
6d4ff0d2 295
ecf8e9dd 296/* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
8e09340b
GS
297 * leave any (a fast av_clear(ary), basically) */
298#define CLEAR_ARGARRAY(ary) \
299 STMT_START { \
300 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
f880fe2f 301 SvPV_set(ary, (char*)AvALLOC(ary)); \
8e09340b
GS
302 AvFILLp(ary) = -1; \
303 } STMT_END
7766f137 304
b0d9ce38
GS
305#define POPSUB(cx,sv) \
306 STMT_START { \
a8bba7fa 307 if (cx->blk_sub.hasargs) { \
7766f137 308 POP_SAVEARRAY(); \
d8b46c1b 309 /* abandon @_ if it got reified */ \
a8bba7fa
GS
310 if (AvREAL(cx->blk_sub.argarray)) { \
311 SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
312 SvREFCNT_dec(cx->blk_sub.argarray); \
313 cx->blk_sub.argarray = newAV(); \
314 av_extend(cx->blk_sub.argarray, fill); \
11ca45c0 315 AvREIFY_only(cx->blk_sub.argarray); \
dd2155a4 316 CX_CURPAD_SV(cx->blk_sub, 0) = (SV*)cx->blk_sub.argarray; \
d8b46c1b 317 } \
7766f137 318 else { \
8e09340b 319 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
7766f137 320 } \
79072805 321 } \
b0d9ce38
GS
322 sv = (SV*)cx->blk_sub.cv; \
323 if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \
a0714e2c 324 sv = NULL; \
b0d9ce38
GS
325 } STMT_END
326
327#define LEAVESUB(sv) \
328 STMT_START { \
329 if (sv) \
330 SvREFCNT_dec(sv); \
331 } STMT_END
79072805
LW
332
333#define POPFORMAT(cx) \
4633a7c4
LW
334 setdefout(cx->blk_sub.dfoutgv); \
335 SvREFCNT_dec(cx->blk_sub.dfoutgv);
79072805
LW
336
337/* eval context */
338struct block_eval {
339 I32 old_in_eval;
340 I32 old_op_type;
0f79a09d 341 SV * old_namesv;
79072805 342 OP * old_eval_root;
748a9306 343 SV * cur_text;
2090ab20 344 CV * cv;
f39bc417 345 OP * retop; /* op to execute on exit from eval */
abd70938 346 JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */
79072805
LW
347};
348
8990e307 349#define PUSHEVAL(cx,n,fgv) \
0f79a09d 350 STMT_START { \
3280af22 351 cx->blk_eval.old_in_eval = PL_in_eval; \
a8bba7fa 352 cx->blk_eval.old_op_type = PL_op->op_type; \
a0714e2c 353 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL); \
a8bba7fa 354 cx->blk_eval.old_eval_root = PL_eval_root; \
0f79a09d 355 cx->blk_eval.cur_text = PL_linestr; \
601f1833 356 cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */ \
5f66b61c 357 cx->blk_eval.retop = NULL; \
abd70938 358 cx->blk_eval.cur_top_env = PL_top_env; \
0f79a09d 359 } STMT_END
79072805
LW
360
361#define POPEVAL(cx) \
0f79a09d 362 STMT_START { \
3280af22 363 PL_in_eval = cx->blk_eval.old_in_eval; \
79072805 364 optype = cx->blk_eval.old_op_type; \
7766f137 365 PL_eval_root = cx->blk_eval.old_eval_root; \
0f79a09d
GS
366 if (cx->blk_eval.old_namesv) \
367 sv_2mortal(cx->blk_eval.old_namesv); \
368 } STMT_END
79072805
LW
369
370/* loop context */
371struct block_loop {
372 char * label;
373 I32 resetsp;
374 OP * redo_op;
375 OP * next_op;
376 OP * last_op;
7766f137
GS
377#ifdef USE_ITHREADS
378 void * iterdata;
f3548bdc 379 PAD *oldcomppad;
7766f137 380#else
79072805 381 SV ** itervar;
7766f137 382#endif
79072805 383 SV * itersave;
5f05dabc 384 SV * iterlval;
79072805 385 AV * iterary;
89ea2908
GA
386 IV iterix;
387 IV itermax;
79072805
LW
388};
389
7766f137
GS
390#ifdef USE_ITHREADS
391# define CxITERVAR(c) \
392 ((c)->blk_loop.iterdata \
393 ? (CxPADLOOP(cx) \
dd2155a4
DM
394 ? &CX_CURPAD_SV( (c)->blk_loop, \
395 INT2PTR(PADOFFSET, (c)->blk_loop.iterdata)) \
7766f137
GS
396 : &GvSV((GV*)(c)->blk_loop.iterdata)) \
397 : (SV**)NULL)
398# define CX_ITERDATA_SET(cx,idata) \
dd2155a4 399 CX_CURPAD_SAVE(cx->blk_loop); \
155aba94 400 if ((cx->blk_loop.iterdata = (idata))) \
d10edb75
KC
401 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \
402 else \
a0714e2c 403 cx->blk_loop.itersave = NULL;
7766f137
GS
404#else
405# define CxITERVAR(c) ((c)->blk_loop.itervar)
406# define CX_ITERDATA_SET(cx,ivar) \
155aba94 407 if ((cx->blk_loop.itervar = (SV**)(ivar))) \
d10edb75
KC
408 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \
409 else \
a0714e2c 410 cx->blk_loop.itersave = NULL;
7766f137
GS
411#endif
412
413#define PUSHLOOP(cx, dat, s) \
38a230cb
GS
414 cx->blk_loop.label = PL_curcop->cop_label; \
415 cx->blk_loop.resetsp = s - PL_stack_base; \
79072805
LW
416 cx->blk_loop.redo_op = cLOOP->op_redoop; \
417 cx->blk_loop.next_op = cLOOP->op_nextop; \
418 cx->blk_loop.last_op = cLOOP->op_lastop; \
a0714e2c 419 cx->blk_loop.iterlval = NULL; \
7d49f689 420 cx->blk_loop.iterary = NULL; \
7766f137
GS
421 cx->blk_loop.iterix = -1; \
422 CX_ITERDATA_SET(cx,dat);
79072805
LW
423
424#define POPLOOP(cx) \
a8bba7fa 425 SvREFCNT_dec(cx->blk_loop.iterlval); \
7766f137 426 if (CxITERVAR(cx)) { \
21401c75 427 if (SvPADMY(cx->blk_loop.itersave)) { \
d4c19fe8 428 SV ** const s_v_p = CxITERVAR(cx); \
21401c75
CH
429 sv_2mortal(*s_v_p); \
430 *s_v_p = cx->blk_loop.itersave; \
431 } \
432 else { \
433 SvREFCNT_dec(cx->blk_loop.itersave); \
434 } \
44a8e56a 435 } \
a8bba7fa
GS
436 if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
437 SvREFCNT_dec(cx->blk_loop.iterary);
79072805 438
0d863452
RH
439/* given/when context */
440struct block_givwhen {
441 OP *leave_op;
442};
443
444#define PUSHGIVEN(cx) \
445 cx->blk_givwhen.leave_op = cLOGOP->op_other;
446
447#define PUSHWHEN PUSHGIVEN
448
79072805
LW
449/* context common to subroutines, evals and loops */
450struct block {
451 I32 blku_oldsp; /* stack pointer to copy stuff down to */
452 COP * blku_oldcop; /* old curcop pointer */
79072805
LW
453 I32 blku_oldmarksp; /* mark stack index */
454 I32 blku_oldscopesp; /* scope stack index */
455 PMOP * blku_oldpm; /* values of pattern match vars */
456 U8 blku_gimme; /* is this block running in list context? */
457
458 union {
459 struct block_sub blku_sub;
460 struct block_eval blku_eval;
461 struct block_loop blku_loop;
0d863452 462 struct block_givwhen blku_givwhen;
79072805
LW
463 } blk_u;
464};
465#define blk_oldsp cx_u.cx_blk.blku_oldsp
466#define blk_oldcop cx_u.cx_blk.blku_oldcop
79072805
LW
467#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
468#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
469#define blk_oldpm cx_u.cx_blk.blku_oldpm
470#define blk_gimme cx_u.cx_blk.blku_gimme
471#define blk_sub cx_u.cx_blk.blk_u.blku_sub
472#define blk_eval cx_u.cx_blk.blk_u.blku_eval
473#define blk_loop cx_u.cx_blk.blk_u.blku_loop
0d863452 474#define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen
79072805
LW
475
476/* Enter a block. */
8990e307 477#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805 478 cx->cx_type = t, \
3280af22
NIS
479 cx->blk_oldsp = sp - PL_stack_base, \
480 cx->blk_oldcop = PL_curcop, \
1aff0e91 481 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22 482 cx->blk_oldscopesp = PL_scopestack_ix, \
3280af22 483 cx->blk_oldpm = PL_curpm, \
eb160463 484 cx->blk_gimme = (U8)gimme; \
bf49b057 485 DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
1aff0e91 486 (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
79072805
LW
487
488/* Exit a block (RETURN and LAST). */
a0d0e21e 489#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
1aff0e91 490 newsp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
491 PL_curcop = cx->blk_oldcop, \
492 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
493 PL_scopestack_ix = cx->blk_oldscopesp, \
3280af22
NIS
494 pm = cx->blk_oldpm, \
495 gimme = cx->blk_gimme; \
b4ab917c 496 DEBUG_SCOPE("POPBLOCK"); \
bf49b057 497 DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
22c35a8c 498 (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
79072805
LW
499
500/* Continue a block elsewhere (NEXT and REDO). */
3280af22 501#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
1aff0e91 502 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
503 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
504 PL_scopestack_ix = cx->blk_oldscopesp, \
b4ab917c
DM
505 PL_curpm = cx->blk_oldpm; \
506 DEBUG_SCOPE("TOPBLOCK");
79072805
LW
507
508/* substitution context */
509struct subst {
510 I32 sbu_iters;
511 I32 sbu_maxiters;
22e551b9 512 I32 sbu_rflags;
4633a7c4 513 I32 sbu_oldsave;
71be2cbc
PP
514 bool sbu_once;
515 bool sbu_rxtainted;
79072805
LW
516 char * sbu_orig;
517 SV * sbu_dstr;
518 SV * sbu_targ;
519 char * sbu_s;
520 char * sbu_m;
521 char * sbu_strend;
c90c0ff4 522 void * sbu_rxres;
c07a80fd 523 REGEXP * sbu_rx;
79072805
LW
524};
525#define sb_iters cx_u.cx_subst.sbu_iters
526#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9 527#define sb_rflags cx_u.cx_subst.sbu_rflags
4633a7c4 528#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc
PP
529#define sb_once cx_u.cx_subst.sbu_once
530#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805
LW
531#define sb_orig cx_u.cx_subst.sbu_orig
532#define sb_dstr cx_u.cx_subst.sbu_dstr
533#define sb_targ cx_u.cx_subst.sbu_targ
534#define sb_s cx_u.cx_subst.sbu_s
535#define sb_m cx_u.cx_subst.sbu_m
536#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4 537#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd 538#define sb_rx cx_u.cx_subst.sbu_rx
79072805
LW
539
540#define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
541 cx->sb_iters = iters, \
542 cx->sb_maxiters = maxiters, \
22e551b9 543 cx->sb_rflags = r_flags, \
4633a7c4 544 cx->sb_oldsave = oldsave, \
71be2cbc
PP
545 cx->sb_once = once, \
546 cx->sb_rxtainted = rxtainted, \
79072805
LW
547 cx->sb_orig = orig, \
548 cx->sb_dstr = dstr, \
549 cx->sb_targ = targ, \
550 cx->sb_s = s, \
551 cx->sb_m = m, \
552 cx->sb_strend = strend, \
4608196e 553 cx->sb_rxres = NULL, \
c07a80fd 554 cx->sb_rx = rx, \
c90c0ff4
PP
555 cx->cx_type = CXt_SUBST; \
556 rxres_save(&cx->sb_rxres, rx)
79072805 557
c90c0ff4
PP
558#define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
559 rxres_free(&cx->sb_rxres)
79072805
LW
560
561struct context {
6b35e009 562 U32 cx_type; /* what kind of context this is */
79072805
LW
563 union {
564 struct block cx_blk;
565 struct subst cx_subst;
566 } cx_u;
567};
6b35e009
GS
568
569#define CXTYPEMASK 0xff
79072805
LW
570#define CXt_NULL 0
571#define CXt_SUB 1
572#define CXt_EVAL 2
573#define CXt_LOOP 3
574#define CXt_SUBST 4
575#define CXt_BLOCK 5
7766f137 576#define CXt_FORMAT 6
0d863452
RH
577#define CXt_GIVEN 7
578#define CXt_WHEN 8
79072805 579
9850bf21
RH
580/* private flags for CXt_SUB and CXt_NULL */
581#define CXp_MULTICALL 0x00000400 /* part of a multicall (so don't
582 tear down context on exit). */
583
6b35e009
GS
584/* private flags for CXt_EVAL */
585#define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
1d76a5c3 586#define CXp_TRYBLOCK 0x00000200 /* eval{}, not eval'' or similar */
6b35e009 587
7766f137 588/* private flags for CXt_LOOP */
0d863452
RH
589#define CXp_FOREACH 0x00000200 /* a foreach loop */
590#define CXp_FOR_DEF 0x00000400 /* foreach using $_ */
591#ifdef USE_ITHREADS
7766f137
GS
592# define CXp_PADVAR 0x00000100 /* itervar lives on pad, iterdata
593 has pad offset; if not set,
594 iterdata holds GV* */
595# define CxPADLOOP(c) (((c)->cx_type & (CXt_LOOP|CXp_PADVAR)) \
596 == (CXt_LOOP|CXp_PADVAR))
597#endif
598
6b35e009 599#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
9850bf21
RH
600#define CxMULTICALL(c) (((c)->cx_type & CXp_MULTICALL) \
601 == CXp_MULTICALL)
7766f137
GS
602#define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL|CXp_REAL)) \
603 == (CXt_EVAL|CXp_REAL))
1d76a5c3
GS
604#define CxTRYBLOCK(c) (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK)) \
605 == (CXt_EVAL|CXp_TRYBLOCK))
0d863452
RH
606#define CxFOREACH(c) (((c)->cx_type & (CXt_LOOP|CXp_FOREACH)) \
607 == (CXt_LOOP|CXp_FOREACH))
608#define CxFOREACHDEF(c) (((c)->cx_type & (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))\
609 == (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))
6b35e009 610
79072805
LW
611#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
612
ccfc67b7
JH
613/*
614=head1 "Gimme" Values
615*/
954c1994
GS
616
617/*
618=for apidoc AmU||G_SCALAR
619Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
620L<perlcall>.
621
622=for apidoc AmU||G_ARRAY
91e74348 623Used to indicate list context. See C<GIMME_V>, C<GIMME> and
954c1994
GS
624L<perlcall>.
625
626=for apidoc AmU||G_VOID
627Used to indicate void context. See C<GIMME_V> and L<perlcall>.
628
629=for apidoc AmU||G_DISCARD
630Indicates that arguments returned from a callback should be discarded. See
631L<perlcall>.
632
633=for apidoc AmU||G_EVAL
634
635Used to force a Perl C<eval> wrapper around a callback. See
636L<perlcall>.
637
638=for apidoc AmU||G_NOARGS
639
640Indicates that no arguments are being sent to a callback. See
641L<perlcall>.
642
643=cut
644*/
645
a0d0e21e
LW
646#define G_SCALAR 0
647#define G_ARRAY 1
54310121 648#define G_VOID 128 /* skip this bit when adding flags below */
79072805 649
864dbfa3 650/* extra flags for Perl_call_* routines */
a0d0e21e
LW
651#define G_DISCARD 2 /* Call FREETMPS. */
652#define G_EVAL 4 /* Assume eval {} around subroutine call. */
653#define G_NOARGS 8 /* Don't construct a @_ array. */
54310121 654#define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
491527d0 655#define G_NODEBUG 32 /* Disable debugging at toplevel. */
968b3946 656#define G_METHOD 64 /* Calling method. */
edb2152a
NC
657#define G_FAKINGEVAL 256 /* Faking en eval context for call_sv or
658 fold_constants. */
e336de0d 659
faef0170
HS
660/* flag bits for PL_in_eval */
661#define EVAL_NULL 0 /* not in an eval */
662#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
663#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3 664#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
6dc8a9e4 665#define EVAL_INREQUIRE 8 /* The code is being required. */
faef0170 666
e336de0d
GS
667/* Support for switching (stack and block) contexts.
668 * This ensures magic doesn't invalidate local stack and cx pointers.
669 */
670
e788e7d3
GS
671#define PERLSI_UNKNOWN -1
672#define PERLSI_UNDEF 0
673#define PERLSI_MAIN 1
674#define PERLSI_MAGIC 2
675#define PERLSI_SORT 3
676#define PERLSI_SIGNAL 4
677#define PERLSI_OVERLOAD 5
678#define PERLSI_DESTROY 6
679#define PERLSI_WARNHOOK 7
680#define PERLSI_DIEHOOK 8
681#define PERLSI_REQUIRE 9
e336de0d
GS
682
683struct stackinfo {
684 AV * si_stack; /* stack for current runlevel */
685 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
686 I32 si_cxix; /* current context index */
687 I32 si_cxmax; /* maximum allocated index */
688 I32 si_type; /* type of runlevel */
689 struct stackinfo * si_prev;
690 struct stackinfo * si_next;
ce2f7c3b 691 I32 si_markoff; /* offset where markstack begins for us.
e336de0d
GS
692 * currently used only with DEBUGGING,
693 * but not #ifdef-ed for bincompat */
694};
695
696typedef struct stackinfo PERL_SI;
697
3280af22
NIS
698#define cxstack (PL_curstackinfo->si_cxstack)
699#define cxstack_ix (PL_curstackinfo->si_cxix)
700#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d
GS
701
702#ifdef DEBUGGING
ce2f7c3b
GS
703# define SET_MARK_OFFSET \
704 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
e336de0d 705#else
ce2f7c3b 706# define SET_MARK_OFFSET NOOP
e336de0d
GS
707#endif
708
d3acc0f7 709#define PUSHSTACKi(type) \
e336de0d 710 STMT_START { \
3280af22 711 PERL_SI *next = PL_curstackinfo->si_next; \
e336de0d
GS
712 if (!next) { \
713 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22
NIS
714 next->si_prev = PL_curstackinfo; \
715 PL_curstackinfo->si_next = next; \
e336de0d
GS
716 } \
717 next->si_type = type; \
718 next->si_cxix = -1; \
719 AvFILLp(next->si_stack) = 0; \
3280af22
NIS
720 SWITCHSTACK(PL_curstack,next->si_stack); \
721 PL_curstackinfo = next; \
ce2f7c3b 722 SET_MARK_OFFSET; \
e336de0d
GS
723 } STMT_END
724
e788e7d3 725#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7 726
3095d977
GS
727/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
728 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7 729#define POPSTACK \
e336de0d 730 STMT_START { \
39644a26 731 dSP; \
c4420975 732 PERL_SI * const prev = PL_curstackinfo->si_prev; \
e336de0d 733 if (!prev) { \
bf49b057 734 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
e336de0d
GS
735 my_exit(1); \
736 } \
3280af22 737 SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d 738 /* don't free prev here, free them all at the END{} */ \
3280af22 739 PL_curstackinfo = prev; \
e336de0d
GS
740 } STMT_END
741
742#define POPSTACK_TO(s) \
743 STMT_START { \
3280af22 744 while (PL_curstack != s) { \
bac4b2ad 745 dounwind(-1); \
d3acc0f7 746 POPSTACK; \
bac4b2ad 747 } \
e336de0d 748 } STMT_END
923e4eb5
JH
749
750#define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
751#define IN_PERL_RUNTIME (PL_curcop != &PL_compiling)
752
9850bf21
RH
753/*
754=head1 Multicall Functions
755
756=for apidoc Ams||dMULTICALL
757Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
758
759=for apidoc Ams||PUSH_MULTICALL
760Opening bracket for a lightweight callback.
761See L<perlcall/Lightweight Callbacks>.
762
763=for apidoc Ams||MULTICALL
764Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
765
766=for apidoc Ams||POP_MULTICALL
767Closing bracket for a lightweight callback.
768See L<perlcall/Lightweight Callbacks>.
769
770=cut
771*/
772
773#define dMULTICALL \
774 SV **newsp; /* set by POPBLOCK */ \
775 PERL_CONTEXT *cx; \
82f35e8b 776 CV *multicall_cv; \
9850bf21
RH
777 OP *multicall_cop; \
778 bool multicall_oldcatch; \
779 U8 hasargs = 0 /* used by PUSHSUB */
780
82f35e8b 781#define PUSH_MULTICALL(the_cv) \
9850bf21 782 STMT_START { \
0bcc34c2
AL
783 CV * const _nOnclAshIngNamE_ = the_cv; \
784 CV * const cv = _nOnclAshIngNamE_; \
785 AV * const padlist = CvPADLIST(cv); \
9850bf21
RH
786 ENTER; \
787 multicall_oldcatch = CATCH_GET; \
788 SAVETMPS; SAVEVPTR(PL_op); \
789 CATCH_SET(TRUE); \
790 PUSHBLOCK(cx, CXt_SUB|CXp_MULTICALL, PL_stack_sp); \
791 PUSHSUB(cx); \
792 if (++CvDEPTH(cv) >= 2) { \
793 PERL_STACK_OVERFLOW_CHECK(); \
794 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
795 } \
796 SAVECOMPPAD(); \
797 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
82f35e8b 798 multicall_cv = cv; \
9850bf21
RH
799 multicall_cop = CvSTART(cv); \
800 } STMT_END
801
802#define MULTICALL \
803 STMT_START { \
804 PL_op = multicall_cop; \
805 CALLRUNOPS(aTHX); \
806 } STMT_END
807
808#define POP_MULTICALL \
809 STMT_START { \
82f35e8b
RH
810 LEAVESUB(multicall_cv); \
811 CvDEPTH(multicall_cv)--; \
9850bf21
RH
812 POPBLOCK(cx,PL_curpm); \
813 CATCH_SET(multicall_oldcatch); \
814 LEAVE; \
815 } STMT_END
b3ca2e83
NC
816
817/*
818 * Local variables:
819 * c-indentation-style: bsd
820 * c-basic-offset: 4
821 * indent-tabs-mode: t
822 * End:
823 *
824 * ex: set ts=8 sts=4 sw=4 noet:
825 */