This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
move Perl_ck_warner() before unwind [perl #113794]
[perl5.git] / cop.h
CommitLineData
a0d0e21e 1/* cop.h
79072805 2 *
1129b882 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
8622e0e2 4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 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 *
8622e0e2
RU
9 * Control ops (cops) are one of the two ops OP_NEXTSTATE and OP_DBSTATE,
10 * that (loosely speaking) are separate statements.
3ffa1527
JH
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 16/* A jmpenv packages the state required to perform a proper non-local jump.
1c98cc53
DM
17 * Note that there is a PL_start_env initialized when perl starts, and
18 * PL_top_env points to this initially, so PL_top_env should always be
19 * non-null.
0d2925a6 20 *
1c98cc53
DM
21 * Existence of a non-null PL_top_env->je_prev implies it is valid to call
22 * longjmp() at that runlevel (we make sure PL_start_env.je_prev is always
0d2925a6
DM
23 * null to ensure this).
24 *
25 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
26 * establish a local jmpenv to handle exception traps. Care must be taken
27 * to restore the previous value of je_mustcatch before exiting the
28 * stack frame iff JMPENV_PUSH was not called in that stack frame.
29 * GSAR 97-03-27
30 */
31
32struct jmpenv {
33 struct jmpenv * je_prev;
34 Sigjmp_buf je_buf; /* only for use if !je_throw */
35 int je_ret; /* last exception thrown */
36 bool je_mustcatch; /* need to call longjmp()? */
37};
38
39typedef struct jmpenv JMPENV;
40
41#ifdef OP_IN_REGISTER
42#define OP_REG_TO_MEM PL_opsave = op
43#define OP_MEM_TO_REG op = PL_opsave
44#else
45#define OP_REG_TO_MEM NOOP
46#define OP_MEM_TO_REG NOOP
47#endif
48
49/*
50 * How to build the first jmpenv.
51 *
52 * top_env needs to be non-zero. It points to an area
53 * in which longjmp() stuff is stored, as C callstack
54 * info there at least is thread specific this has to
55 * be per-thread. Otherwise a 'die' in a thread gives
56 * that thread the C stack of last thread to do an eval {}!
57 */
58
59#define JMPENV_BOOTSTRAP \
60 STMT_START { \
61 Zero(&PL_start_env, 1, JMPENV); \
62 PL_start_env.je_ret = -1; \
63 PL_start_env.je_mustcatch = TRUE; \
64 PL_top_env = &PL_start_env; \
65 } STMT_END
66
67/*
68 * PERL_FLEXIBLE_EXCEPTIONS
69 *
70 * All the flexible exceptions code has been removed.
71 * See the following threads for details:
72 *
73 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2004-07/msg00378.html
74 *
75 * Joshua's original patches (which weren't applied) and discussion:
76 *
77 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01396.html
78 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01489.html
79 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01491.html
80 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01608.html
81 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02144.html
82 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02998.html
83 *
84 * Chip's reworked patch and discussion:
85 *
86 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html
87 *
88 * The flaw in these patches (which went unnoticed at the time) was
89 * that they moved some code that could potentially die() out of the
90 * region protected by the setjmp()s. This caused exceptions within
91 * END blocks and such to not be handled by the correct setjmp().
92 *
93 * The original patches that introduces flexible exceptions were:
94 *
ff7e9008
MS
95 * http://perl5.git.perl.org/perl.git/commit/312caa8e97f1c7ee342a9895c2f0e749625b4929
96 * http://perl5.git.perl.org/perl.git/commit/14dd3ad8c9bf82cf09798a22cc89a9862dfd6d1a
97 *
0d2925a6
DM
98 */
99
100#define dJMPENV JMPENV cur_env
101
102#define JMPENV_PUSH(v) \
103 STMT_START { \
1c98cc53
DM
104 DEBUG_l({ \
105 int i = 0; JMPENV *p = PL_top_env; \
106 while (p) { i++; p = p->je_prev; } \
91e35ba1
DM
107 Perl_deb(aTHX_ "JUMPENV_PUSH level=%d at %s:%d\n", \
108 i, __FILE__, __LINE__);}) \
0d2925a6
DM
109 cur_env.je_prev = PL_top_env; \
110 OP_REG_TO_MEM; \
111 cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK); \
112 OP_MEM_TO_REG; \
113 PL_top_env = &cur_env; \
114 cur_env.je_mustcatch = FALSE; \
115 (v) = cur_env.je_ret; \
116 } STMT_END
117
118#define JMPENV_POP \
119 STMT_START { \
1c98cc53
DM
120 DEBUG_l({ \
121 int i = -1; JMPENV *p = PL_top_env; \
122 while (p) { i++; p = p->je_prev; } \
91e35ba1
DM
123 Perl_deb(aTHX_ "JUMPENV_POP level=%d at %s:%d\n", \
124 i, __FILE__, __LINE__);}) \
d3ab86be 125 assert(PL_top_env == &cur_env); \
0d2925a6
DM
126 PL_top_env = cur_env.je_prev; \
127 } STMT_END
128
129#define JMPENV_JUMP(v) \
130 STMT_START { \
1c98cc53
DM
131 DEBUG_l({ \
132 int i = -1; JMPENV *p = PL_top_env; \
133 while (p) { i++; p = p->je_prev; } \
91e35ba1
DM
134 Perl_deb(aTHX_ "JUMPENV_JUMP(%d) level=%d at %s:%d\n", \
135 (int)v, i, __FILE__, __LINE__);}) \
0d2925a6
DM
136 OP_REG_TO_MEM; \
137 if (PL_top_env->je_prev) \
138 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
139 if ((v) == 2) \
37038d91 140 PerlProc_exit(STATUS_EXIT); \
5637ef5b 141 PerlIO_printf(PerlIO_stderr(), "panic: top_env, v=%d\n", (int)v); \
0d2925a6
DM
142 PerlProc_exit(1); \
143 } STMT_END
144
145#define CATCH_GET (PL_top_env->je_mustcatch)
1c98cc53
DM
146#define CATCH_SET(v) \
147 STMT_START { \
148 DEBUG_l( \
149 Perl_deb(aTHX_ \
150 "JUMPLEVEL set catch %d => %d (for %p) at %s:%d\n", \
151 PL_top_env->je_mustcatch, v, (void*)PL_top_env, \
152 __FILE__, __LINE__);) \
153 PL_top_env->je_mustcatch = (v); \
154 } STMT_END
0d2925a6 155
20439bc7
Z
156/*
157=head1 COP Hint Hashes
158*/
159
160typedef struct refcounted_he COPHH;
161
162#define COPHH_KEY_UTF8 REFCOUNTED_HE_KEY_UTF8
163
164/*
ffd08bbf 165=for apidoc Amx|SV *|cophh_fetch_pvn|const COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|U32 flags
20439bc7
Z
166
167Look up the entry in the cop hints hash I<cophh> with the key specified by
168I<keypv> and I<keylen>. If I<flags> has the C<COPHH_KEY_UTF8> bit set,
169the key octets are interpreted as UTF-8, otherwise they are interpreted
170as Latin-1. I<hash> is a precomputed hash of the key string, or zero if
171it has not been precomputed. Returns a mortal scalar copy of the value
172associated with the key, or C<&PL_sv_placeholder> if there is no value
173associated with the key.
174
175=cut
176*/
177
178#define cophh_fetch_pvn(cophh, keypv, keylen, hash, flags) \
179 Perl_refcounted_he_fetch_pvn(aTHX_ cophh, keypv, keylen, hash, flags)
180
181/*
ffd08bbf 182=for apidoc Amx|SV *|cophh_fetch_pvs|const COPHH *cophh|const char *key|U32 flags
20439bc7
Z
183
184Like L</cophh_fetch_pvn>, but takes a literal string instead of a
185string/length pair, and no precomputed hash.
186
187=cut
188*/
189
190#define cophh_fetch_pvs(cophh, key, flags) \
191 Perl_refcounted_he_fetch_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, flags)
192
193/*
ffd08bbf 194=for apidoc Amx|SV *|cophh_fetch_pv|const COPHH *cophh|const char *key|U32 hash|U32 flags
20439bc7
Z
195
196Like L</cophh_fetch_pvn>, but takes a nul-terminated string instead of
197a string/length pair.
198
199=cut
200*/
201
202#define cophh_fetch_pv(cophh, key, hash, flags) \
203 Perl_refcounted_he_fetch_pv(aTHX_ cophh, key, hash, flags)
204
205/*
ffd08bbf 206=for apidoc Amx|SV *|cophh_fetch_sv|const COPHH *cophh|SV *key|U32 hash|U32 flags
20439bc7
Z
207
208Like L</cophh_fetch_pvn>, but takes a Perl scalar instead of a
209string/length pair.
210
211=cut
212*/
213
214#define cophh_fetch_sv(cophh, key, hash, flags) \
215 Perl_refcounted_he_fetch_sv(aTHX_ cophh, key, hash, flags)
216
217/*
ffd08bbf 218=for apidoc Amx|HV *|cophh_2hv|const COPHH *cophh|U32 flags
20439bc7
Z
219
220Generates and returns a standard Perl hash representing the full set of
221key/value pairs in the cop hints hash I<cophh>. I<flags> is currently
222unused and must be zero.
223
224=cut
225*/
226
227#define cophh_2hv(cophh, flags) \
228 Perl_refcounted_he_chain_2hv(aTHX_ cophh, flags)
229
230/*
ffd08bbf 231=for apidoc Amx|COPHH *|cophh_copy|COPHH *cophh
20439bc7
Z
232
233Make and return a complete copy of the cop hints hash I<cophh>.
234
235=cut
236*/
237
238#define cophh_copy(cophh) Perl_refcounted_he_inc(aTHX_ cophh)
239
240/*
ffd08bbf 241=for apidoc Amx|void|cophh_free|COPHH *cophh
20439bc7
Z
242
243Discard the cop hints hash I<cophh>, freeing all resources associated
244with it.
245
246=cut
247*/
248
249#define cophh_free(cophh) Perl_refcounted_he_free(aTHX_ cophh)
250
251/*
ffd08bbf 252=for apidoc Amx|COPHH *|cophh_new_empty
20439bc7
Z
253
254Generate and return a fresh cop hints hash containing no entries.
255
256=cut
257*/
258
259#define cophh_new_empty() ((COPHH *)NULL)
260
261/*
ffd08bbf 262=for apidoc Amx|COPHH *|cophh_store_pvn|COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|SV *value|U32 flags
20439bc7
Z
263
264Stores a value, associated with a key, in the cop hints hash I<cophh>,
265and returns the modified hash. The returned hash pointer is in general
266not the same as the hash pointer that was passed in. The input hash is
267consumed by the function, and the pointer to it must not be subsequently
268used. Use L</cophh_copy> if you need both hashes.
269
270The key is specified by I<keypv> and I<keylen>. If I<flags> has the
271C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8,
272otherwise they are interpreted as Latin-1. I<hash> is a precomputed
273hash of the key string, or zero if it has not been precomputed.
274
275I<value> is the scalar value to store for this key. I<value> is copied
276by this function, which thus does not take ownership of any reference
277to it, and later changes to the scalar will not be reflected in the
278value visible in the cop hints hash. Complex types of scalar will not
279be stored with referential integrity, but will be coerced to strings.
280
281=cut
282*/
283
284#define cophh_store_pvn(cophh, keypv, keylen, hash, value, flags) \
285 Perl_refcounted_he_new_pvn(aTHX_ cophh, keypv, keylen, hash, value, flags)
286
287/*
ffd08bbf 288=for apidoc Amx|COPHH *|cophh_store_pvs|const COPHH *cophh|const char *key|SV *value|U32 flags
20439bc7
Z
289
290Like L</cophh_store_pvn>, but takes a literal string instead of a
291string/length pair, and no precomputed hash.
292
293=cut
294*/
295
296#define cophh_store_pvs(cophh, key, value, flags) \
297 Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, value, flags)
298
299/*
ffd08bbf 300=for apidoc Amx|COPHH *|cophh_store_pv|const COPHH *cophh|const char *key|U32 hash|SV *value|U32 flags
20439bc7
Z
301
302Like L</cophh_store_pvn>, but takes a nul-terminated string instead of
303a string/length pair.
304
305=cut
306*/
307
308#define cophh_store_pv(cophh, key, hash, value, flags) \
309 Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, value, flags)
310
311/*
ffd08bbf 312=for apidoc Amx|COPHH *|cophh_store_sv|const COPHH *cophh|SV *key|U32 hash|SV *value|U32 flags
20439bc7
Z
313
314Like L</cophh_store_pvn>, but takes a Perl scalar instead of a
315string/length pair.
316
317=cut
318*/
319
320#define cophh_store_sv(cophh, key, hash, value, flags) \
321 Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, value, flags)
322
323/*
ffd08bbf 324=for apidoc Amx|COPHH *|cophh_delete_pvn|COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|U32 flags
20439bc7
Z
325
326Delete a key and its associated value from the cop hints hash I<cophh>,
327and returns the modified hash. The returned hash pointer is in general
328not the same as the hash pointer that was passed in. The input hash is
329consumed by the function, and the pointer to it must not be subsequently
330used. Use L</cophh_copy> if you need both hashes.
331
332The key is specified by I<keypv> and I<keylen>. If I<flags> has the
333C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8,
334otherwise they are interpreted as Latin-1. I<hash> is a precomputed
335hash of the key string, or zero if it has not been precomputed.
336
337=cut
338*/
339
340#define cophh_delete_pvn(cophh, keypv, keylen, hash, flags) \
341 Perl_refcounted_he_new_pvn(aTHX_ cophh, keypv, keylen, hash, \
342 (SV *)NULL, flags)
343
344/*
ffd08bbf 345=for apidoc Amx|COPHH *|cophh_delete_pvs|const COPHH *cophh|const char *key|U32 flags
20439bc7
Z
346
347Like L</cophh_delete_pvn>, but takes a literal string instead of a
348string/length pair, and no precomputed hash.
349
350=cut
351*/
352
353#define cophh_delete_pvs(cophh, key, flags) \
354 Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, \
355 (SV *)NULL, flags)
356
357/*
ffd08bbf 358=for apidoc Amx|COPHH *|cophh_delete_pv|const COPHH *cophh|const char *key|U32 hash|U32 flags
20439bc7
Z
359
360Like L</cophh_delete_pvn>, but takes a nul-terminated string instead of
361a string/length pair.
362
363=cut
364*/
365
366#define cophh_delete_pv(cophh, key, hash, flags) \
367 Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, (SV *)NULL, flags)
368
369/*
ffd08bbf 370=for apidoc Amx|COPHH *|cophh_delete_sv|const COPHH *cophh|SV *key|U32 hash|U32 flags
20439bc7
Z
371
372Like L</cophh_delete_pvn>, but takes a Perl scalar instead of a
373string/length pair.
374
375=cut
376*/
377
378#define cophh_delete_sv(cophh, key, hash, flags) \
379 Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, (SV *)NULL, flags)
0d2925a6 380
5ac1e9b2 381#include "mydtrace.h"
0d2925a6 382
79072805
LW
383struct cop {
384 BASEOP
d7f23a06
NC
385 /* On LP64 putting this here takes advantage of the fact that BASEOP isn't
386 an exact multiple of 8 bytes to save structure padding. */
387 line_t cop_line; /* line # of this command */
dca6062a 388 /* label for this construct is now stored in cop_hints_hash */
57843af0 389#ifdef USE_ITHREADS
dc5c17b5
FC
390 PADOFFSET cop_stashoff; /* offset into PL_stashpad, for the
391 package the line was compiled in */
57843af0
GS
392 char * cop_file; /* file name the following line # is from */
393#else
11faa288 394 HV * cop_stash; /* package line was compiled in */
79072805 395 GV * cop_filegv; /* file the following line # is from */
57843af0 396#endif
d5ec2987 397 U32 cop_hints; /* hints bits from pragmata */
a0d0e21e 398 U32 cop_seq; /* parse sequence number */
72dc9ed5
NC
399 /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *: */
400 STRLEN * cop_warnings; /* lexical warnings bitmask */
b3ca2e83
NC
401 /* compile time state of %^H. See the comment in op.c for how this is
402 used to recreate a hash to return from caller. */
20439bc7 403 COPHH * cop_hints_hash;
79072805
LW
404};
405
57843af0
GS
406#ifdef USE_ITHREADS
407# define CopFILE(c) ((c)->cop_file)
408# define CopFILEGV(c) (CopFILE(c) \
a0714e2c 409 ? gv_fetchfile(CopFILE(c)) : NULL)
083fcd59 410
7e4e8c89
NC
411# ifdef NETWARE
412# define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
d9095cec 413# define CopFILE_setn(c,pv,l) ((c)->cop_file = savepv((pv),(l)))
7e4e8c89
NC
414# else
415# define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
d9095cec 416# define CopFILE_setn(c,pv,l) ((c)->cop_file = savesharedpvn((pv),(l)))
7e4e8c89 417# endif
083fcd59 418
57843af0 419# define CopFILESV(c) (CopFILE(c) \
a0714e2c 420 ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
57843af0 421# define CopFILEAV(c) (CopFILE(c) \
7d49f689 422 ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
c7724415 423# define CopFILEAVx(c) (assert_(CopFILE(c)) \
36c7798d 424 GvAV(gv_fetchfile(CopFILE(c))))
083fcd59 425
d4d03940
FC
426# define CopSTASH(c) PL_stashpad[(c)->cop_stashoff]
427# define CopSTASH_set(c,hv) ((c)->cop_stashoff = (hv) \
428 ? alloccopstash(hv) \
429 : 0)
7e4e8c89 430# ifdef NETWARE
7e4e8c89
NC
431# define CopFILE_free(c) SAVECOPFILE_FREE(c)
432# else
bd61b366 433# define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
7e4e8c89 434# endif
57843af0
GS
435#else
436# define CopFILEGV(c) ((c)->cop_filegv)
f4dd75d9
GS
437# define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
438# define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
d9095cec 439# define CopFILE_setn(c,pv,l) CopFILEGV_set((c), gv_fetchfile_flags((pv),(l),0))
a0714e2c 440# define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
7d49f689 441# define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
8688788e
SH
442# ifdef DEBUGGING
443# define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
444# else
445# define CopFILEAVx(c) (GvAV(CopFILEGV(c)))
446# endif
be46dfad
RGS
447# define CopFILE(c) (CopFILEGV(c) && GvSV(CopFILEGV(c)) \
448 ? SvPVX(GvSV(CopFILEGV(c))) : NULL)
57843af0 449# define CopSTASH(c) ((c)->cop_stash)
f4dd75d9 450# define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
a0714e2c 451# define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
05ec9bb3 452
57843af0 453#endif /* USE_ITHREADS */
20439bc7 454
d4d03940
FC
455#define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
456 /* cop_stash is not refcounted */
457#define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
458#define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
d4d03940 459
20439bc7
Z
460#define CopHINTHASH_get(c) ((COPHH*)((c)->cop_hints_hash))
461#define CopHINTHASH_set(c,h) ((c)->cop_hints_hash = (h))
462
463/*
464=head1 COP Hint Reading
465*/
466
467/*
468=for apidoc Am|SV *|cop_hints_fetch_pvn|const COP *cop|const char *keypv|STRLEN keylen|U32 hash|U32 flags
469
470Look up the hint entry in the cop I<cop> with the key specified by
471I<keypv> and I<keylen>. If I<flags> has the C<COPHH_KEY_UTF8> bit set,
472the key octets are interpreted as UTF-8, otherwise they are interpreted
473as Latin-1. I<hash> is a precomputed hash of the key string, or zero if
474it has not been precomputed. Returns a mortal scalar copy of the value
475associated with the key, or C<&PL_sv_placeholder> if there is no value
476associated with the key.
477
478=cut
479*/
480
481#define cop_hints_fetch_pvn(cop, keypv, keylen, hash, flags) \
482 cophh_fetch_pvn(CopHINTHASH_get(cop), keypv, keylen, hash, flags)
483
484/*
485=for apidoc Am|SV *|cop_hints_fetch_pvs|const COP *cop|const char *key|U32 flags
486
487Like L</cop_hints_fetch_pvn>, but takes a literal string instead of a
488string/length pair, and no precomputed hash.
489
490=cut
491*/
492
493#define cop_hints_fetch_pvs(cop, key, flags) \
494 cophh_fetch_pvs(CopHINTHASH_get(cop), key, flags)
495
496/*
497=for apidoc Am|SV *|cop_hints_fetch_pv|const COP *cop|const char *key|U32 hash|U32 flags
498
499Like L</cop_hints_fetch_pvn>, but takes a nul-terminated string instead
500of a string/length pair.
501
502=cut
503*/
504
505#define cop_hints_fetch_pv(cop, key, hash, flags) \
506 cophh_fetch_pv(CopHINTHASH_get(cop), key, hash, flags)
507
508/*
509=for apidoc Am|SV *|cop_hints_fetch_sv|const COP *cop|SV *key|U32 hash|U32 flags
510
511Like L</cop_hints_fetch_pvn>, but takes a Perl scalar instead of a
512string/length pair.
513
514=cut
515*/
516
517#define cop_hints_fetch_sv(cop, key, hash, flags) \
518 cophh_fetch_sv(CopHINTHASH_get(cop), key, hash, flags)
519
520/*
521=for apidoc Am|HV *|cop_hints_2hv|const COP *cop|U32 flags
522
523Generates and returns a standard Perl hash representing the full set of
524hint entries in the cop I<cop>. I<flags> is currently unused and must
525be zero.
526
527=cut
528*/
529
530#define cop_hints_2hv(cop, flags) \
531 cophh_2hv(CopHINTHASH_get(cop), flags)
532
aebc0cbe 533#define CopLABEL(c) Perl_cop_fetch_label(aTHX_ (c), NULL, NULL)
5db1eb8d
BF
534#define CopLABEL_len(c,len) Perl_cop_fetch_label(aTHX_ (c), len, NULL)
535#define CopLABEL_len_flags(c,len,flags) Perl_cop_fetch_label(aTHX_ (c), len, flags)
dca6062a 536#define CopLABEL_alloc(pv) ((pv)?savepv(pv):NULL)
57843af0 537
ed094faf 538#define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
cc49e20b 539#define CopLINE(c) ((c)->cop_line)
57843af0
GS
540#define CopLINE_inc(c) (++CopLINE(c))
541#define CopLINE_dec(c) (--CopLINE(c))
542#define CopLINE_set(c,l) (CopLINE(c) = (l))
cc49e20b 543
248c2a4d 544/* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
e37778c2 545#define OutCopFILE(c) CopFILE(c)
248c2a4d 546
d5ec2987 547#define CopHINTS_get(c) ((c)->cop_hints + 0)
623e6609 548#define CopHINTS_set(c, h) STMT_START { \
d5ec2987 549 (c)->cop_hints = (h); \
623e6609
NC
550 } STMT_END
551
79072805
LW
552/*
553 * Here we have some enormously heavy (or at least ponderous) wizardry.
554 */
555
556/* subroutine context */
557struct block_sub {
f9c764c5 558 OP * retop; /* op to execute on exit from sub */
8e663997
NC
559 /* Above here is the same for sub, format and eval. */
560 CV * cv;
f9c764c5 561 /* Above here is the same for sub and format. */
79072805
LW
562 AV * savearray;
563 AV * argarray;
bb172083 564 I32 olddepth;
f3548bdc 565 PAD *oldcomppad;
f9c764c5
NC
566};
567
568
569/* format context */
570struct block_format {
f39bc417 571 OP * retop; /* op to execute on exit from sub */
8e663997
NC
572 /* Above here is the same for sub, format and eval. */
573 CV * cv;
f9c764c5
NC
574 /* Above here is the same for sub and format. */
575 GV * gv;
576 GV * dfoutgv;
79072805
LW
577};
578
b36bdeca
DM
579/* base for the next two macros. Don't use directly.
580 * Note that the refcnt of the cv is incremented twice; The CX one is
581 * decremented by LEAVESUB, the other by LEAVE. */
582
ee98a1d6 583#define PUSHSUB_BASE(cx) \
5ac1e9b2 584 ENTRY_PROBE(GvENAME(CvGV(cv)), \
c6903450 585 CopFILE((const COP *)CvSTART(cv)), \
3e2413e5
DL
586 CopLINE((const COP *)CvSTART(cv)), \
587 CopSTASHPV((const COP *)CvSTART(cv))); \
5ac1e9b2 588 \
79072805 589 cx->blk_sub.cv = cv; \
b8f55b69 590 cx->blk_sub.olddepth = CvDEPTH(cv); \
ae423868 591 cx->cx_type |= (hasargs) ? CXp_HASARGS : 0; \
5f66b61c 592 cx->blk_sub.retop = NULL; \
b36bdeca 593 if (!CvDEPTH(cv)) { \
74c765eb
AL
594 SvREFCNT_inc_simple_void_NN(cv); \
595 SvREFCNT_inc_simple_void_NN(cv); \
b36bdeca
DM
596 SAVEFREESV(cv); \
597 }
598
ee98a1d6
DM
599
600#define PUSHSUB(cx) \
777d9014
FC
601 { \
602 /* If the context is indeterminate, then only the lvalue */ \
603 /* flags that the caller also has are applicable. */ \
604 U8 phlags = \
605 (PL_op->op_flags & OPf_WANT) \
606 ? OPpENTERSUB_LVAL_MASK \
607 : !(PL_op->op_private & OPpENTERSUB_LVAL_MASK) \
8f939fab 608 ? 0 : (U8)Perl_was_lvalue_sub(aTHX); \
ee98a1d6 609 PUSHSUB_BASE(cx) \
446d0787 610 cx->blk_u16 = PL_op->op_private & \
0e9700df 611 (phlags|OPpDEREF); \
777d9014 612 }
79072805 613
ee98a1d6
DM
614/* variant for use by OP_DBSTATE, where op_private holds hint bits */
615#define PUSHSUB_DB(cx) \
616 PUSHSUB_BASE(cx) \
446d0787 617 cx->blk_u16 = 0;
ee98a1d6
DM
618
619
10067d9a 620#define PUSHFORMAT(cx, retop) \
f9c764c5
NC
621 cx->blk_format.cv = cv; \
622 cx->blk_format.gv = gv; \
623 cx->blk_format.retop = (retop); \
f9c764c5 624 cx->blk_format.dfoutgv = PL_defoutgv; \
ee23553f 625 if (!CvDEPTH(cv)) SvREFCNT_inc_simple_void_NN(cv); \
f32c7e86 626 CvDEPTH(cv)++; \
f9c764c5 627 SvREFCNT_inc_void(cx->blk_format.dfoutgv)
79072805 628
3db8f154 629#define POP_SAVEARRAY() \
6d4ff0d2 630 STMT_START { \
3280af22 631 SvREFCNT_dec(GvAV(PL_defgv)); \
a8bba7fa 632 GvAV(PL_defgv) = cx->blk_sub.savearray; \
6d4ff0d2 633 } STMT_END
6d4ff0d2 634
ecf8e9dd 635/* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
8e09340b
GS
636 * leave any (a fast av_clear(ary), basically) */
637#define CLEAR_ARGARRAY(ary) \
638 STMT_START { \
639 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
9c6bc640 640 AvARRAY(ary) = AvALLOC(ary); \
8e09340b
GS
641 AvFILLp(ary) = -1; \
642 } STMT_END
7766f137 643
b0d9ce38
GS
644#define POPSUB(cx,sv) \
645 STMT_START { \
8f629a87
NC
646 RETURN_PROBE(GvENAME(CvGV((const CV*)cx->blk_sub.cv)), \
647 CopFILE((COP*)CvSTART((const CV*)cx->blk_sub.cv)), \
3e2413e5
DL
648 CopLINE((COP*)CvSTART((const CV*)cx->blk_sub.cv)), \
649 CopSTASHPV((COP*)CvSTART((const CV*)cx->blk_sub.cv))); \
5ac1e9b2 650 \
bafb2adc 651 if (CxHASARGS(cx)) { \
7766f137 652 POP_SAVEARRAY(); \
d8b46c1b 653 /* abandon @_ if it got reified */ \
a8bba7fa 654 if (AvREAL(cx->blk_sub.argarray)) { \
e2d306cb 655 const SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
2f995715 656 SvREFCNT_dec_NN(cx->blk_sub.argarray); \
a8bba7fa
GS
657 cx->blk_sub.argarray = newAV(); \
658 av_extend(cx->blk_sub.argarray, fill); \
11ca45c0 659 AvREIFY_only(cx->blk_sub.argarray); \
b1bc3f34 660 CX_CURPAD_SV(cx->blk_sub, 0) = MUTABLE_SV(cx->blk_sub.argarray); \
d8b46c1b 661 } \
7766f137 662 else { \
8e09340b 663 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
7766f137 664 } \
79072805 665 } \
b1bc3f34 666 sv = MUTABLE_SV(cx->blk_sub.cv); \
8f629a87 667 if (sv && (CvDEPTH((const CV*)sv) = cx->blk_sub.olddepth)) \
a0714e2c 668 sv = NULL; \
b0d9ce38
GS
669 } STMT_END
670
671#define LEAVESUB(sv) \
672 STMT_START { \
d2687c98 673 SvREFCNT_dec(sv); \
b0d9ce38 674 } STMT_END
79072805
LW
675
676#define POPFORMAT(cx) \
f9c764c5 677 setdefout(cx->blk_format.dfoutgv); \
f32c7e86 678 CvDEPTH(cx->blk_format.cv)--; \
2f995715
FC
679 if (!CvDEPTH(cx->blk_format.cv)) \
680 SvREFCNT_dec_NN(cx->blk_format.cv); \
681 SvREFCNT_dec_NN(cx->blk_format.dfoutgv);
79072805
LW
682
683/* eval context */
684struct block_eval {
8e663997
NC
685 OP * retop; /* op to execute on exit from eval */
686 /* Above here is the same for sub, format and eval. */
0f79a09d 687 SV * old_namesv;
79072805 688 OP * old_eval_root;
748a9306 689 SV * cur_text;
2090ab20 690 CV * cv;
abd70938 691 JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */
79072805
LW
692};
693
17347a51
NC
694/* If we ever need more than 512 op types, change the shift from 7.
695 blku_gimme is actually also only 2 bits, so could be merged with something.
696*/
697
698#define CxOLD_IN_EVAL(cx) (((cx)->blk_u16) & 0x7F)
699#define CxOLD_OP_TYPE(cx) (((cx)->blk_u16) >> 7)
85a64632 700
6b75f042 701#define PUSHEVAL(cx,n) \
0f79a09d 702 STMT_START { \
17347a51
NC
703 assert(!(PL_in_eval & ~0x7F)); \
704 assert(!(PL_op->op_type & ~0x1FF)); \
705 cx->blk_u16 = (PL_in_eval & 0x7F) | ((U16)PL_op->op_type << 7); \
a0714e2c 706 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL); \
a8bba7fa 707 cx->blk_eval.old_eval_root = PL_eval_root; \
bdc0bf6f 708 cx->blk_eval.cur_text = PL_parser ? PL_parser->linestr : NULL; \
601f1833 709 cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */ \
5f66b61c 710 cx->blk_eval.retop = NULL; \
abd70938 711 cx->blk_eval.cur_top_env = PL_top_env; \
0f79a09d 712 } STMT_END
79072805
LW
713
714#define POPEVAL(cx) \
0f79a09d 715 STMT_START { \
85a64632
NC
716 PL_in_eval = CxOLD_IN_EVAL(cx); \
717 optype = CxOLD_OP_TYPE(cx); \
7766f137 718 PL_eval_root = cx->blk_eval.old_eval_root; \
d37427bc 719 if (cx->blk_eval.cur_text && SvSCREAM(cx->blk_eval.cur_text)) \
2f995715 720 SvREFCNT_dec_NN(cx->blk_eval.cur_text); \
0f79a09d
GS
721 if (cx->blk_eval.old_namesv) \
722 sv_2mortal(cx->blk_eval.old_namesv); \
723 } STMT_END
79072805
LW
724
725/* loop context */
726struct block_loop {
79072805 727 I32 resetsp;
022eaa24 728 LOOP * my_op; /* My op, that contains redo, next and last ops. */
df530c37
DM
729 union { /* different ways of locating the iteration variable */
730 SV **svp;
731 GV *gv;
732 PAD *oldcomppad; /* only used in ITHREADS */
733 } itervar_u;
493b0a3c 734 union {
d01136d6
BS
735 struct { /* valid if type is LOOP_FOR or LOOP_PLAIN (but {NULL,0})*/
736 AV * ary; /* use the stack if this is NULL */
737 IV ix;
738 } ary;
739 struct { /* valid if type is LOOP_LAZYIV */
740 IV cur;
741 IV end;
742 } lazyiv;
743 struct { /* valid if type if LOOP_LAZYSV */
744 SV * cur;
745 SV * end; /* maxiumum value (or minimum in reverse) */
746 } lazysv;
747 } state_u;
79072805
LW
748};
749
7766f137 750#ifdef USE_ITHREADS
f83b46a0
DM
751# define CxITERVAR_PADSV(c) \
752 &CX_CURPAD_SV( (c)->blk_loop.itervar_u, (c)->blk_loop.my_op->op_targ)
753#else
754# define CxITERVAR_PADSV(c) ((c)->blk_loop.itervar_u.svp)
755#endif
756
757#define CxITERVAR(c) \
df530c37 758 ((c)->blk_loop.itervar_u.oldcomppad \
e846cb92 759 ? (CxPADLOOP(c) \
f83b46a0 760 ? CxITERVAR_PADSV(c) \
df530c37 761 : &GvSV((c)->blk_loop.itervar_u.gv)) \
7766f137 762 : (SV**)NULL)
f83b46a0 763
b1cf8b36 764#define CxLABEL(c) (0 + CopLABEL((c)->blk_oldcop))
5db1eb8d
BF
765#define CxLABEL_len(c,len) (0 + CopLABEL_len((c)->blk_oldcop, len))
766#define CxLABEL_len_flags(c,len,flags) (0 + CopLABEL_len_flags((c)->blk_oldcop, len, flags))
ae423868 767#define CxHASARGS(c) (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
446d0787 768#define CxLVAL(c) (0 + (c)->blk_u16)
7766f137 769
3b719c58
NC
770#define PUSHLOOP_PLAIN(cx, s) \
771 cx->blk_loop.resetsp = s - PL_stack_base; \
772 cx->blk_loop.my_op = cLOOP; \
d01136d6
BS
773 cx->blk_loop.state_u.ary.ary = NULL; \
774 cx->blk_loop.state_u.ary.ix = 0; \
df530c37 775 cx->blk_loop.itervar_u.svp = NULL;
3b719c58 776
df530c37 777#define PUSHLOOP_FOR(cx, ivar, s) \
38a230cb 778 cx->blk_loop.resetsp = s - PL_stack_base; \
022eaa24 779 cx->blk_loop.my_op = cLOOP; \
d01136d6
BS
780 cx->blk_loop.state_u.ary.ary = NULL; \
781 cx->blk_loop.state_u.ary.ix = 0; \
df530c37 782 cx->blk_loop.itervar_u.svp = (SV**)(ivar);
79072805
LW
783
784#define POPLOOP(cx) \
d01136d6 785 if (CxTYPE(cx) == CXt_LOOP_LAZYSV) { \
2f995715
FC
786 SvREFCNT_dec_NN(cx->blk_loop.state_u.lazysv.cur); \
787 SvREFCNT_dec_NN(cx->blk_loop.state_u.lazysv.end); \
d01136d6 788 } \
d01136d6
BS
789 if (CxTYPE(cx) == CXt_LOOP_FOR) \
790 SvREFCNT_dec(cx->blk_loop.state_u.ary.ary);
79072805 791
0d863452
RH
792/* given/when context */
793struct block_givwhen {
794 OP *leave_op;
795};
796
797#define PUSHGIVEN(cx) \
798 cx->blk_givwhen.leave_op = cLOGOP->op_other;
799
800#define PUSHWHEN PUSHGIVEN
801
79072805
LW
802/* context common to subroutines, evals and loops */
803struct block {
446d0787 804 U8 blku_type; /* what kind of context this is */
2e0df0e8 805 U8 blku_gimme; /* is this block running in list context? */
17347a51 806 U16 blku_u16; /* used by block_sub and block_eval (so far) */
79072805
LW
807 I32 blku_oldsp; /* stack pointer to copy stuff down to */
808 COP * blku_oldcop; /* old curcop pointer */
79072805
LW
809 I32 blku_oldmarksp; /* mark stack index */
810 I32 blku_oldscopesp; /* scope stack index */
811 PMOP * blku_oldpm; /* values of pattern match vars */
79072805
LW
812
813 union {
814 struct block_sub blku_sub;
f9c764c5 815 struct block_format blku_format;
79072805
LW
816 struct block_eval blku_eval;
817 struct block_loop blku_loop;
0d863452 818 struct block_givwhen blku_givwhen;
79072805
LW
819 } blk_u;
820};
821#define blk_oldsp cx_u.cx_blk.blku_oldsp
822#define blk_oldcop cx_u.cx_blk.blku_oldcop
79072805
LW
823#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
824#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
825#define blk_oldpm cx_u.cx_blk.blku_oldpm
826#define blk_gimme cx_u.cx_blk.blku_gimme
446d0787 827#define blk_u16 cx_u.cx_blk.blku_u16
79072805 828#define blk_sub cx_u.cx_blk.blk_u.blku_sub
f9c764c5 829#define blk_format cx_u.cx_blk.blk_u.blku_format
79072805
LW
830#define blk_eval cx_u.cx_blk.blk_u.blku_eval
831#define blk_loop cx_u.cx_blk.blk_u.blku_loop
0d863452 832#define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen
79072805 833
1c98cc53 834#define DEBUG_CX(action) \
d9f81b50 835 DEBUG_l( \
1c98cc53
DM
836 Perl_deb(aTHX_ "CX %ld %s %s (scope %ld,%ld) at %s:%d\n", \
837 (long)cxstack_ix, \
838 action, \
839 PL_block_type[CxTYPE(&cxstack[cxstack_ix])], \
840 (long)PL_scopestack_ix, \
841 (long)(cxstack[cxstack_ix].blk_oldscopesp), \
d9f81b50 842 __FILE__, __LINE__));
1c98cc53 843
79072805 844/* Enter a block. */
8990e307 845#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805 846 cx->cx_type = t, \
3280af22
NIS
847 cx->blk_oldsp = sp - PL_stack_base, \
848 cx->blk_oldcop = PL_curcop, \
1aff0e91 849 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22 850 cx->blk_oldscopesp = PL_scopestack_ix, \
3280af22 851 cx->blk_oldpm = PL_curpm, \
eb160463 852 cx->blk_gimme = (U8)gimme; \
1c98cc53 853 DEBUG_CX("PUSH");
79072805
LW
854
855/* Exit a block (RETURN and LAST). */
1c98cc53
DM
856#define POPBLOCK(cx,pm) \
857 DEBUG_CX("POP"); \
858 cx = &cxstack[cxstack_ix--], \
1aff0e91 859 newsp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
860 PL_curcop = cx->blk_oldcop, \
861 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
862 PL_scopestack_ix = cx->blk_oldscopesp, \
3280af22 863 pm = cx->blk_oldpm, \
1c98cc53 864 gimme = cx->blk_gimme;
79072805
LW
865
866/* Continue a block elsewhere (NEXT and REDO). */
1c98cc53
DM
867#define TOPBLOCK(cx) \
868 DEBUG_CX("TOP"); \
869 cx = &cxstack[cxstack_ix], \
1aff0e91 870 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
871 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
872 PL_scopestack_ix = cx->blk_oldscopesp, \
1c98cc53 873 PL_curpm = cx->blk_oldpm;
79072805
LW
874
875/* substitution context */
876struct subst {
446d0787 877 U8 sbu_type; /* what kind of context this is */
1ed74d04 878 U8 sbu_rflags;
446d0787 879 U16 sbu_rxtainted; /* matches struct block */
79072805
LW
880 I32 sbu_iters;
881 I32 sbu_maxiters;
4633a7c4 882 I32 sbu_oldsave;
79072805
LW
883 char * sbu_orig;
884 SV * sbu_dstr;
885 SV * sbu_targ;
886 char * sbu_s;
887 char * sbu_m;
888 char * sbu_strend;
c90c0ff4 889 void * sbu_rxres;
c07a80fd 890 REGEXP * sbu_rx;
79072805
LW
891};
892#define sb_iters cx_u.cx_subst.sbu_iters
893#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9 894#define sb_rflags cx_u.cx_subst.sbu_rflags
4633a7c4 895#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc 896#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805
LW
897#define sb_orig cx_u.cx_subst.sbu_orig
898#define sb_dstr cx_u.cx_subst.sbu_dstr
899#define sb_targ cx_u.cx_subst.sbu_targ
900#define sb_s cx_u.cx_subst.sbu_s
901#define sb_m cx_u.cx_subst.sbu_m
902#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4 903#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd 904#define sb_rx cx_u.cx_subst.sbu_rx
79072805 905
9c105995
NC
906#ifdef PERL_CORE
907# define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
79072805
LW
908 cx->sb_iters = iters, \
909 cx->sb_maxiters = maxiters, \
22e551b9 910 cx->sb_rflags = r_flags, \
4633a7c4 911 cx->sb_oldsave = oldsave, \
71be2cbc 912 cx->sb_rxtainted = rxtainted, \
79072805
LW
913 cx->sb_orig = orig, \
914 cx->sb_dstr = dstr, \
915 cx->sb_targ = targ, \
916 cx->sb_s = s, \
917 cx->sb_m = m, \
918 cx->sb_strend = strend, \
4608196e 919 cx->sb_rxres = NULL, \
c07a80fd 920 cx->sb_rx = rx, \
1ed74d04 921 cx->cx_type = CXt_SUBST | (once ? CXp_ONCE : 0); \
e22ae1e2 922 rxres_save(&cx->sb_rxres, rx); \
b69b0499 923 (void)ReREFCNT_inc(rx)
79072805 924
9c105995 925# define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
e22ae1e2
DM
926 rxres_free(&cx->sb_rxres); \
927 ReREFCNT_dec(cx->sb_rx)
9c105995
NC
928#endif
929
930#define CxONCE(cx) ((cx)->cx_type & CXp_ONCE)
79072805
LW
931
932struct context {
79072805
LW
933 union {
934 struct block cx_blk;
935 struct subst cx_subst;
936 } cx_u;
937};
2e0df0e8 938#define cx_type cx_u.cx_subst.sbu_type
6b35e009 939
76753e7f
NC
940/* If you re-order these, there is also an array of uppercase names in perl.h
941 and a static array of context names in pp_ctl.c */
3701055e 942#define CXTYPEMASK 0xf
79072805 943#define CXt_NULL 0
76753e7f
NC
944#define CXt_WHEN 1
945#define CXt_BLOCK 2
946/* When micro-optimising :-) keep GIVEN next to the LOOPs, as these 5 share a
947 jump table in pp_ctl.c
948 The first 4 don't have a 'case' in at least one switch statement in pp_ctl.c
949*/
950#define CXt_GIVEN 3
c6fdafd0 951/* This is first so that CXt_LOOP_FOR|CXt_LOOP_LAZYIV is CXt_LOOP_LAZYIV */
76753e7f
NC
952#define CXt_LOOP_FOR 4
953#define CXt_LOOP_PLAIN 5
954#define CXt_LOOP_LAZYSV 6
955#define CXt_LOOP_LAZYIV 7
956#define CXt_SUB 8
957#define CXt_FORMAT 9
958#define CXt_EVAL 10
959#define CXt_SUBST 11
960/* SUBST doesn't feature in all switch statements. */
79072805 961
3701055e
NC
962/* private flags for CXt_SUB and CXt_NULL
963 However, this is checked in many places which do not check the type, so
964 this bit needs to be kept clear for most everything else. For reasons I
965 haven't investigated, it can coexist with CXp_FOR_DEF */
1f27d788
NC
966#define CXp_MULTICALL 0x10 /* part of a multicall (so don't
967 tear down context on exit). */
9850bf21 968
ae423868 969/* private flags for CXt_SUB and CXt_FORMAT */
1f27d788 970#define CXp_HASARGS 0x20
ae423868 971
6b35e009 972/* private flags for CXt_EVAL */
1f27d788
NC
973#define CXp_REAL 0x20 /* truly eval'', not a lookalike */
974#define CXp_TRYBLOCK 0x40 /* eval{}, not eval'' or similar */
6b35e009 975
7766f137 976/* private flags for CXt_LOOP */
1f27d788 977#define CXp_FOR_DEF 0x10 /* foreach using $_ */
56b98d0f 978#define CxPADLOOP(c) ((c)->blk_loop.my_op->op_targ)
e846cb92 979
1ed74d04
NC
980/* private flags for CXt_SUBST */
981#define CXp_ONCE 0x10 /* What was sbu_once in struct subst */
7766f137 982
6b35e009 983#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
76753e7f 984#define CxTYPE_is_LOOP(c) (((c)->cx_type & 0xC) == 0x4)
9850bf21
RH
985#define CxMULTICALL(c) (((c)->cx_type & CXp_MULTICALL) \
986 == CXp_MULTICALL)
0588a150 987#define CxREALEVAL(c) (((c)->cx_type & (CXTYPEMASK|CXp_REAL)) \
7766f137 988 == (CXt_EVAL|CXp_REAL))
0588a150 989#define CxTRYBLOCK(c) (((c)->cx_type & (CXTYPEMASK|CXp_TRYBLOCK)) \
1d76a5c3 990 == (CXt_EVAL|CXp_TRYBLOCK))
3b719c58
NC
991#define CxFOREACH(c) (CxTYPE_is_LOOP(c) && CxTYPE(c) != CXt_LOOP_PLAIN)
992#define CxFOREACHDEF(c) ((CxTYPE_is_LOOP(c) && CxTYPE(c) != CXt_LOOP_PLAIN) \
993 && ((c)->cx_type & CXp_FOR_DEF))
6b35e009 994
109bf713 995#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
79072805 996
ccfc67b7
JH
997/*
998=head1 "Gimme" Values
999*/
954c1994
GS
1000
1001/*
1002=for apidoc AmU||G_SCALAR
1003Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
1004L<perlcall>.
1005
1006=for apidoc AmU||G_ARRAY
91e74348 1007Used to indicate list context. See C<GIMME_V>, C<GIMME> and
954c1994
GS
1008L<perlcall>.
1009
1010=for apidoc AmU||G_VOID
1011Used to indicate void context. See C<GIMME_V> and L<perlcall>.
1012
1013=for apidoc AmU||G_DISCARD
1014Indicates that arguments returned from a callback should be discarded. See
1015L<perlcall>.
1016
1017=for apidoc AmU||G_EVAL
1018
1019Used to force a Perl C<eval> wrapper around a callback. See
1020L<perlcall>.
1021
1022=for apidoc AmU||G_NOARGS
1023
1024Indicates that no arguments are being sent to a callback. See
1025L<perlcall>.
1026
1027=cut
1028*/
1029
2f8edad0
NC
1030#define G_SCALAR 2
1031#define G_ARRAY 3
1032#define G_VOID 1
1033#define G_WANT 3
79072805 1034
864dbfa3 1035/* extra flags for Perl_call_* routines */
2f8edad0 1036#define G_DISCARD 4 /* Call FREETMPS.
b54b4831
NC
1037 Don't change this without consulting the
1038 hash actions codes defined in hv.h */
2f8edad0
NC
1039#define G_EVAL 8 /* Assume eval {} around subroutine call. */
1040#define G_NOARGS 16 /* Don't construct a @_ array. */
7ce09284 1041#define G_KEEPERR 32 /* Warn for errors, don't overwrite $@ */
2f8edad0
NC
1042#define G_NODEBUG 64 /* Disable debugging at toplevel. */
1043#define G_METHOD 128 /* Calling method. */
c40f1585 1044#define G_FAKINGEVAL 256 /* Faking an eval context for call_sv or
edb2152a 1045 fold_constants. */
67549bd2
NC
1046#define G_UNDEF_FILL 512 /* Fill the stack with &PL_sv_undef
1047 A special case for UNSHIFT in
1048 Perl_magic_methcall(). */
d1d7a15d
NC
1049#define G_WRITING_TO_STDERR 1024 /* Perl_write_to_stderr() is calling
1050 Perl_magic_methcall(). */
a1941760 1051#define G_RE_REPARSING 0x800 /* compiling a run-time /(?{..})/ */
e336de0d 1052
faef0170
HS
1053/* flag bits for PL_in_eval */
1054#define EVAL_NULL 0 /* not in an eval */
1055#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
1056#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3 1057#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
6dc8a9e4 1058#define EVAL_INREQUIRE 8 /* The code is being required. */
a1941760 1059#define EVAL_RE_REPARSING 0x10 /* eval_sv() called with G_RE_REPARSING */
faef0170 1060
e336de0d
GS
1061/* Support for switching (stack and block) contexts.
1062 * This ensures magic doesn't invalidate local stack and cx pointers.
1063 */
1064
e788e7d3
GS
1065#define PERLSI_UNKNOWN -1
1066#define PERLSI_UNDEF 0
1067#define PERLSI_MAIN 1
1068#define PERLSI_MAGIC 2
1069#define PERLSI_SORT 3
1070#define PERLSI_SIGNAL 4
1071#define PERLSI_OVERLOAD 5
1072#define PERLSI_DESTROY 6
1073#define PERLSI_WARNHOOK 7
1074#define PERLSI_DIEHOOK 8
1075#define PERLSI_REQUIRE 9
e336de0d
GS
1076
1077struct stackinfo {
1078 AV * si_stack; /* stack for current runlevel */
1079 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
9bd87817
NC
1080 struct stackinfo * si_prev;
1081 struct stackinfo * si_next;
e336de0d
GS
1082 I32 si_cxix; /* current context index */
1083 I32 si_cxmax; /* maximum allocated index */
1084 I32 si_type; /* type of runlevel */
ce2f7c3b 1085 I32 si_markoff; /* offset where markstack begins for us.
e336de0d
GS
1086 * currently used only with DEBUGGING,
1087 * but not #ifdef-ed for bincompat */
1088};
1089
1090typedef struct stackinfo PERL_SI;
1091
3280af22
NIS
1092#define cxstack (PL_curstackinfo->si_cxstack)
1093#define cxstack_ix (PL_curstackinfo->si_cxix)
1094#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d
GS
1095
1096#ifdef DEBUGGING
ce2f7c3b
GS
1097# define SET_MARK_OFFSET \
1098 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
e336de0d 1099#else
ce2f7c3b 1100# define SET_MARK_OFFSET NOOP
e336de0d
GS
1101#endif
1102
d3acc0f7 1103#define PUSHSTACKi(type) \
e336de0d 1104 STMT_START { \
3280af22 1105 PERL_SI *next = PL_curstackinfo->si_next; \
1c98cc53
DM
1106 DEBUG_l({ \
1107 int i = 0; PERL_SI *p = PL_curstackinfo; \
1108 while (p) { i++; p = p->si_prev; } \
1109 Perl_deb(aTHX_ "push STACKINFO %d at %s:%d\n", \
1110 i, __FILE__, __LINE__);}) \
e336de0d
GS
1111 if (!next) { \
1112 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22
NIS
1113 next->si_prev = PL_curstackinfo; \
1114 PL_curstackinfo->si_next = next; \
e336de0d
GS
1115 } \
1116 next->si_type = type; \
1117 next->si_cxix = -1; \
1118 AvFILLp(next->si_stack) = 0; \
3280af22
NIS
1119 SWITCHSTACK(PL_curstack,next->si_stack); \
1120 PL_curstackinfo = next; \
ce2f7c3b 1121 SET_MARK_OFFSET; \
e336de0d
GS
1122 } STMT_END
1123
e788e7d3 1124#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7 1125
3095d977
GS
1126/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
1127 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7 1128#define POPSTACK \
e336de0d 1129 STMT_START { \
39644a26 1130 dSP; \
c4420975 1131 PERL_SI * const prev = PL_curstackinfo->si_prev; \
1c98cc53
DM
1132 DEBUG_l({ \
1133 int i = -1; PERL_SI *p = PL_curstackinfo; \
1134 while (p) { i++; p = p->si_prev; } \
1135 Perl_deb(aTHX_ "pop STACKINFO %d at %s:%d\n", \
1136 i, __FILE__, __LINE__);}) \
e336de0d 1137 if (!prev) { \
3d04513d 1138 Perl_croak_popstack(); \
e336de0d 1139 } \
3280af22 1140 SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d 1141 /* don't free prev here, free them all at the END{} */ \
3280af22 1142 PL_curstackinfo = prev; \
e336de0d
GS
1143 } STMT_END
1144
1145#define POPSTACK_TO(s) \
1146 STMT_START { \
3280af22 1147 while (PL_curstack != s) { \
bac4b2ad 1148 dounwind(-1); \
d3acc0f7 1149 POPSTACK; \
bac4b2ad 1150 } \
e336de0d 1151 } STMT_END
923e4eb5
JH
1152
1153#define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
1154#define IN_PERL_RUNTIME (PL_curcop != &PL_compiling)
1155
9850bf21
RH
1156/*
1157=head1 Multicall Functions
1158
1159=for apidoc Ams||dMULTICALL
0eda4409 1160Declare local variables for a multicall. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1161
1162=for apidoc Ams||PUSH_MULTICALL
1163Opening bracket for a lightweight callback.
0eda4409 1164See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1165
1166=for apidoc Ams||MULTICALL
0eda4409 1167Make a lightweight callback. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1168
1169=for apidoc Ams||POP_MULTICALL
1170Closing bracket for a lightweight callback.
0eda4409 1171See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1172
1173=cut
1174*/
1175
1176#define dMULTICALL \
1177 SV **newsp; /* set by POPBLOCK */ \
1178 PERL_CONTEXT *cx; \
82f35e8b 1179 CV *multicall_cv; \
9850bf21
RH
1180 OP *multicall_cop; \
1181 bool multicall_oldcatch; \
1182 U8 hasargs = 0 /* used by PUSHSUB */
1183
82f35e8b 1184#define PUSH_MULTICALL(the_cv) \
81ed78b2
DM
1185 PUSH_MULTICALL_WITHDEPTH(the_cv, 1);
1186
1187/* Like PUSH_MULTICALL, but allows you to specify the CvDEPTH increment,
1188 * rather than the default of 1 (this isn't part of the public API) */
1189
1190#define PUSH_MULTICALL_WITHDEPTH(the_cv, depth) \
9850bf21 1191 STMT_START { \
0bcc34c2
AL
1192 CV * const _nOnclAshIngNamE_ = the_cv; \
1193 CV * const cv = _nOnclAshIngNamE_; \
b70d5558 1194 PADLIST * const padlist = CvPADLIST(cv); \
9850bf21
RH
1195 ENTER; \
1196 multicall_oldcatch = CATCH_GET; \
1197 SAVETMPS; SAVEVPTR(PL_op); \
1198 CATCH_SET(TRUE); \
1bbbfc50 1199 PUSHSTACKi(PERLSI_SORT); \
9850bf21
RH
1200 PUSHBLOCK(cx, CXt_SUB|CXp_MULTICALL, PL_stack_sp); \
1201 PUSHSUB(cx); \
81ed78b2
DM
1202 CvDEPTH(cv) += depth; \
1203 if (CvDEPTH(cv) >= 2) { \
9850bf21
RH
1204 PERL_STACK_OVERFLOW_CHECK(); \
1205 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
1206 } \
1207 SAVECOMPPAD(); \
1208 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
82f35e8b 1209 multicall_cv = cv; \
9850bf21
RH
1210 multicall_cop = CvSTART(cv); \
1211 } STMT_END
1212
1213#define MULTICALL \
1214 STMT_START { \
1215 PL_op = multicall_cop; \
1216 CALLRUNOPS(aTHX); \
1217 } STMT_END
1218
1219#define POP_MULTICALL \
1220 STMT_START { \
3d26b81e
DM
1221 cx = &cxstack[cxstack_ix]; \
1222 if (! ((CvDEPTH(multicall_cv) = cx->blk_sub.olddepth)) ) { \
81ed78b2
DM
1223 LEAVESUB(multicall_cv); \
1224 } \
9850bf21 1225 POPBLOCK(cx,PL_curpm); \
1bbbfc50 1226 POPSTACK; \
9850bf21
RH
1227 CATCH_SET(multicall_oldcatch); \
1228 LEAVE; \
1bbbfc50 1229 SPAGAIN; \
9850bf21 1230 } STMT_END
b3ca2e83 1231
81ed78b2
DM
1232/* Change the CV of an already-pushed MULTICALL CxSUB block.
1233 * (this isn't part of the public API) */
1234
1235#define CHANGE_MULTICALL_WITHDEPTH(the_cv, depth) \
1236 STMT_START { \
1237 CV * const _nOnclAshIngNamE_ = the_cv; \
1238 CV * const cv = _nOnclAshIngNamE_; \
b70d5558 1239 PADLIST * const padlist = CvPADLIST(cv); \
81ed78b2
DM
1240 cx = &cxstack[cxstack_ix]; \
1241 assert(cx->cx_type & CXp_MULTICALL); \
1242 if (! ((CvDEPTH(multicall_cv) = cx->blk_sub.olddepth)) ) { \
1243 LEAVESUB(multicall_cv); \
1244 } \
1245 cx->cx_type &= ~CXp_HASARGS; \
1246 PUSHSUB(cx); \
1247 CvDEPTH(cv) += depth; \
1248 if (CvDEPTH(cv) >= 2) { \
1249 PERL_STACK_OVERFLOW_CHECK(); \
1250 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
1251 } \
1252 SAVECOMPPAD(); \
1253 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
1254 multicall_cv = cv; \
1255 multicall_cop = CvSTART(cv); \
1256 } STMT_END
b3ca2e83
NC
1257/*
1258 * Local variables:
1259 * c-indentation-style: bsd
1260 * c-basic-offset: 4
14d04a33 1261 * indent-tabs-mode: nil
b3ca2e83
NC
1262 * End:
1263 *
14d04a33 1264 * ex: set ts=8 sts=4 sw=4 et:
b3ca2e83 1265 */