This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
better document macros taking literal strings
[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 9 * Control ops (cops) are one of the two ops OP_NEXTSTATE and OP_DBSTATE,
775e5718 10 * that (loosely speaking) are statement separators.
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;
caa674f3 34 Sigjmp_buf je_buf; /* uninit if je_prev is NULL */
0d2925a6
DM
35 int je_ret; /* last exception thrown */
36 bool je_mustcatch; /* need to call longjmp()? */
a68090fe 37 U16 je_old_delaymagic; /* saved PL_delaymagic */
9449f0d6 38 SSize_t je_old_stack_hwm;
0d2925a6
DM
39};
40
41typedef struct jmpenv JMPENV;
42
9449f0d6
DM
43#if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
44# define JE_OLD_STACK_HWM_zero PL_start_env.je_old_stack_hwm = 0
45# define JE_OLD_STACK_HWM_save(je) \
46 (je).je_old_stack_hwm = PL_curstackinfo->si_stack_hwm
47# define JE_OLD_STACK_HWM_restore(je) \
978b1859
DM
48 if (PL_curstackinfo->si_stack_hwm < (je).je_old_stack_hwm) \
49 PL_curstackinfo->si_stack_hwm = (je).je_old_stack_hwm
9449f0d6
DM
50#else
51# define JE_OLD_STACK_HWM_zero NOOP
52# define JE_OLD_STACK_HWM_save(je) NOOP
53# define JE_OLD_STACK_HWM_restore(je) NOOP
54#endif
55
0d2925a6
DM
56/*
57 * How to build the first jmpenv.
58 *
59 * top_env needs to be non-zero. It points to an area
60 * in which longjmp() stuff is stored, as C callstack
61 * info there at least is thread specific this has to
62 * be per-thread. Otherwise a 'die' in a thread gives
63 * that thread the C stack of last thread to do an eval {}!
64 */
65
66#define JMPENV_BOOTSTRAP \
67 STMT_START { \
caa674f3
DD
68 PERL_POISON_EXPR(PoisonNew(&PL_start_env, 1, JMPENV));\
69 PL_top_env = &PL_start_env; \
70 PL_start_env.je_prev = NULL; \
0d2925a6
DM
71 PL_start_env.je_ret = -1; \
72 PL_start_env.je_mustcatch = TRUE; \
a68090fe 73 PL_start_env.je_old_delaymagic = 0; \
9449f0d6 74 JE_OLD_STACK_HWM_zero; \
0d2925a6
DM
75 } STMT_END
76
77/*
78 * PERL_FLEXIBLE_EXCEPTIONS
79 *
80 * All the flexible exceptions code has been removed.
81 * See the following threads for details:
82 *
83 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2004-07/msg00378.html
84 *
85 * Joshua's original patches (which weren't applied) and discussion:
86 *
87 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01396.html
88 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01489.html
89 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01491.html
90 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01608.html
91 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02144.html
92 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02998.html
93 *
94 * Chip's reworked patch and discussion:
95 *
96 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html
97 *
98 * The flaw in these patches (which went unnoticed at the time) was
99 * that they moved some code that could potentially die() out of the
100 * region protected by the setjmp()s. This caused exceptions within
101 * END blocks and such to not be handled by the correct setjmp().
102 *
103 * The original patches that introduces flexible exceptions were:
104 *
ff7e9008
MS
105 * http://perl5.git.perl.org/perl.git/commit/312caa8e97f1c7ee342a9895c2f0e749625b4929
106 * http://perl5.git.perl.org/perl.git/commit/14dd3ad8c9bf82cf09798a22cc89a9862dfd6d1a
107 *
0d2925a6
DM
108 */
109
110#define dJMPENV JMPENV cur_env
111
112#define JMPENV_PUSH(v) \
113 STMT_START { \
1c98cc53
DM
114 DEBUG_l({ \
115 int i = 0; JMPENV *p = PL_top_env; \
116 while (p) { i++; p = p->je_prev; } \
91e35ba1
DM
117 Perl_deb(aTHX_ "JUMPENV_PUSH level=%d at %s:%d\n", \
118 i, __FILE__, __LINE__);}) \
0d2925a6 119 cur_env.je_prev = PL_top_env; \
9449f0d6 120 JE_OLD_STACK_HWM_save(cur_env); \
0d2925a6 121 cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK); \
9449f0d6 122 JE_OLD_STACK_HWM_restore(cur_env); \
0d2925a6
DM
123 PL_top_env = &cur_env; \
124 cur_env.je_mustcatch = FALSE; \
a68090fe 125 cur_env.je_old_delaymagic = PL_delaymagic; \
0d2925a6
DM
126 (v) = cur_env.je_ret; \
127 } STMT_END
128
129#define JMPENV_POP \
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_POP level=%d at %s:%d\n", \
135 i, __FILE__, __LINE__);}) \
d3ab86be 136 assert(PL_top_env == &cur_env); \
a68090fe 137 PL_delaymagic = cur_env.je_old_delaymagic; \
0d2925a6
DM
138 PL_top_env = cur_env.je_prev; \
139 } STMT_END
140
141#define JMPENV_JUMP(v) \
142 STMT_START { \
1c98cc53
DM
143 DEBUG_l({ \
144 int i = -1; JMPENV *p = PL_top_env; \
145 while (p) { i++; p = p->je_prev; } \
91e35ba1
DM
146 Perl_deb(aTHX_ "JUMPENV_JUMP(%d) level=%d at %s:%d\n", \
147 (int)v, i, __FILE__, __LINE__);}) \
0d2925a6
DM
148 if (PL_top_env->je_prev) \
149 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
150 if ((v) == 2) \
37038d91 151 PerlProc_exit(STATUS_EXIT); \
5637ef5b 152 PerlIO_printf(PerlIO_stderr(), "panic: top_env, v=%d\n", (int)v); \
0d2925a6
DM
153 PerlProc_exit(1); \
154 } STMT_END
155
156#define CATCH_GET (PL_top_env->je_mustcatch)
1c98cc53
DM
157#define CATCH_SET(v) \
158 STMT_START { \
159 DEBUG_l( \
160 Perl_deb(aTHX_ \
161 "JUMPLEVEL set catch %d => %d (for %p) at %s:%d\n", \
162 PL_top_env->je_mustcatch, v, (void*)PL_top_env, \
163 __FILE__, __LINE__);) \
164 PL_top_env->je_mustcatch = (v); \
165 } STMT_END
0d2925a6 166
20439bc7
Z
167/*
168=head1 COP Hint Hashes
169*/
170
171typedef struct refcounted_he COPHH;
172
173#define COPHH_KEY_UTF8 REFCOUNTED_HE_KEY_UTF8
174
175/*
ffd08bbf 176=for apidoc Amx|SV *|cophh_fetch_pvn|const COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|U32 flags
20439bc7 177
2d7f6611
KW
178Look up the entry in the cop hints hash C<cophh> with the key specified by
179C<keypv> and C<keylen>. If C<flags> has the C<COPHH_KEY_UTF8> bit set,
20439bc7 180the key octets are interpreted as UTF-8, otherwise they are interpreted
2d7f6611 181as Latin-1. C<hash> is a precomputed hash of the key string, or zero if
20439bc7
Z
182it has not been precomputed. Returns a mortal scalar copy of the value
183associated with the key, or C<&PL_sv_placeholder> if there is no value
184associated with the key.
185
186=cut
187*/
188
189#define cophh_fetch_pvn(cophh, keypv, keylen, hash, flags) \
190 Perl_refcounted_he_fetch_pvn(aTHX_ cophh, keypv, keylen, hash, flags)
191
192/*
1568d13a 193=for apidoc Amx|SV *|cophh_fetch_pvs|const COPHH *cophh|"literal string" key|U32 flags
20439bc7 194
1568d13a 195Like L</cophh_fetch_pvn>, but takes a literal string instead
0c395ea5 196of a string/length pair, and no precomputed hash.
20439bc7
Z
197
198=cut
199*/
200
201#define cophh_fetch_pvs(cophh, key, flags) \
202 Perl_refcounted_he_fetch_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, flags)
203
204/*
ffd08bbf 205=for apidoc Amx|SV *|cophh_fetch_pv|const COPHH *cophh|const char *key|U32 hash|U32 flags
20439bc7
Z
206
207Like L</cophh_fetch_pvn>, but takes a nul-terminated string instead of
208a string/length pair.
209
210=cut
211*/
212
213#define cophh_fetch_pv(cophh, key, hash, flags) \
214 Perl_refcounted_he_fetch_pv(aTHX_ cophh, key, hash, flags)
215
216/*
ffd08bbf 217=for apidoc Amx|SV *|cophh_fetch_sv|const COPHH *cophh|SV *key|U32 hash|U32 flags
20439bc7
Z
218
219Like L</cophh_fetch_pvn>, but takes a Perl scalar instead of a
220string/length pair.
221
222=cut
223*/
224
225#define cophh_fetch_sv(cophh, key, hash, flags) \
226 Perl_refcounted_he_fetch_sv(aTHX_ cophh, key, hash, flags)
227
228/*
ffd08bbf 229=for apidoc Amx|HV *|cophh_2hv|const COPHH *cophh|U32 flags
20439bc7
Z
230
231Generates and returns a standard Perl hash representing the full set of
2d7f6611 232key/value pairs in the cop hints hash C<cophh>. C<flags> is currently
20439bc7
Z
233unused and must be zero.
234
235=cut
236*/
237
238#define cophh_2hv(cophh, flags) \
239 Perl_refcounted_he_chain_2hv(aTHX_ cophh, flags)
240
241/*
ffd08bbf 242=for apidoc Amx|COPHH *|cophh_copy|COPHH *cophh
20439bc7 243
2d7f6611 244Make and return a complete copy of the cop hints hash C<cophh>.
20439bc7
Z
245
246=cut
247*/
248
249#define cophh_copy(cophh) Perl_refcounted_he_inc(aTHX_ cophh)
250
251/*
ffd08bbf 252=for apidoc Amx|void|cophh_free|COPHH *cophh
20439bc7 253
2d7f6611 254Discard the cop hints hash C<cophh>, freeing all resources associated
20439bc7
Z
255with it.
256
257=cut
258*/
259
260#define cophh_free(cophh) Perl_refcounted_he_free(aTHX_ cophh)
261
262/*
ffd08bbf 263=for apidoc Amx|COPHH *|cophh_new_empty
20439bc7
Z
264
265Generate and return a fresh cop hints hash containing no entries.
266
267=cut
268*/
269
270#define cophh_new_empty() ((COPHH *)NULL)
271
272/*
ffd08bbf 273=for apidoc Amx|COPHH *|cophh_store_pvn|COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|SV *value|U32 flags
20439bc7 274
2d7f6611 275Stores a value, associated with a key, in the cop hints hash C<cophh>,
20439bc7
Z
276and returns the modified hash. The returned hash pointer is in general
277not the same as the hash pointer that was passed in. The input hash is
278consumed by the function, and the pointer to it must not be subsequently
279used. Use L</cophh_copy> if you need both hashes.
280
2d7f6611 281The key is specified by C<keypv> and C<keylen>. If C<flags> has the
20439bc7 282C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8,
2d7f6611 283otherwise they are interpreted as Latin-1. C<hash> is a precomputed
20439bc7
Z
284hash of the key string, or zero if it has not been precomputed.
285
2d7f6611 286C<value> is the scalar value to store for this key. C<value> is copied
20439bc7
Z
287by this function, which thus does not take ownership of any reference
288to it, and later changes to the scalar will not be reflected in the
289value visible in the cop hints hash. Complex types of scalar will not
290be stored with referential integrity, but will be coerced to strings.
291
292=cut
293*/
294
295#define cophh_store_pvn(cophh, keypv, keylen, hash, value, flags) \
296 Perl_refcounted_he_new_pvn(aTHX_ cophh, keypv, keylen, hash, value, flags)
297
298/*
1568d13a 299=for apidoc Amx|COPHH *|cophh_store_pvs|const COPHH *cophh|"literal string" key|SV *value|U32 flags
20439bc7 300
1568d13a 301Like L</cophh_store_pvn>, but takes a literal string instead
0c395ea5 302of a string/length pair, and no precomputed hash.
20439bc7
Z
303
304=cut
305*/
306
307#define cophh_store_pvs(cophh, key, value, flags) \
308 Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, value, flags)
309
310/*
ffd08bbf 311=for apidoc Amx|COPHH *|cophh_store_pv|const COPHH *cophh|const char *key|U32 hash|SV *value|U32 flags
20439bc7
Z
312
313Like L</cophh_store_pvn>, but takes a nul-terminated string instead of
314a string/length pair.
315
316=cut
317*/
318
319#define cophh_store_pv(cophh, key, hash, value, flags) \
320 Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, value, flags)
321
322/*
ffd08bbf 323=for apidoc Amx|COPHH *|cophh_store_sv|const COPHH *cophh|SV *key|U32 hash|SV *value|U32 flags
20439bc7
Z
324
325Like L</cophh_store_pvn>, but takes a Perl scalar instead of a
326string/length pair.
327
328=cut
329*/
330
331#define cophh_store_sv(cophh, key, hash, value, flags) \
332 Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, value, flags)
333
334/*
ffd08bbf 335=for apidoc Amx|COPHH *|cophh_delete_pvn|COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|U32 flags
20439bc7 336
2d7f6611 337Delete a key and its associated value from the cop hints hash C<cophh>,
20439bc7
Z
338and returns the modified hash. The returned hash pointer is in general
339not the same as the hash pointer that was passed in. The input hash is
340consumed by the function, and the pointer to it must not be subsequently
341used. Use L</cophh_copy> if you need both hashes.
342
2d7f6611 343The key is specified by C<keypv> and C<keylen>. If C<flags> has the
20439bc7 344C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8,
2d7f6611 345otherwise they are interpreted as Latin-1. C<hash> is a precomputed
20439bc7
Z
346hash of the key string, or zero if it has not been precomputed.
347
348=cut
349*/
350
351#define cophh_delete_pvn(cophh, keypv, keylen, hash, flags) \
352 Perl_refcounted_he_new_pvn(aTHX_ cophh, keypv, keylen, hash, \
353 (SV *)NULL, flags)
354
355/*
1568d13a 356=for apidoc Amx|COPHH *|cophh_delete_pvs|const COPHH *cophh|"literal string" key|U32 flags
20439bc7 357
1568d13a 358Like L</cophh_delete_pvn>, but takes a literal string instead
0c395ea5 359of a string/length pair, and no precomputed hash.
20439bc7
Z
360
361=cut
362*/
363
364#define cophh_delete_pvs(cophh, key, flags) \
365 Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, \
366 (SV *)NULL, flags)
367
368/*
ffd08bbf 369=for apidoc Amx|COPHH *|cophh_delete_pv|const COPHH *cophh|const char *key|U32 hash|U32 flags
20439bc7
Z
370
371Like L</cophh_delete_pvn>, but takes a nul-terminated string instead of
372a string/length pair.
373
374=cut
375*/
376
377#define cophh_delete_pv(cophh, key, hash, flags) \
378 Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, (SV *)NULL, flags)
379
380/*
ffd08bbf 381=for apidoc Amx|COPHH *|cophh_delete_sv|const COPHH *cophh|SV *key|U32 hash|U32 flags
20439bc7
Z
382
383Like L</cophh_delete_pvn>, but takes a Perl scalar instead of a
384string/length pair.
385
386=cut
387*/
388
389#define cophh_delete_sv(cophh, key, hash, flags) \
390 Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, (SV *)NULL, flags)
0d2925a6 391
5ac1e9b2 392#include "mydtrace.h"
0d2925a6 393
88df5f01
FC
394struct cop {
395 BASEOP
396 /* On LP64 putting this here takes advantage of the fact that BASEOP isn't
397 an exact multiple of 8 bytes to save structure padding. */
398 line_t cop_line; /* line # of this command */
399 /* label for this construct is now stored in cop_hints_hash */
57843af0 400#ifdef USE_ITHREADS
88df5f01
FC
401 PADOFFSET cop_stashoff; /* offset into PL_stashpad, for the
402 package the line was compiled in */
1dc74fdb 403 char * cop_file; /* file name the following line # is from */
57843af0 404#else
88df5f01 405 HV * cop_stash; /* package line was compiled in */
79072805 406 GV * cop_filegv; /* file the following line # is from */
57843af0 407#endif
88df5f01
FC
408 U32 cop_hints; /* hints bits from pragmata */
409 U32 cop_seq; /* parse sequence number */
410 /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *: */
411 STRLEN * cop_warnings; /* lexical warnings bitmask */
412 /* compile time state of %^H. See the comment in op.c for how this is
413 used to recreate a hash to return from caller. */
20439bc7 414 COPHH * cop_hints_hash;
79072805
LW
415};
416
57843af0 417#ifdef USE_ITHREADS
1dc74fdb
FC
418# define CopFILE(c) ((c)->cop_file)
419# define CopFILEGV(c) (CopFILE(c) \
420 ? gv_fetchfile(CopFILE(c)) : NULL)
421
422# ifdef NETWARE
423# define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
d166b3ad 424# define CopFILE_setn(c,pv,l) ((c)->cop_file = savepvn((pv),(l)))
1dc74fdb
FC
425# else
426# define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
427# define CopFILE_setn(c,pv,l) ((c)->cop_file = savesharedpvn((pv),(l)))
428# endif
429
430# define CopFILESV(c) (CopFILE(c) \
431 ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
432# define CopFILEAV(c) (CopFILE(c) \
433 ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
434# define CopFILEAVx(c) (assert_(CopFILE(c)) \
435 GvAV(gv_fetchfile(CopFILE(c))))
083fcd59 436
d4d03940
FC
437# define CopSTASH(c) PL_stashpad[(c)->cop_stashoff]
438# define CopSTASH_set(c,hv) ((c)->cop_stashoff = (hv) \
439 ? alloccopstash(hv) \
440 : 0)
1dc74fdb
FC
441# ifdef NETWARE
442# define CopFILE_free(c) SAVECOPFILE_FREE(c)
443# else
444# define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
445# endif
57843af0
GS
446#else
447# define CopFILEGV(c) ((c)->cop_filegv)
f4dd75d9 448# define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
1dc74fdb
FC
449# define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
450# define CopFILE_setn(c,pv,l) CopFILEGV_set((c), gv_fetchfile_flags((pv),(l),0))
451# define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
452# define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
453# ifdef DEBUGGING
454# define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
455# else
456# define CopFILEAVx(c) (GvAV(CopFILEGV(c)))
457# endif
458# define CopFILE(c) (CopFILEGV(c) \
459 ? GvNAME(CopFILEGV(c))+2 : NULL)
57843af0 460# define CopSTASH(c) ((c)->cop_stash)
f4dd75d9 461# define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
a0714e2c 462# define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
05ec9bb3 463
57843af0 464#endif /* USE_ITHREADS */
20439bc7 465
d4d03940
FC
466#define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
467 /* cop_stash is not refcounted */
468#define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
469#define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
d4d03940 470
20439bc7
Z
471#define CopHINTHASH_get(c) ((COPHH*)((c)->cop_hints_hash))
472#define CopHINTHASH_set(c,h) ((c)->cop_hints_hash = (h))
473
474/*
475=head1 COP Hint Reading
476*/
477
478/*
479=for apidoc Am|SV *|cop_hints_fetch_pvn|const COP *cop|const char *keypv|STRLEN keylen|U32 hash|U32 flags
480
2d7f6611
KW
481Look up the hint entry in the cop C<cop> with the key specified by
482C<keypv> and C<keylen>. If C<flags> has the C<COPHH_KEY_UTF8> bit set,
20439bc7 483the key octets are interpreted as UTF-8, otherwise they are interpreted
2d7f6611 484as Latin-1. C<hash> is a precomputed hash of the key string, or zero if
20439bc7
Z
485it has not been precomputed. Returns a mortal scalar copy of the value
486associated with the key, or C<&PL_sv_placeholder> if there is no value
487associated with the key.
488
489=cut
490*/
491
492#define cop_hints_fetch_pvn(cop, keypv, keylen, hash, flags) \
493 cophh_fetch_pvn(CopHINTHASH_get(cop), keypv, keylen, hash, flags)
494
495/*
1568d13a 496=for apidoc Am|SV *|cop_hints_fetch_pvs|const COP *cop|"literal string" key|U32 flags
20439bc7 497
1568d13a 498Like L</cop_hints_fetch_pvn>, but takes a literal string
0c395ea5 499instead of a string/length pair, and no precomputed hash.
20439bc7
Z
500
501=cut
502*/
503
504#define cop_hints_fetch_pvs(cop, key, flags) \
505 cophh_fetch_pvs(CopHINTHASH_get(cop), key, flags)
506
507/*
508=for apidoc Am|SV *|cop_hints_fetch_pv|const COP *cop|const char *key|U32 hash|U32 flags
509
510Like L</cop_hints_fetch_pvn>, but takes a nul-terminated string instead
511of a string/length pair.
512
513=cut
514*/
515
516#define cop_hints_fetch_pv(cop, key, hash, flags) \
517 cophh_fetch_pv(CopHINTHASH_get(cop), key, hash, flags)
518
519/*
520=for apidoc Am|SV *|cop_hints_fetch_sv|const COP *cop|SV *key|U32 hash|U32 flags
521
522Like L</cop_hints_fetch_pvn>, but takes a Perl scalar instead of a
523string/length pair.
524
525=cut
526*/
527
528#define cop_hints_fetch_sv(cop, key, hash, flags) \
529 cophh_fetch_sv(CopHINTHASH_get(cop), key, hash, flags)
530
531/*
532=for apidoc Am|HV *|cop_hints_2hv|const COP *cop|U32 flags
533
534Generates and returns a standard Perl hash representing the full set of
2d7f6611 535hint entries in the cop C<cop>. C<flags> is currently unused and must
20439bc7
Z
536be zero.
537
538=cut
539*/
540
541#define cop_hints_2hv(cop, flags) \
542 cophh_2hv(CopHINTHASH_get(cop), flags)
543
aebc0cbe 544#define CopLABEL(c) Perl_cop_fetch_label(aTHX_ (c), NULL, NULL)
5db1eb8d
BF
545#define CopLABEL_len(c,len) Perl_cop_fetch_label(aTHX_ (c), len, NULL)
546#define CopLABEL_len_flags(c,len,flags) Perl_cop_fetch_label(aTHX_ (c), len, flags)
dca6062a 547#define CopLABEL_alloc(pv) ((pv)?savepv(pv):NULL)
57843af0 548
ed094faf 549#define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
cc49e20b 550#define CopLINE(c) ((c)->cop_line)
57843af0
GS
551#define CopLINE_inc(c) (++CopLINE(c))
552#define CopLINE_dec(c) (--CopLINE(c))
553#define CopLINE_set(c,l) (CopLINE(c) = (l))
cc49e20b 554
248c2a4d 555/* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
e37778c2 556#define OutCopFILE(c) CopFILE(c)
248c2a4d 557
d5ec2987 558#define CopHINTS_get(c) ((c)->cop_hints + 0)
623e6609 559#define CopHINTS_set(c, h) STMT_START { \
d5ec2987 560 (c)->cop_hints = (h); \
623e6609
NC
561 } STMT_END
562
79072805
LW
563/*
564 * Here we have some enormously heavy (or at least ponderous) wizardry.
565 */
566
567/* subroutine context */
568struct block_sub {
f9c764c5 569 OP * retop; /* op to execute on exit from sub */
adcbf118 570 /* Above here is the same for sub, format and eval. */
9aa350eb 571 PAD *prevcomppad; /* the caller's PL_comppad */
8e663997 572 CV * cv;
f9c764c5 573 /* Above here is the same for sub and format. */
bb172083 574 I32 olddepth;
3073d04f 575 AV *savearray;
f9c764c5
NC
576};
577
578
579/* format context */
580struct block_format {
f39bc417 581 OP * retop; /* op to execute on exit from sub */
adcbf118 582 /* Above here is the same for sub, format and eval. */
9aa350eb 583 PAD *prevcomppad; /* the caller's PL_comppad */
8e663997 584 CV * cv;
f9c764c5
NC
585 /* Above here is the same for sub and format. */
586 GV * gv;
587 GV * dfoutgv;
79072805
LW
588};
589
4ebe6e95
DM
590/* return a pointer to the current context */
591
592#define CX_CUR() (&cxstack[cxstack_ix])
593
dfe0f39b
DM
594/* free all savestack items back to the watermark of the specified context */
595
e992140c 596#define CX_LEAVE_SCOPE(cx) LEAVE_SCOPE(cx->blk_oldsaveix)
dfe0f39b 597
5da525e9
DM
598#ifdef DEBUGGING
599/* on debugging builds, poison cx afterwards so we know no code
600 * uses it - because after doing cxstack_ix--, any ties, exceptions etc
601 * may overwrite the current stack frame */
602# define CX_POP(cx) \
4ebe6e95 603 assert(CX_CUR() == cx); \
5da525e9
DM
604 cxstack_ix--; \
605 cx = NULL;
606#else
607# define CX_POP(cx) cxstack_ix--;
608#endif
609
610
b36bdeca 611/* base for the next two macros. Don't use directly.
d6911e1b
DM
612 * The context frame holds a reference to the CV so that it can't be
613 * freed while we're executing it */
b36bdeca 614
b36bdeca 615
490576d1 616#define CX_PUSHSUB_GET_LVALUE_MASK(func) \
777d9014
FC
617 /* If the context is indeterminate, then only the lvalue */ \
618 /* flags that the caller also has are applicable. */ \
4587c532 619 ( \
777d9014
FC
620 (PL_op->op_flags & OPf_WANT) \
621 ? OPpENTERSUB_LVAL_MASK \
622 : !(PL_op->op_private & OPpENTERSUB_LVAL_MASK) \
4587c532
FC
623 ? 0 : (U8)func(aTHX) \
624 )
625
fad386cb 626/* Restore old @_ */
b405d38b 627#define CX_POP_SAVEARRAY(cx) \
6d4ff0d2 628 STMT_START { \
f2b9631d 629 AV *cx_pop_savearray_av = GvAV(PL_defgv); \
a8bba7fa 630 GvAV(PL_defgv) = cx->blk_sub.savearray; \
656457d0 631 cx->blk_sub.savearray = NULL; \
f2b9631d 632 SvREFCNT_dec(cx_pop_savearray_av); \
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
7e27c4a5 644
79072805
LW
645/* eval context */
646struct block_eval {
8e663997
NC
647 OP * retop; /* op to execute on exit from eval */
648 /* Above here is the same for sub, format and eval. */
0f79a09d 649 SV * old_namesv;
79072805 650 OP * old_eval_root;
748a9306 651 SV * cur_text;
2090ab20 652 CV * cv;
abd70938 653 JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */
79072805
LW
654};
655
17347a51
NC
656/* If we ever need more than 512 op types, change the shift from 7.
657 blku_gimme is actually also only 2 bits, so could be merged with something.
658*/
659
4c57ced5
DM
660/* blk_u16 bit usage for eval contexts: */
661
662#define CxOLD_IN_EVAL(cx) (((cx)->blk_u16) & 0x3F) /* saved PL in_eval */
663#define CxEVAL_TXT_REFCNTED(cx) (((cx)->blk_u16) & 0x40) /* cur_text rc++ */
664#define CxOLD_OP_TYPE(cx) (((cx)->blk_u16) >> 7) /* type of eval op */
85a64632 665
79072805
LW
666/* loop context */
667struct block_loop {
022eaa24 668 LOOP * my_op; /* My op, that contains redo, next and last ops. */
df530c37 669 union { /* different ways of locating the iteration variable */
b52de964
DM
670 SV **svp; /* for lexicals: address of pad slot */
671 GV *gv; /* for package vars */
df530c37 672 } itervar_u;
f0bb9bf7 673 SV *itersave; /* the original iteration var */
493b0a3c 674 union {
93661e56
DM
675 struct { /* CXt_LOOP_ARY, C<for (@ary)> */
676 AV *ary; /* array being iterated over */
677 IV ix; /* index relative to base of array */
d01136d6 678 } ary;
93661e56
DM
679 struct { /* CXt_LOOP_LIST, C<for (list)> */
680 I32 basesp; /* first element of list on stack */
681 IV ix; /* index relative to basesp */
682 } stack;
683 struct { /* CXt_LOOP_LAZYIV, C<for (1..9)> */
d01136d6
BS
684 IV cur;
685 IV end;
686 } lazyiv;
93661e56 687 struct { /* CXt_LOOP_LAZYSV C<for ('a'..'z')> */
d01136d6
BS
688 SV * cur;
689 SV * end; /* maxiumum value (or minimum in reverse) */
690 } lazysv;
691 } state_u;
7766f137 692#ifdef USE_ITHREADS
b52de964 693 PAD *oldcomppad; /* needed to map itervar_u.svp during thread clone */
f83b46a0 694#endif
b52de964 695};
f83b46a0 696
9af0df0b
DM
697#define CxITERVAR(c) \
698 (CxPADLOOP(c) \
699 ? (c)->blk_loop.itervar_u.svp \
700 : ((c)->cx_type & CXp_FOR_GV) \
701 ? &GvSV((c)->blk_loop.itervar_u.gv) \
702 : (SV **)&(c)->blk_loop.itervar_u.gv)
f83b46a0 703
b1cf8b36 704#define CxLABEL(c) (0 + CopLABEL((c)->blk_oldcop))
5db1eb8d
BF
705#define CxLABEL_len(c,len) (0 + CopLABEL_len((c)->blk_oldcop, len))
706#define CxLABEL_len_flags(c,len,flags) (0 + CopLABEL_len_flags((c)->blk_oldcop, len, flags))
ae423868 707#define CxHASARGS(c) (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
d9203e03
DM
708
709/* CxLVAL(): the lval flags of the call site: the relevant flag bits from
710 * the op_private field of the calling pp_entersub (or its caller's caller
711 * if the caller's lvalue context isn't known):
712 * OPpLVAL_INTRO: sub used in lvalue context, e.g. f() = 1;
713 * OPpENTERSUB_INARGS (in conjunction with OPpLVAL_INTRO): the
714 * function is being used as a sub arg or as a referent, e.g.
715 * g(...,f(),...) or $r = \f()
716 * OPpDEREF: 2-bit mask indicating e.g. f()->[0].
717 * Note the contrast with CvLVALUE(), which is a property of the sub
718 * rather than the call site.
719 */
1956db7e 720#define CxLVAL(c) (0 + ((c)->blk_u16 & 0xff))
1956db7e 721
7766f137 722
79072805 723
0d863452
RH
724/* given/when context */
725struct block_givwhen {
726 OP *leave_op;
b95eccd3 727 SV *defsv_save; /* the original $_ */
0d863452
RH
728};
729
0d863452 730
c5369ccc 731
79072805
LW
732/* context common to subroutines, evals and loops */
733struct block {
446d0787 734 U8 blku_type; /* what kind of context this is */
2e0df0e8 735 U8 blku_gimme; /* is this block running in list context? */
17347a51 736 U16 blku_u16; /* used by block_sub and block_eval (so far) */
e992140c
DM
737 I32 blku_oldsaveix; /* saved PL_savestack_ix */
738 /* all the fields above must be aligned with same-sized fields as sbu */
1bef65a2 739 I32 blku_oldsp; /* current sp floor: where nextstate pops to */
79072805 740 I32 blku_oldmarksp; /* mark stack index */
f284fecd 741 COP * blku_oldcop; /* old curcop pointer */
79072805 742 PMOP * blku_oldpm; /* values of pattern match vars */
bb3300d1 743 SSize_t blku_old_tmpsfloor; /* saved PL_tmps_floor */
f284fecd 744 I32 blku_oldscopesp; /* scope stack index */
79072805
LW
745
746 union {
747 struct block_sub blku_sub;
f9c764c5 748 struct block_format blku_format;
79072805
LW
749 struct block_eval blku_eval;
750 struct block_loop blku_loop;
0d863452 751 struct block_givwhen blku_givwhen;
79072805
LW
752 } blk_u;
753};
754#define blk_oldsp cx_u.cx_blk.blku_oldsp
755#define blk_oldcop cx_u.cx_blk.blku_oldcop
79072805
LW
756#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
757#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
758#define blk_oldpm cx_u.cx_blk.blku_oldpm
759#define blk_gimme cx_u.cx_blk.blku_gimme
446d0787 760#define blk_u16 cx_u.cx_blk.blku_u16
e992140c 761#define blk_oldsaveix cx_u.cx_blk.blku_oldsaveix
ce8bb8d8 762#define blk_old_tmpsfloor cx_u.cx_blk.blku_old_tmpsfloor
79072805 763#define blk_sub cx_u.cx_blk.blk_u.blku_sub
f9c764c5 764#define blk_format cx_u.cx_blk.blk_u.blku_format
79072805
LW
765#define blk_eval cx_u.cx_blk.blk_u.blku_eval
766#define blk_loop cx_u.cx_blk.blk_u.blku_loop
0d863452 767#define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen
79072805 768
5e691bc6 769#define CX_DEBUG(cx, action) \
d9f81b50 770 DEBUG_l( \
bb3300d1 771 Perl_deb(aTHX_ "CX %ld %s %s (scope %ld,%ld) (save %ld,%ld) at %s:%d\n",\
1c98cc53
DM
772 (long)cxstack_ix, \
773 action, \
5e691bc6 774 PL_block_type[CxTYPE(cx)], \
1c98cc53 775 (long)PL_scopestack_ix, \
5e691bc6 776 (long)(cx->blk_oldscopesp), \
bb3300d1 777 (long)PL_savestack_ix, \
5e691bc6 778 (long)(cx->blk_oldsaveix), \
d9f81b50 779 __FILE__, __LINE__));
1c98cc53 780
ed8ff0f3 781
79072805
LW
782
783/* substitution context */
784struct subst {
e992140c 785 U8 sbu_type; /* same as blku_type */
1ed74d04 786 U8 sbu_rflags;
e992140c
DM
787 U16 sbu_rxtainted;
788 I32 sbu_oldsaveix; /* same as blku_oldsaveix */
a7f94955 789 /* all the fields above must be aligned with same-sized fields as blk_u */
3c6ef0a5
FC
790 SSize_t sbu_iters;
791 SSize_t sbu_maxiters;
79072805
LW
792 char * sbu_orig;
793 SV * sbu_dstr;
794 SV * sbu_targ;
795 char * sbu_s;
796 char * sbu_m;
797 char * sbu_strend;
c90c0ff4 798 void * sbu_rxres;
c07a80fd 799 REGEXP * sbu_rx;
79072805
LW
800};
801#define sb_iters cx_u.cx_subst.sbu_iters
802#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9 803#define sb_rflags cx_u.cx_subst.sbu_rflags
71be2cbc 804#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805
LW
805#define sb_orig cx_u.cx_subst.sbu_orig
806#define sb_dstr cx_u.cx_subst.sbu_dstr
807#define sb_targ cx_u.cx_subst.sbu_targ
808#define sb_s cx_u.cx_subst.sbu_s
809#define sb_m cx_u.cx_subst.sbu_m
810#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4 811#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd 812#define sb_rx cx_u.cx_subst.sbu_rx
79072805 813
9c105995 814#ifdef PERL_CORE
490576d1 815# define CX_PUSHSUBST(cx) CXINC, cx = CX_CUR(), \
e992140c 816 cx->blk_oldsaveix = oldsave, \
79072805
LW
817 cx->sb_iters = iters, \
818 cx->sb_maxiters = maxiters, \
22e551b9 819 cx->sb_rflags = r_flags, \
71be2cbc 820 cx->sb_rxtainted = rxtainted, \
79072805
LW
821 cx->sb_orig = orig, \
822 cx->sb_dstr = dstr, \
823 cx->sb_targ = targ, \
824 cx->sb_s = s, \
825 cx->sb_m = m, \
826 cx->sb_strend = strend, \
4608196e 827 cx->sb_rxres = NULL, \
c07a80fd 828 cx->sb_rx = rx, \
1ed74d04 829 cx->cx_type = CXt_SUBST | (once ? CXp_ONCE : 0); \
e22ae1e2 830 rxres_save(&cx->sb_rxres, rx); \
cf69025f
TC
831 (void)ReREFCNT_inc(rx); \
832 SvREFCNT_inc_void_NN(targ)
79072805 833
b405d38b 834# define CX_POPSUBST(cx) \
77189b8c
DM
835 STMT_START { \
836 REGEXP *re; \
e4592eb4 837 assert(CxTYPE(cx) == CXt_SUBST); \
e22ae1e2 838 rxres_free(&cx->sb_rxres); \
77189b8c
DM
839 re = cx->sb_rx; \
840 cx->sb_rx = NULL; \
841 ReREFCNT_dec(re); \
842 SvREFCNT_dec_NN(cx->sb_targ); \
843 } STMT_END
9c105995
NC
844#endif
845
846#define CxONCE(cx) ((cx)->cx_type & CXp_ONCE)
79072805
LW
847
848struct context {
79072805
LW
849 union {
850 struct block cx_blk;
851 struct subst cx_subst;
852 } cx_u;
853};
2e0df0e8 854#define cx_type cx_u.cx_subst.sbu_type
6b35e009 855
76753e7f
NC
856/* If you re-order these, there is also an array of uppercase names in perl.h
857 and a static array of context names in pp_ctl.c */
3701055e 858#define CXTYPEMASK 0xf
79646418 859#define CXt_NULL 0 /* currently only used for sort BLOCK */
76753e7f
NC
860#define CXt_WHEN 1
861#define CXt_BLOCK 2
862/* When micro-optimising :-) keep GIVEN next to the LOOPs, as these 5 share a
863 jump table in pp_ctl.c
864 The first 4 don't have a 'case' in at least one switch statement in pp_ctl.c
865*/
866#define CXt_GIVEN 3
93661e56
DM
867
868/* be careful of the ordering of these five. Macros like CxTYPE_is_LOOP,
869 * CxFOREACH compare ranges */
c349b9a0
DM
870#define CXt_LOOP_ARY 4 /* for (@ary) { ...; } */
871#define CXt_LOOP_LAZYSV 5 /* for ('a'..'z') { ...; } */
872#define CXt_LOOP_LAZYIV 6 /* for (1..9) { ...; } */
873#define CXt_LOOP_LIST 7 /* for (1,2,3) { ...; } */
874#define CXt_LOOP_PLAIN 8 /* while (...) { ...; }
875 or plain block { ...; } */
93661e56
DM
876#define CXt_SUB 9
877#define CXt_FORMAT 10
878#define CXt_EVAL 11
879#define CXt_SUBST 12
76753e7f 880/* SUBST doesn't feature in all switch statements. */
79072805 881
ae423868 882/* private flags for CXt_SUB and CXt_FORMAT */
79646418
DM
883#define CXp_MULTICALL 0x10 /* part of a multicall (so don't tear down
884 context on exit). (not CXt_FORMAT) */
1f27d788 885#define CXp_HASARGS 0x20
b0065247
DM
886#define CXp_SUB_RE 0x40 /* code called within regex, i.e. (?{}) */
887#define CXp_SUB_RE_FAKE 0x80 /* fake sub CX for (?{}) in current scope */
ae423868 888
6b35e009 889/* private flags for CXt_EVAL */
1f27d788
NC
890#define CXp_REAL 0x20 /* truly eval'', not a lookalike */
891#define CXp_TRYBLOCK 0x40 /* eval{}, not eval'' or similar */
6b35e009 892
7766f137 893/* private flags for CXt_LOOP */
28e0cf42
DM
894
895/* this is only set in conjunction with CXp_FOR_GV */
1f27d788 896#define CXp_FOR_DEF 0x10 /* foreach using $_ */
28e0cf42 897/* these 3 are mutually exclusive */
d39c26a6 898#define CXp_FOR_LVREF 0x20 /* foreach using \$var */
9af0df0b
DM
899#define CXp_FOR_GV 0x40 /* foreach using package var */
900#define CXp_FOR_PAD 0x80 /* foreach using lexical var */
28e0cf42 901
9af0df0b 902#define CxPADLOOP(c) ((c)->cx_type & CXp_FOR_PAD)
e846cb92 903
1ed74d04
NC
904/* private flags for CXt_SUBST */
905#define CXp_ONCE 0x10 /* What was sbu_once in struct subst */
7766f137 906
6b35e009 907#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
113ebcf5
DM
908#define CxTYPE_is_LOOP(c) ( CxTYPE(cx) >= CXt_LOOP_ARY \
909 && CxTYPE(cx) <= CXt_LOOP_PLAIN)
79646418 910#define CxMULTICALL(c) ((c)->cx_type & CXp_MULTICALL)
0588a150 911#define CxREALEVAL(c) (((c)->cx_type & (CXTYPEMASK|CXp_REAL)) \
7766f137 912 == (CXt_EVAL|CXp_REAL))
0588a150 913#define CxTRYBLOCK(c) (((c)->cx_type & (CXTYPEMASK|CXp_TRYBLOCK)) \
1d76a5c3 914 == (CXt_EVAL|CXp_TRYBLOCK))
113ebcf5
DM
915#define CxFOREACH(c) ( CxTYPE(cx) >= CXt_LOOP_ARY \
916 && CxTYPE(cx) <= CXt_LOOP_LIST)
6b35e009 917
109bf713 918#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
79072805 919
ccfc67b7
JH
920/*
921=head1 "Gimme" Values
922*/
954c1994
GS
923
924/*
925=for apidoc AmU||G_SCALAR
fbe13c60 926Used to indicate scalar context. See C<L</GIMME_V>>, C<L</GIMME>>, and
954c1994
GS
927L<perlcall>.
928
929=for apidoc AmU||G_ARRAY
fbe13c60 930Used to indicate list context. See C<L</GIMME_V>>, C<L</GIMME>> and
954c1994
GS
931L<perlcall>.
932
933=for apidoc AmU||G_VOID
fbe13c60 934Used to indicate void context. See C<L</GIMME_V>> and L<perlcall>.
954c1994
GS
935
936=for apidoc AmU||G_DISCARD
937Indicates that arguments returned from a callback should be discarded. See
938L<perlcall>.
939
940=for apidoc AmU||G_EVAL
941
942Used to force a Perl C<eval> wrapper around a callback. See
943L<perlcall>.
944
945=for apidoc AmU||G_NOARGS
946
947Indicates that no arguments are being sent to a callback. See
948L<perlcall>.
949
950=cut
951*/
952
2f8edad0
NC
953#define G_SCALAR 2
954#define G_ARRAY 3
955#define G_VOID 1
956#define G_WANT 3
79072805 957
864dbfa3 958/* extra flags for Perl_call_* routines */
2f8edad0 959#define G_DISCARD 4 /* Call FREETMPS.
b54b4831
NC
960 Don't change this without consulting the
961 hash actions codes defined in hv.h */
2f8edad0
NC
962#define G_EVAL 8 /* Assume eval {} around subroutine call. */
963#define G_NOARGS 16 /* Don't construct a @_ array. */
7ce09284 964#define G_KEEPERR 32 /* Warn for errors, don't overwrite $@ */
2f8edad0
NC
965#define G_NODEBUG 64 /* Disable debugging at toplevel. */
966#define G_METHOD 128 /* Calling method. */
c40f1585 967#define G_FAKINGEVAL 256 /* Faking an eval context for call_sv or
edb2152a 968 fold_constants. */
67549bd2
NC
969#define G_UNDEF_FILL 512 /* Fill the stack with &PL_sv_undef
970 A special case for UNSHIFT in
971 Perl_magic_methcall(). */
d1d7a15d
NC
972#define G_WRITING_TO_STDERR 1024 /* Perl_write_to_stderr() is calling
973 Perl_magic_methcall(). */
a1941760 974#define G_RE_REPARSING 0x800 /* compiling a run-time /(?{..})/ */
c106c2be 975#define G_METHOD_NAMED 4096 /* calling named method, eg without :: or ' */
e336de0d 976
faef0170
HS
977/* flag bits for PL_in_eval */
978#define EVAL_NULL 0 /* not in an eval */
979#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
980#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3 981#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
6dc8a9e4 982#define EVAL_INREQUIRE 8 /* The code is being required. */
a1941760 983#define EVAL_RE_REPARSING 0x10 /* eval_sv() called with G_RE_REPARSING */
4c57ced5 984/* if adding extra bits, make sure they can fit in CxOLD_OP_TYPE() */
faef0170 985
e336de0d
GS
986/* Support for switching (stack and block) contexts.
987 * This ensures magic doesn't invalidate local stack and cx pointers.
988 */
989
e788e7d3
GS
990#define PERLSI_UNKNOWN -1
991#define PERLSI_UNDEF 0
992#define PERLSI_MAIN 1
993#define PERLSI_MAGIC 2
994#define PERLSI_SORT 3
995#define PERLSI_SIGNAL 4
996#define PERLSI_OVERLOAD 5
997#define PERLSI_DESTROY 6
998#define PERLSI_WARNHOOK 7
999#define PERLSI_DIEHOOK 8
1000#define PERLSI_REQUIRE 9
e1a10f35 1001#define PERLSI_MULTICALL 10
e336de0d
GS
1002
1003struct stackinfo {
1004 AV * si_stack; /* stack for current runlevel */
1005 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
9bd87817
NC
1006 struct stackinfo * si_prev;
1007 struct stackinfo * si_next;
e336de0d
GS
1008 I32 si_cxix; /* current context index */
1009 I32 si_cxmax; /* maximum allocated index */
1010 I32 si_type; /* type of runlevel */
ce2f7c3b 1011 I32 si_markoff; /* offset where markstack begins for us.
e336de0d
GS
1012 * currently used only with DEBUGGING,
1013 * but not #ifdef-ed for bincompat */
1fced1a2 1014#if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
87058c31
DM
1015/* high water mark: for checking if the stack was correctly extended /
1016 * tested for extension by each pp function */
1017 SSize_t si_stack_hwm;
1018#endif
1019
e336de0d
GS
1020};
1021
1022typedef struct stackinfo PERL_SI;
1023
3280af22
NIS
1024#define cxstack (PL_curstackinfo->si_cxstack)
1025#define cxstack_ix (PL_curstackinfo->si_cxix)
1026#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d
GS
1027
1028#ifdef DEBUGGING
ce2f7c3b
GS
1029# define SET_MARK_OFFSET \
1030 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
e336de0d 1031#else
ce2f7c3b 1032# define SET_MARK_OFFSET NOOP
e336de0d
GS
1033#endif
1034
87058c31 1035#if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
45d6bfc0 1036# define PUSHSTACK_INIT_HWM(si) ((si)->si_stack_hwm = 0)
87058c31
DM
1037#else
1038# define PUSHSTACK_INIT_HWM(si) NOOP
1039#endif
1040
d3acc0f7 1041#define PUSHSTACKi(type) \
e336de0d 1042 STMT_START { \
3280af22 1043 PERL_SI *next = PL_curstackinfo->si_next; \
1c98cc53
DM
1044 DEBUG_l({ \
1045 int i = 0; PERL_SI *p = PL_curstackinfo; \
1046 while (p) { i++; p = p->si_prev; } \
1047 Perl_deb(aTHX_ "push STACKINFO %d at %s:%d\n", \
1048 i, __FILE__, __LINE__);}) \
e336de0d
GS
1049 if (!next) { \
1050 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22
NIS
1051 next->si_prev = PL_curstackinfo; \
1052 PL_curstackinfo->si_next = next; \
e336de0d
GS
1053 } \
1054 next->si_type = type; \
1055 next->si_cxix = -1; \
87058c31 1056 PUSHSTACK_INIT_HWM(next); \
e336de0d 1057 AvFILLp(next->si_stack) = 0; \
3280af22
NIS
1058 SWITCHSTACK(PL_curstack,next->si_stack); \
1059 PL_curstackinfo = next; \
ce2f7c3b 1060 SET_MARK_OFFSET; \
e336de0d
GS
1061 } STMT_END
1062
e788e7d3 1063#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7 1064
3095d977
GS
1065/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
1066 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7 1067#define POPSTACK \
e336de0d 1068 STMT_START { \
39644a26 1069 dSP; \
c4420975 1070 PERL_SI * const prev = PL_curstackinfo->si_prev; \
1c98cc53
DM
1071 DEBUG_l({ \
1072 int i = -1; PERL_SI *p = PL_curstackinfo; \
1073 while (p) { i++; p = p->si_prev; } \
1074 Perl_deb(aTHX_ "pop STACKINFO %d at %s:%d\n", \
1075 i, __FILE__, __LINE__);}) \
e336de0d 1076 if (!prev) { \
3d04513d 1077 Perl_croak_popstack(); \
e336de0d 1078 } \
3280af22 1079 SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d 1080 /* don't free prev here, free them all at the END{} */ \
3280af22 1081 PL_curstackinfo = prev; \
e336de0d
GS
1082 } STMT_END
1083
1084#define POPSTACK_TO(s) \
1085 STMT_START { \
3280af22 1086 while (PL_curstack != s) { \
bac4b2ad 1087 dounwind(-1); \
d3acc0f7 1088 POPSTACK; \
bac4b2ad 1089 } \
e336de0d 1090 } STMT_END
923e4eb5 1091
9d990559
DM
1092#define IN_PERL_COMPILETIME cBOOL(PL_curcop == &PL_compiling)
1093#define IN_PERL_RUNTIME cBOOL(PL_curcop != &PL_compiling)
923e4eb5 1094
ed8ff0f3
DM
1095
1096
1097
9850bf21
RH
1098/*
1099=head1 Multicall Functions
1100
1101=for apidoc Ams||dMULTICALL
72d33970 1102Declare local variables for a multicall. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1103
1104=for apidoc Ams||PUSH_MULTICALL
1105Opening bracket for a lightweight callback.
0eda4409 1106See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1107
1108=for apidoc Ams||MULTICALL
72d33970 1109Make a lightweight callback. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1110
1111=for apidoc Ams||POP_MULTICALL
1112Closing bracket for a lightweight callback.
0eda4409 1113See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1114
1115=cut
1116*/
1117
1118#define dMULTICALL \
79503099 1119 OP *multicall_cop; \
35095fd0 1120 bool multicall_oldcatch
9850bf21 1121
82f35e8b 1122#define PUSH_MULTICALL(the_cv) \
b0065247 1123 PUSH_MULTICALL_FLAGS(the_cv, 0)
81ed78b2 1124
b0065247
DM
1125/* Like PUSH_MULTICALL, but allows you to specify extra flags
1126 * for the CX stack entry (this isn't part of the public API) */
81ed78b2 1127
b0065247 1128#define PUSH_MULTICALL_FLAGS(the_cv, flags) \
9850bf21 1129 STMT_START { \
79503099 1130 PERL_CONTEXT *cx; \
0bcc34c2
AL
1131 CV * const _nOnclAshIngNamE_ = the_cv; \
1132 CV * const cv = _nOnclAshIngNamE_; \
b70d5558 1133 PADLIST * const padlist = CvPADLIST(cv); \
9850bf21 1134 multicall_oldcatch = CATCH_GET; \
9850bf21 1135 CATCH_SET(TRUE); \
e1a10f35 1136 PUSHSTACKi(PERLSI_MULTICALL); \
1c23e2bd 1137 cx = cx_pushblock((CXt_SUB|CXp_MULTICALL|flags), (U8)gimme, \
fd9b7244 1138 PL_stack_sp, PL_savestack_ix); \
79503099 1139 cx_pushsub(cx, cv, NULL, 0); \
49f582ca 1140 SAVEOP(); \
b0065247
DM
1141 if (!(flags & CXp_SUB_RE_FAKE)) \
1142 CvDEPTH(cv)++; \
d2af2719 1143 if (CvDEPTH(cv) >= 2) \
9850bf21 1144 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
9850bf21
RH
1145 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
1146 multicall_cop = CvSTART(cv); \
1147 } STMT_END
1148
1149#define MULTICALL \
1150 STMT_START { \
1151 PL_op = multicall_cop; \
1152 CALLRUNOPS(aTHX); \
1153 } STMT_END
1154
1155#define POP_MULTICALL \
1156 STMT_START { \
79503099 1157 PERL_CONTEXT *cx; \
4ebe6e95 1158 cx = CX_CUR(); \
dfe0f39b 1159 CX_LEAVE_SCOPE(cx); \
a73d8813 1160 cx_popsub_common(cx); \
4df352a8 1161 gimme = cx->blk_gimme; \
7e27c4a5 1162 PERL_UNUSED_VAR(gimme); /* for API */ \
ed8ff0f3 1163 cx_popblock(cx); \
5da525e9 1164 CX_POP(cx); \
1bbbfc50 1165 POPSTACK; \
9850bf21 1166 CATCH_SET(multicall_oldcatch); \
1bbbfc50 1167 SPAGAIN; \
9850bf21 1168 } STMT_END
b3ca2e83 1169
81ed78b2
DM
1170/* Change the CV of an already-pushed MULTICALL CxSUB block.
1171 * (this isn't part of the public API) */
1172
b0065247 1173#define CHANGE_MULTICALL_FLAGS(the_cv, flags) \
81ed78b2
DM
1174 STMT_START { \
1175 CV * const _nOnclAshIngNamE_ = the_cv; \
1176 CV * const cv = _nOnclAshIngNamE_; \
b70d5558 1177 PADLIST * const padlist = CvPADLIST(cv); \
79503099 1178 PERL_CONTEXT *cx = CX_CUR(); \
79646418 1179 assert(CxMULTICALL(cx)); \
a73d8813 1180 cx_popsub_common(cx); \
b0065247 1181 cx->cx_type = (CXt_SUB|CXp_MULTICALL|flags); \
79503099 1182 cx_pushsub(cx, cv, NULL, 0); \
b0065247
DM
1183 if (!(flags & CXp_SUB_RE_FAKE)) \
1184 CvDEPTH(cv)++; \
d2af2719 1185 if (CvDEPTH(cv) >= 2) \
81ed78b2 1186 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
81ed78b2 1187 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
81ed78b2
DM
1188 multicall_cop = CvSTART(cv); \
1189 } STMT_END
b3ca2e83 1190/*
14d04a33 1191 * ex: set ts=8 sts=4 sw=4 et:
b3ca2e83 1192 */