allow "." in directory name
[perl.git] / cop.h
1 /*    cop.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
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  *
9  * Control ops (cops) are one of the two ops OP_NEXTSTATE and OP_DBSTATE,
10  * that (loosely speaking) are separate statements.
11  * They hold information important for lexical state and error reporting.
12  * At run time, PL_curcop is set to point to the most recently executed cop,
13  * and thus can be used to determine our current state.
14  */
15
16 /* A jmpenv packages the state required to perform a proper non-local jump.
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.
20  *
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
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
32 struct 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
39 typedef 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  *
95  * http://perl5.git.perl.org/perl.git/commit/312caa8e97f1c7ee342a9895c2f0e749625b4929
96  * http://perl5.git.perl.org/perl.git/commit/14dd3ad8c9bf82cf09798a22cc89a9862dfd6d1a                                        
97  *  
98  */
99
100 #define dJMPENV         JMPENV cur_env
101
102 #define JMPENV_PUSH(v) \
103     STMT_START {                                                        \
104         DEBUG_l({                                                       \
105             int i = 0; JMPENV *p = PL_top_env;                          \
106             while (p) { i++; p = p->je_prev; }                          \
107             Perl_deb(aTHX_ "JUMPENV_PUSH level=%d at %s:%d\n",          \
108                          i,  __FILE__, __LINE__);})                     \
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 {                                                        \
120         DEBUG_l({                                                       \
121             int i = -1; JMPENV *p = PL_top_env;                         \
122             while (p) { i++; p = p->je_prev; }                          \
123             Perl_deb(aTHX_ "JUMPENV_POP level=%d at %s:%d\n",           \
124                          i, __FILE__, __LINE__);})                      \
125         assert(PL_top_env == &cur_env);                                 \
126         PL_top_env = cur_env.je_prev;                                   \
127     } STMT_END
128
129 #define JMPENV_JUMP(v) \
130     STMT_START {                                                \
131         DEBUG_l({                                               \
132             int i = -1; JMPENV *p = PL_top_env;                 \
133             while (p) { i++; p = p->je_prev; }                  \
134             Perl_deb(aTHX_ "JUMPENV_JUMP(%d) level=%d at %s:%d\n", \
135                          (int)v, i, __FILE__, __LINE__);})      \
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)                                           \
140             PerlProc_exit(STATUS_EXIT);                         \
141         PerlIO_printf(PerlIO_stderr(), "panic: top_env, v=%d\n", (int)v); \
142         PerlProc_exit(1);                                       \
143     } STMT_END
144
145 #define CATCH_GET               (PL_top_env->je_mustcatch)
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
155
156 /*
157 =head1 COP Hint Hashes
158 */
159
160 typedef struct refcounted_he COPHH;
161
162 #define COPHH_KEY_UTF8 REFCOUNTED_HE_KEY_UTF8
163
164 /*
165 =for apidoc Amx|SV *|cophh_fetch_pvn|const COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|U32 flags
166
167 Look up the entry in the cop hints hash I<cophh> with the key specified by
168 I<keypv> and I<keylen>.  If I<flags> has the C<COPHH_KEY_UTF8> bit set,
169 the key octets are interpreted as UTF-8, otherwise they are interpreted
170 as Latin-1.  I<hash> is a precomputed hash of the key string, or zero if
171 it has not been precomputed.  Returns a mortal scalar copy of the value
172 associated with the key, or C<&PL_sv_placeholder> if there is no value
173 associated 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 /*
182 =for apidoc Amx|SV *|cophh_fetch_pvs|const COPHH *cophh|const char *key|U32 flags
183
184 Like L</cophh_fetch_pvn>, but takes a literal string instead of a
185 string/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 /*
194 =for apidoc Amx|SV *|cophh_fetch_pv|const COPHH *cophh|const char *key|U32 hash|U32 flags
195
196 Like L</cophh_fetch_pvn>, but takes a nul-terminated string instead of
197 a 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 /*
206 =for apidoc Amx|SV *|cophh_fetch_sv|const COPHH *cophh|SV *key|U32 hash|U32 flags
207
208 Like L</cophh_fetch_pvn>, but takes a Perl scalar instead of a
209 string/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 /*
218 =for apidoc Amx|HV *|cophh_2hv|const COPHH *cophh|U32 flags
219
220 Generates and returns a standard Perl hash representing the full set of
221 key/value pairs in the cop hints hash I<cophh>.  I<flags> is currently
222 unused 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 /*
231 =for apidoc Amx|COPHH *|cophh_copy|COPHH *cophh
232
233 Make 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 /*
241 =for apidoc Amx|void|cophh_free|COPHH *cophh
242
243 Discard the cop hints hash I<cophh>, freeing all resources associated
244 with it.
245
246 =cut
247 */
248
249 #define cophh_free(cophh) Perl_refcounted_he_free(aTHX_ cophh)
250
251 /*
252 =for apidoc Amx|COPHH *|cophh_new_empty
253
254 Generate and return a fresh cop hints hash containing no entries.
255
256 =cut
257 */
258
259 #define cophh_new_empty() ((COPHH *)NULL)
260
261 /*
262 =for apidoc Amx|COPHH *|cophh_store_pvn|COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|SV *value|U32 flags
263
264 Stores a value, associated with a key, in the cop hints hash I<cophh>,
265 and returns the modified hash.  The returned hash pointer is in general
266 not the same as the hash pointer that was passed in.  The input hash is
267 consumed by the function, and the pointer to it must not be subsequently
268 used.  Use L</cophh_copy> if you need both hashes.
269
270 The key is specified by I<keypv> and I<keylen>.  If I<flags> has the
271 C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8,
272 otherwise they are interpreted as Latin-1.  I<hash> is a precomputed
273 hash of the key string, or zero if it has not been precomputed.
274
275 I<value> is the scalar value to store for this key.  I<value> is copied
276 by this function, which thus does not take ownership of any reference
277 to it, and later changes to the scalar will not be reflected in the
278 value visible in the cop hints hash.  Complex types of scalar will not
279 be 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 /*
288 =for apidoc Amx|COPHH *|cophh_store_pvs|const COPHH *cophh|const char *key|SV *value|U32 flags
289
290 Like L</cophh_store_pvn>, but takes a literal string instead of a
291 string/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 /*
300 =for apidoc Amx|COPHH *|cophh_store_pv|const COPHH *cophh|const char *key|U32 hash|SV *value|U32 flags
301
302 Like L</cophh_store_pvn>, but takes a nul-terminated string instead of
303 a 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 /*
312 =for apidoc Amx|COPHH *|cophh_store_sv|const COPHH *cophh|SV *key|U32 hash|SV *value|U32 flags
313
314 Like L</cophh_store_pvn>, but takes a Perl scalar instead of a
315 string/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 /*
324 =for apidoc Amx|COPHH *|cophh_delete_pvn|COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|U32 flags
325
326 Delete a key and its associated value from the cop hints hash I<cophh>,
327 and returns the modified hash.  The returned hash pointer is in general
328 not the same as the hash pointer that was passed in.  The input hash is
329 consumed by the function, and the pointer to it must not be subsequently
330 used.  Use L</cophh_copy> if you need both hashes.
331
332 The key is specified by I<keypv> and I<keylen>.  If I<flags> has the
333 C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8,
334 otherwise they are interpreted as Latin-1.  I<hash> is a precomputed
335 hash 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 /*
345 =for apidoc Amx|COPHH *|cophh_delete_pvs|const COPHH *cophh|const char *key|U32 flags
346
347 Like L</cophh_delete_pvn>, but takes a literal string instead of a
348 string/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 /*
358 =for apidoc Amx|COPHH *|cophh_delete_pv|const COPHH *cophh|const char *key|U32 hash|U32 flags
359
360 Like L</cophh_delete_pvn>, but takes a nul-terminated string instead of
361 a 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 /*
370 =for apidoc Amx|COPHH *|cophh_delete_sv|const COPHH *cophh|SV *key|U32 hash|U32 flags
371
372 Like L</cophh_delete_pvn>, but takes a Perl scalar instead of a
373 string/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)
380
381 #include "mydtrace.h"
382
383 struct cop {
384     BASEOP
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 */
388     /* label for this construct is now stored in cop_hints_hash */
389 #ifdef USE_ITHREADS
390     char *      cop_stashpv;    /* package line was compiled in */
391     char *      cop_file;       /* file name the following line # is from */
392     U32         cop_stashflags; /* currently only SVf_UTF8 */
393 #else
394     HV *        cop_stash;      /* package line was compiled in */
395     GV *        cop_filegv;     /* file the following line # is from */
396 #endif
397     U32         cop_hints;      /* hints bits from pragmata */
398     U32         cop_seq;        /* parse sequence number */
399     /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *:  */
400     STRLEN *    cop_warnings;   /* lexical warnings bitmask */
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.  */
403     COPHH *     cop_hints_hash;
404 };
405
406 #ifdef USE_ITHREADS
407 #  define CopFILE(c)            ((c)->cop_file)
408 #  define CopFILEGV(c)          (CopFILE(c) \
409                                  ? gv_fetchfile(CopFILE(c)) : NULL)
410                                  
411 #  ifdef NETWARE
412 #    define CopFILE_set(c,pv)   ((c)->cop_file = savepv(pv))
413 #    define CopFILE_setn(c,pv,l)  ((c)->cop_file = savepv((pv),(l)))
414 #  else
415 #    define CopFILE_set(c,pv)   ((c)->cop_file = savesharedpv(pv))
416 #    define CopFILE_setn(c,pv,l)  ((c)->cop_file = savesharedpvn((pv),(l)))
417 #  endif
418
419 #  define CopFILESV(c)          (CopFILE(c) \
420                                  ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
421 #  define CopFILEAV(c)          (CopFILE(c) \
422                                  ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
423 #  ifdef DEBUGGING
424 #    define CopFILEAVx(c)       (assert(CopFILE(c)), \
425                                    GvAV(gv_fetchfile(CopFILE(c))))
426 #  else
427 #    define CopFILEAVx(c)       (GvAV(gv_fetchfile(CopFILE(c))))
428 #  endif
429 #  define CopSTASHPV(c)         ((c)->cop_stashpv)
430
431 #  ifdef NETWARE
432 #    define CopSTASHPV_set(c,pv)        ((c)->cop_stashpv = ((pv) ? savepv(pv) : NULL))
433 #  else
434 #    define CopSTASHPV_set(c,pv)        ((c)->cop_stashpv = savesharedpv(pv))
435 #  endif
436
437 #  define CopSTASH_flags(c)            ((c)->cop_stashflags)
438 #  define CopSTASH_flags_set(c,flags)  ((c)->cop_stashflags = flags)
439
440 #  define CopSTASH(c)          (CopSTASHPV(c)                                 \
441                                 ? gv_stashpv(CopSTASHPV(c),                   \
442                                             GV_ADD|(CopSTASH_flags(c)          \
443                                                     ? CopSTASH_flags(c): 0 )) \
444                                  : NULL)
445 #  define CopSTASH_set(c,hv)   (CopSTASHPV_set(c, (hv) ? HvNAME_get(hv) : NULL), \
446                                 CopSTASH_flags_set(c,                            \
447                                             ((hv) && HvNAME_HEK(hv) &&              \
448                                                      HvNAMEUTF8(hv))                \
449                                                 ? SVf_UTF8                          \
450                                                 : 0))
451 #  define CopSTASH_eq(c,hv)     ((hv) && stashpv_hvname_match(c,hv))
452 #  ifdef NETWARE
453 #    define CopSTASH_free(c) SAVECOPSTASH_FREE(c)
454 #    define CopFILE_free(c) SAVECOPFILE_FREE(c)
455 #  else
456 #    define CopSTASH_free(c)    PerlMemShared_free(CopSTASHPV(c))
457 #    define CopFILE_free(c)     (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
458 #  endif
459 #else
460 #  define CopFILEGV(c)          ((c)->cop_filegv)
461 #  define CopFILEGV_set(c,gv)   ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
462 #  define CopFILE_set(c,pv)     CopFILEGV_set((c), gv_fetchfile(pv))
463 #  define CopFILE_setn(c,pv,l)  CopFILEGV_set((c), gv_fetchfile_flags((pv),(l),0))
464 #  define CopFILESV(c)          (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
465 #  define CopFILEAV(c)          (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
466 #  ifdef DEBUGGING
467 #    define CopFILEAVx(c)       (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
468 #  else
469 #    define CopFILEAVx(c)       (GvAV(CopFILEGV(c)))
470 # endif
471 #  define CopFILE(c)            (CopFILEGV(c) && GvSV(CopFILEGV(c)) \
472                                     ? SvPVX(GvSV(CopFILEGV(c))) : NULL)
473 #  define CopSTASH(c)           ((c)->cop_stash)
474 #  define CopSTASH_set(c,hv)    ((c)->cop_stash = (hv))
475 #  define CopSTASHPV(c)         (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
476    /* cop_stash is not refcounted */
477 #  define CopSTASHPV_set(c,pv)  CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
478 #  define CopSTASH_eq(c,hv)     (CopSTASH(c) == (hv))
479 #  define CopSTASH_free(c)      
480 #  define CopFILE_free(c)       (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
481
482 #endif /* USE_ITHREADS */
483
484 #define CopHINTHASH_get(c)      ((COPHH*)((c)->cop_hints_hash))
485 #define CopHINTHASH_set(c,h)    ((c)->cop_hints_hash = (h))
486
487 /*
488 =head1 COP Hint Reading
489 */
490
491 /*
492 =for apidoc Am|SV *|cop_hints_fetch_pvn|const COP *cop|const char *keypv|STRLEN keylen|U32 hash|U32 flags
493
494 Look up the hint entry in the cop I<cop> with the key specified by
495 I<keypv> and I<keylen>.  If I<flags> has the C<COPHH_KEY_UTF8> bit set,
496 the key octets are interpreted as UTF-8, otherwise they are interpreted
497 as Latin-1.  I<hash> is a precomputed hash of the key string, or zero if
498 it has not been precomputed.  Returns a mortal scalar copy of the value
499 associated with the key, or C<&PL_sv_placeholder> if there is no value
500 associated with the key.
501
502 =cut
503 */
504
505 #define cop_hints_fetch_pvn(cop, keypv, keylen, hash, flags) \
506     cophh_fetch_pvn(CopHINTHASH_get(cop), keypv, keylen, hash, flags)
507
508 /*
509 =for apidoc Am|SV *|cop_hints_fetch_pvs|const COP *cop|const char *key|U32 flags
510
511 Like L</cop_hints_fetch_pvn>, but takes a literal string instead of a
512 string/length pair, and no precomputed hash.
513
514 =cut
515 */
516
517 #define cop_hints_fetch_pvs(cop, key, flags) \
518     cophh_fetch_pvs(CopHINTHASH_get(cop), key, flags)
519
520 /*
521 =for apidoc Am|SV *|cop_hints_fetch_pv|const COP *cop|const char *key|U32 hash|U32 flags
522
523 Like L</cop_hints_fetch_pvn>, but takes a nul-terminated string instead
524 of a string/length pair.
525
526 =cut
527 */
528
529 #define cop_hints_fetch_pv(cop, key, hash, flags) \
530     cophh_fetch_pv(CopHINTHASH_get(cop), key, hash, flags)
531
532 /*
533 =for apidoc Am|SV *|cop_hints_fetch_sv|const COP *cop|SV *key|U32 hash|U32 flags
534
535 Like L</cop_hints_fetch_pvn>, but takes a Perl scalar instead of a
536 string/length pair.
537
538 =cut
539 */
540
541 #define cop_hints_fetch_sv(cop, key, hash, flags) \
542     cophh_fetch_sv(CopHINTHASH_get(cop), key, hash, flags)
543
544 /*
545 =for apidoc Am|HV *|cop_hints_2hv|const COP *cop|U32 flags
546
547 Generates and returns a standard Perl hash representing the full set of
548 hint entries in the cop I<cop>.  I<flags> is currently unused and must
549 be zero.
550
551 =cut
552 */
553
554 #define cop_hints_2hv(cop, flags) \
555     cophh_2hv(CopHINTHASH_get(cop), flags)
556
557 #define CopLABEL(c)  Perl_cop_fetch_label(aTHX_ (c), NULL, NULL)
558 #define CopLABEL_len(c,len)  Perl_cop_fetch_label(aTHX_ (c), len, NULL)
559 #define CopLABEL_len_flags(c,len,flags)  Perl_cop_fetch_label(aTHX_ (c), len, flags)
560 #define CopLABEL_alloc(pv)      ((pv)?savepv(pv):NULL)
561
562 #define CopSTASH_ne(c,hv)       (!CopSTASH_eq(c,hv))
563 #define CopLINE(c)              ((c)->cop_line)
564 #define CopLINE_inc(c)          (++CopLINE(c))
565 #define CopLINE_dec(c)          (--CopLINE(c))
566 #define CopLINE_set(c,l)        (CopLINE(c) = (l))
567
568 /* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
569 #define OutCopFILE(c) CopFILE(c)
570
571 /* FIXME NATIVE_HINTS if this is changed from op_private (see perl.h)  */
572 #define CopHINTS_get(c)         ((c)->cop_hints + 0)
573 #define CopHINTS_set(c, h)      STMT_START {                            \
574                                     (c)->cop_hints = (h);               \
575                                 } STMT_END
576
577 /*
578  * Here we have some enormously heavy (or at least ponderous) wizardry.
579  */
580
581 /* subroutine context */
582 struct block_sub {
583     OP *        retop;  /* op to execute on exit from sub */
584     /* Above here is the same for sub, format and eval.  */
585     CV *        cv;
586     /* Above here is the same for sub and format.  */
587     AV *        savearray;
588     AV *        argarray;
589     I32         olddepth;
590     PAD         *oldcomppad;
591 };
592
593
594 /* format context */
595 struct block_format {
596     OP *        retop;  /* op to execute on exit from sub */
597     /* Above here is the same for sub, format and eval.  */
598     CV *        cv;
599     /* Above here is the same for sub and format.  */
600     GV *        gv;
601     GV *        dfoutgv;
602 };
603
604 /* base for the next two macros. Don't use directly.
605  * Note that the refcnt of the cv is incremented twice;  The CX one is
606  * decremented by LEAVESUB, the other by LEAVE. */
607
608 #define PUSHSUB_BASE(cx)                                                \
609         ENTRY_PROBE(GvENAME(CvGV(cv)),                                  \
610                 CopFILE((const COP *)CvSTART(cv)),                      \
611                 CopLINE((const COP *)CvSTART(cv)),                      \
612                 CopSTASHPV((const COP *)CvSTART(cv)));                  \
613                                                                         \
614         cx->blk_sub.cv = cv;                                            \
615         cx->blk_sub.olddepth = CvDEPTH(cv);                             \
616         cx->cx_type |= (hasargs) ? CXp_HASARGS : 0;                     \
617         cx->blk_sub.retop = NULL;                                       \
618         if (!CvDEPTH(cv)) {                                             \
619             SvREFCNT_inc_simple_void_NN(cv);                            \
620             SvREFCNT_inc_simple_void_NN(cv);                            \
621             SAVEFREESV(cv);                                             \
622         }
623
624
625 #define PUSHSUB(cx)                                                     \
626     {                                                                   \
627         /* If the context is indeterminate, then only the lvalue */     \
628         /* flags that the caller also has are applicable.        */     \
629         U8 phlags =                                                     \
630            (PL_op->op_flags & OPf_WANT)                                 \
631                ? OPpENTERSUB_LVAL_MASK                                  \
632                : !(PL_op->op_private & OPpENTERSUB_LVAL_MASK)           \
633                    ? 0 : Perl_was_lvalue_sub(aTHX);                     \
634         PUSHSUB_BASE(cx)                                                \
635         cx->blk_u16 = PL_op->op_private &                               \
636                           (phlags|OPpDEREF);                            \
637     }
638
639 /* variant for use by OP_DBSTATE, where op_private holds hint bits */
640 #define PUSHSUB_DB(cx)                                                  \
641         PUSHSUB_BASE(cx)                                                \
642         cx->blk_u16 = 0;
643
644
645 #define PUSHFORMAT(cx, retop)                                           \
646         cx->blk_format.cv = cv;                                         \
647         cx->blk_format.gv = gv;                                         \
648         cx->blk_format.retop = (retop);                                 \
649         cx->blk_format.dfoutgv = PL_defoutgv;                           \
650         SvREFCNT_inc_void(cx->blk_format.dfoutgv)
651
652 #define POP_SAVEARRAY()                                         \
653     STMT_START {                                                        \
654         SvREFCNT_dec(GvAV(PL_defgv));                                   \
655         GvAV(PL_defgv) = cx->blk_sub.savearray;                         \
656     } STMT_END
657
658 /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
659  * leave any (a fast av_clear(ary), basically) */
660 #define CLEAR_ARGARRAY(ary) \
661     STMT_START {                                                        \
662         AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary);                      \
663         AvARRAY(ary) = AvALLOC(ary);                                    \
664         AvFILLp(ary) = -1;                                              \
665     } STMT_END
666
667 #define POPSUB(cx,sv)                                                   \
668     STMT_START {                                                        \
669         RETURN_PROBE(GvENAME(CvGV((const CV*)cx->blk_sub.cv)),          \
670                 CopFILE((COP*)CvSTART((const CV*)cx->blk_sub.cv)),      \
671                 CopLINE((COP*)CvSTART((const CV*)cx->blk_sub.cv)),      \
672                 CopSTASHPV((COP*)CvSTART((const CV*)cx->blk_sub.cv)));  \
673                                                                         \
674         if (CxHASARGS(cx)) {                                            \
675             POP_SAVEARRAY();                                            \
676             /* abandon @_ if it got reified */                          \
677             if (AvREAL(cx->blk_sub.argarray)) {                         \
678                 const SSize_t fill = AvFILLp(cx->blk_sub.argarray);     \
679                 SvREFCNT_dec(cx->blk_sub.argarray);                     \
680                 cx->blk_sub.argarray = newAV();                         \
681                 av_extend(cx->blk_sub.argarray, fill);                  \
682                 AvREIFY_only(cx->blk_sub.argarray);                     \
683                 CX_CURPAD_SV(cx->blk_sub, 0) = MUTABLE_SV(cx->blk_sub.argarray); \
684             }                                                           \
685             else {                                                      \
686                 CLEAR_ARGARRAY(cx->blk_sub.argarray);                   \
687             }                                                           \
688         }                                                               \
689         sv = MUTABLE_SV(cx->blk_sub.cv);                                \
690         if (sv && (CvDEPTH((const CV*)sv) = cx->blk_sub.olddepth))      \
691             sv = NULL;                                          \
692     } STMT_END
693
694 #define LEAVESUB(sv)                                                    \
695     STMT_START {                                                        \
696         if (sv)                                                         \
697             SvREFCNT_dec(sv);                                           \
698     } STMT_END
699
700 #define POPFORMAT(cx)                                                   \
701         setdefout(cx->blk_format.dfoutgv);                              \
702         SvREFCNT_dec(cx->blk_format.dfoutgv);
703
704 /* eval context */
705 struct block_eval {
706     OP *        retop;  /* op to execute on exit from eval */
707     /* Above here is the same for sub, format and eval.  */
708     SV *        old_namesv;
709     OP *        old_eval_root;
710     SV *        cur_text;
711     CV *        cv;
712     JMPENV *    cur_top_env; /* value of PL_top_env when eval CX created */
713 };
714
715 /* If we ever need more than 512 op types, change the shift from 7.
716    blku_gimme is actually also only 2 bits, so could be merged with something.
717 */
718
719 #define CxOLD_IN_EVAL(cx)       (((cx)->blk_u16) & 0x7F)
720 #define CxOLD_OP_TYPE(cx)       (((cx)->blk_u16) >> 7)
721
722 #define PUSHEVAL(cx,n)                                                  \
723     STMT_START {                                                        \
724         assert(!(PL_in_eval & ~0x7F));                                  \
725         assert(!(PL_op->op_type & ~0x1FF));                             \
726         cx->blk_u16 = (PL_in_eval & 0x7F) | ((U16)PL_op->op_type << 7); \
727         cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL);            \
728         cx->blk_eval.old_eval_root = PL_eval_root;                      \
729         cx->blk_eval.cur_text = PL_parser ? PL_parser->linestr : NULL;  \
730         cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */    \
731         cx->blk_eval.retop = NULL;                                      \
732         cx->blk_eval.cur_top_env = PL_top_env;                          \
733     } STMT_END
734
735 #define POPEVAL(cx)                                                     \
736     STMT_START {                                                        \
737         PL_in_eval = CxOLD_IN_EVAL(cx);                                 \
738         optype = CxOLD_OP_TYPE(cx);                                     \
739         PL_eval_root = cx->blk_eval.old_eval_root;                      \
740         if (cx->blk_eval.old_namesv)                                    \
741             sv_2mortal(cx->blk_eval.old_namesv);                        \
742     } STMT_END
743
744 /* loop context */
745 struct block_loop {
746     I32         resetsp;
747     LOOP *      my_op;  /* My op, that contains redo, next and last ops.  */
748     union {     /* different ways of locating the iteration variable */
749         SV      **svp;
750         GV      *gv;
751         PAD     *oldcomppad; /* only used in ITHREADS */
752     } itervar_u;
753     union {
754         struct { /* valid if type is LOOP_FOR or LOOP_PLAIN (but {NULL,0})*/
755             AV * ary; /* use the stack if this is NULL */
756             IV ix;
757         } ary;
758         struct { /* valid if type is LOOP_LAZYIV */
759             IV cur;
760             IV end;
761         } lazyiv;
762         struct { /* valid if type if LOOP_LAZYSV */
763             SV * cur;
764             SV * end; /* maxiumum value (or minimum in reverse) */
765         } lazysv;
766     } state_u;
767 };
768
769 #ifdef USE_ITHREADS
770 #  define CxITERVAR_PADSV(c) \
771         &CX_CURPAD_SV( (c)->blk_loop.itervar_u, (c)->blk_loop.my_op->op_targ)
772 #else
773 #  define CxITERVAR_PADSV(c) ((c)->blk_loop.itervar_u.svp)
774 #endif
775
776 #define CxITERVAR(c)                                                    \
777         ((c)->blk_loop.itervar_u.oldcomppad                             \
778          ? (CxPADLOOP(c)                                                \
779             ? CxITERVAR_PADSV(c)                                        \
780             : &GvSV((c)->blk_loop.itervar_u.gv))                        \
781          : (SV**)NULL)
782
783 #define CxLABEL(c)      (0 + CopLABEL((c)->blk_oldcop))
784 #define CxLABEL_len(c,len)      (0 + CopLABEL_len((c)->blk_oldcop, len))
785 #define CxLABEL_len_flags(c,len,flags)  (0 + CopLABEL_len_flags((c)->blk_oldcop, len, flags))
786 #define CxHASARGS(c)    (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
787 #define CxLVAL(c)       (0 + (c)->blk_u16)
788
789 #define PUSHLOOP_PLAIN(cx, s)                                           \
790         cx->blk_loop.resetsp = s - PL_stack_base;                       \
791         cx->blk_loop.my_op = cLOOP;                                     \
792         cx->blk_loop.state_u.ary.ary = NULL;                            \
793         cx->blk_loop.state_u.ary.ix = 0;                                \
794         cx->blk_loop.itervar_u.svp = NULL;
795
796 #define PUSHLOOP_FOR(cx, ivar, s)                                       \
797         cx->blk_loop.resetsp = s - PL_stack_base;                       \
798         cx->blk_loop.my_op = cLOOP;                                     \
799         cx->blk_loop.state_u.ary.ary = NULL;                            \
800         cx->blk_loop.state_u.ary.ix = 0;                                \
801         cx->blk_loop.itervar_u.svp = (SV**)(ivar);
802
803 #define POPLOOP(cx)                                                     \
804         if (CxTYPE(cx) == CXt_LOOP_LAZYSV) {                            \
805             SvREFCNT_dec(cx->blk_loop.state_u.lazysv.cur);              \
806             SvREFCNT_dec(cx->blk_loop.state_u.lazysv.end);              \
807         }                                                               \
808         if (CxTYPE(cx) == CXt_LOOP_FOR)                                 \
809             SvREFCNT_dec(cx->blk_loop.state_u.ary.ary);
810
811 /* given/when context */
812 struct block_givwhen {
813         OP *leave_op;
814 };
815
816 #define PUSHGIVEN(cx)                                                   \
817         cx->blk_givwhen.leave_op = cLOGOP->op_other;
818
819 #define PUSHWHEN PUSHGIVEN
820
821 /* context common to subroutines, evals and loops */
822 struct block {
823     U8          blku_type;      /* what kind of context this is */
824     U8          blku_gimme;     /* is this block running in list context? */
825     U16         blku_u16;       /* used by block_sub and block_eval (so far) */
826     I32         blku_oldsp;     /* stack pointer to copy stuff down to */
827     COP *       blku_oldcop;    /* old curcop pointer */
828     I32         blku_oldmarksp; /* mark stack index */
829     I32         blku_oldscopesp;        /* scope stack index */
830     PMOP *      blku_oldpm;     /* values of pattern match vars */
831
832     union {
833         struct block_sub        blku_sub;
834         struct block_format     blku_format;
835         struct block_eval       blku_eval;
836         struct block_loop       blku_loop;
837         struct block_givwhen    blku_givwhen;
838     } blk_u;
839 };
840 #define blk_oldsp       cx_u.cx_blk.blku_oldsp
841 #define blk_oldcop      cx_u.cx_blk.blku_oldcop
842 #define blk_oldmarksp   cx_u.cx_blk.blku_oldmarksp
843 #define blk_oldscopesp  cx_u.cx_blk.blku_oldscopesp
844 #define blk_oldpm       cx_u.cx_blk.blku_oldpm
845 #define blk_gimme       cx_u.cx_blk.blku_gimme
846 #define blk_u16         cx_u.cx_blk.blku_u16
847 #define blk_sub         cx_u.cx_blk.blk_u.blku_sub
848 #define blk_format      cx_u.cx_blk.blk_u.blku_format
849 #define blk_eval        cx_u.cx_blk.blk_u.blku_eval
850 #define blk_loop        cx_u.cx_blk.blk_u.blku_loop
851 #define blk_givwhen     cx_u.cx_blk.blk_u.blku_givwhen
852
853 #define DEBUG_CX(action)                                                \
854     DEBUG_l(                                                            \
855         Perl_deb(aTHX_ "CX %ld %s %s (scope %ld,%ld) at %s:%d\n",       \
856                     (long)cxstack_ix,                                   \
857                     action,                                             \
858                     PL_block_type[CxTYPE(&cxstack[cxstack_ix])],        \
859                     (long)PL_scopestack_ix,                             \
860                     (long)(cxstack[cxstack_ix].blk_oldscopesp),         \
861                     __FILE__, __LINE__));
862
863 /* Enter a block. */
864 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix],            \
865         cx->cx_type             = t,                                    \
866         cx->blk_oldsp           = sp - PL_stack_base,                   \
867         cx->blk_oldcop          = PL_curcop,                            \
868         cx->blk_oldmarksp       = PL_markstack_ptr - PL_markstack,      \
869         cx->blk_oldscopesp      = PL_scopestack_ix,                     \
870         cx->blk_oldpm           = PL_curpm,                             \
871         cx->blk_gimme           = (U8)gimme;                            \
872         DEBUG_CX("PUSH");
873
874 /* Exit a block (RETURN and LAST). */
875 #define POPBLOCK(cx,pm)                                                 \
876         DEBUG_CX("POP");                                                \
877         cx = &cxstack[cxstack_ix--],                                    \
878         newsp            = PL_stack_base + cx->blk_oldsp,               \
879         PL_curcop        = cx->blk_oldcop,                              \
880         PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
881         PL_scopestack_ix = cx->blk_oldscopesp,                          \
882         pm               = cx->blk_oldpm,                               \
883         gimme            = cx->blk_gimme;
884
885 /* Continue a block elsewhere (NEXT and REDO). */
886 #define TOPBLOCK(cx)                                                    \
887         DEBUG_CX("TOP");                                                \
888         cx  = &cxstack[cxstack_ix],                                     \
889         PL_stack_sp      = PL_stack_base + cx->blk_oldsp,               \
890         PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
891         PL_scopestack_ix = cx->blk_oldscopesp,                          \
892         PL_curpm         = cx->blk_oldpm;
893
894 /* substitution context */
895 struct subst {
896     U8          sbu_type;       /* what kind of context this is */
897     U8          sbu_rflags;
898     U16         sbu_rxtainted;  /* matches struct block */
899     I32         sbu_iters;
900     I32         sbu_maxiters;
901     I32         sbu_oldsave;
902     char *      sbu_orig;
903     SV *        sbu_dstr;
904     SV *        sbu_targ;
905     char *      sbu_s;
906     char *      sbu_m;
907     char *      sbu_strend;
908     void *      sbu_rxres;
909     REGEXP *    sbu_rx;
910 };
911 #define sb_iters        cx_u.cx_subst.sbu_iters
912 #define sb_maxiters     cx_u.cx_subst.sbu_maxiters
913 #define sb_rflags       cx_u.cx_subst.sbu_rflags
914 #define sb_oldsave      cx_u.cx_subst.sbu_oldsave
915 #define sb_rxtainted    cx_u.cx_subst.sbu_rxtainted
916 #define sb_orig         cx_u.cx_subst.sbu_orig
917 #define sb_dstr         cx_u.cx_subst.sbu_dstr
918 #define sb_targ         cx_u.cx_subst.sbu_targ
919 #define sb_s            cx_u.cx_subst.sbu_s
920 #define sb_m            cx_u.cx_subst.sbu_m
921 #define sb_strend       cx_u.cx_subst.sbu_strend
922 #define sb_rxres        cx_u.cx_subst.sbu_rxres
923 #define sb_rx           cx_u.cx_subst.sbu_rx
924
925 #ifdef PERL_CORE
926 #  define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix],               \
927         cx->sb_iters            = iters,                                \
928         cx->sb_maxiters         = maxiters,                             \
929         cx->sb_rflags           = r_flags,                              \
930         cx->sb_oldsave          = oldsave,                              \
931         cx->sb_rxtainted        = rxtainted,                            \
932         cx->sb_orig             = orig,                                 \
933         cx->sb_dstr             = dstr,                                 \
934         cx->sb_targ             = targ,                                 \
935         cx->sb_s                = s,                                    \
936         cx->sb_m                = m,                                    \
937         cx->sb_strend           = strend,                               \
938         cx->sb_rxres            = NULL,                                 \
939         cx->sb_rx               = rx,                                   \
940         cx->cx_type             = CXt_SUBST | (once ? CXp_ONCE : 0);    \
941         rxres_save(&cx->sb_rxres, rx);                                  \
942         (void)ReREFCNT_inc(rx)
943
944 #  define POPSUBST(cx) cx = &cxstack[cxstack_ix--];                     \
945         rxres_free(&cx->sb_rxres);                                      \
946         ReREFCNT_dec(cx->sb_rx)
947 #endif
948
949 #define CxONCE(cx)              ((cx)->cx_type & CXp_ONCE)
950
951 struct context {
952     union {
953         struct block    cx_blk;
954         struct subst    cx_subst;
955     } cx_u;
956 };
957 #define cx_type cx_u.cx_subst.sbu_type
958
959 /* If you re-order these, there is also an array of uppercase names in perl.h
960    and a static array of context names in pp_ctl.c  */
961 #define CXTYPEMASK      0xf
962 #define CXt_NULL        0
963 #define CXt_WHEN        1
964 #define CXt_BLOCK       2
965 /* When micro-optimising :-) keep GIVEN next to the LOOPs, as these 5 share a
966    jump table in pp_ctl.c
967    The first 4 don't have a 'case' in at least one switch statement in pp_ctl.c
968 */
969 #define CXt_GIVEN       3
970 /* This is first so that CXt_LOOP_FOR|CXt_LOOP_LAZYIV is CXt_LOOP_LAZYIV */
971 #define CXt_LOOP_FOR    4
972 #define CXt_LOOP_PLAIN  5
973 #define CXt_LOOP_LAZYSV 6
974 #define CXt_LOOP_LAZYIV 7
975 #define CXt_SUB         8
976 #define CXt_FORMAT      9
977 #define CXt_EVAL       10
978 #define CXt_SUBST      11
979 /* SUBST doesn't feature in all switch statements.  */
980
981 /* private flags for CXt_SUB and CXt_NULL
982    However, this is checked in many places which do not check the type, so
983    this bit needs to be kept clear for most everything else. For reasons I
984    haven't investigated, it can coexist with CXp_FOR_DEF */
985 #define CXp_MULTICALL   0x10    /* part of a multicall (so don't
986                                    tear down context on exit). */ 
987
988 /* private flags for CXt_SUB and CXt_FORMAT */
989 #define CXp_HASARGS     0x20
990
991 /* private flags for CXt_EVAL */
992 #define CXp_REAL        0x20    /* truly eval'', not a lookalike */
993 #define CXp_TRYBLOCK    0x40    /* eval{}, not eval'' or similar */
994
995 /* private flags for CXt_LOOP */
996 #define CXp_FOR_DEF     0x10    /* foreach using $_ */
997 #define CxPADLOOP(c)    ((c)->blk_loop.my_op->op_targ)
998
999 /* private flags for CXt_SUBST */
1000 #define CXp_ONCE        0x10    /* What was sbu_once in struct subst */
1001
1002 #define CxTYPE(c)       ((c)->cx_type & CXTYPEMASK)
1003 #define CxTYPE_is_LOOP(c)       (((c)->cx_type & 0xC) == 0x4)
1004 #define CxMULTICALL(c)  (((c)->cx_type & CXp_MULTICALL)                 \
1005                          == CXp_MULTICALL)
1006 #define CxREALEVAL(c)   (((c)->cx_type & (CXTYPEMASK|CXp_REAL))         \
1007                          == (CXt_EVAL|CXp_REAL))
1008 #define CxTRYBLOCK(c)   (((c)->cx_type & (CXTYPEMASK|CXp_TRYBLOCK))     \
1009                          == (CXt_EVAL|CXp_TRYBLOCK))
1010 #define CxFOREACH(c)    (CxTYPE_is_LOOP(c) && CxTYPE(c) != CXt_LOOP_PLAIN)
1011 #define CxFOREACHDEF(c) ((CxTYPE_is_LOOP(c) && CxTYPE(c) != CXt_LOOP_PLAIN) \
1012                          && ((c)->cx_type & CXp_FOR_DEF))
1013
1014 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
1015
1016 /* 
1017 =head1 "Gimme" Values
1018 */
1019
1020 /*
1021 =for apidoc AmU||G_SCALAR
1022 Used to indicate scalar context.  See C<GIMME_V>, C<GIMME>, and
1023 L<perlcall>.
1024
1025 =for apidoc AmU||G_ARRAY
1026 Used to indicate list context.  See C<GIMME_V>, C<GIMME> and
1027 L<perlcall>.
1028
1029 =for apidoc AmU||G_VOID
1030 Used to indicate void context.  See C<GIMME_V> and L<perlcall>.
1031
1032 =for apidoc AmU||G_DISCARD
1033 Indicates that arguments returned from a callback should be discarded.  See
1034 L<perlcall>.
1035
1036 =for apidoc AmU||G_EVAL
1037
1038 Used to force a Perl C<eval> wrapper around a callback.  See
1039 L<perlcall>.
1040
1041 =for apidoc AmU||G_NOARGS
1042
1043 Indicates that no arguments are being sent to a callback.  See
1044 L<perlcall>.
1045
1046 =cut
1047 */
1048
1049 #define G_SCALAR        2
1050 #define G_ARRAY         3
1051 #define G_VOID          1
1052 #define G_WANT          3
1053
1054 /* extra flags for Perl_call_* routines */
1055 #define G_DISCARD       4       /* Call FREETMPS.
1056                                    Don't change this without consulting the
1057                                    hash actions codes defined in hv.h */
1058 #define G_EVAL          8       /* Assume eval {} around subroutine call. */
1059 #define G_NOARGS       16       /* Don't construct a @_ array. */
1060 #define G_KEEPERR      32       /* Warn for errors, don't overwrite $@ */
1061 #define G_NODEBUG      64       /* Disable debugging at toplevel.  */
1062 #define G_METHOD      128       /* Calling method. */
1063 #define G_FAKINGEVAL  256       /* Faking an eval context for call_sv or
1064                                    fold_constants. */
1065 #define G_UNDEF_FILL  512       /* Fill the stack with &PL_sv_undef
1066                                    A special case for UNSHIFT in
1067                                    Perl_magic_methcall().  */
1068 #define G_WRITING_TO_STDERR 1024 /* Perl_write_to_stderr() is calling
1069                                     Perl_magic_methcall().  */
1070
1071 /* flag bits for PL_in_eval */
1072 #define EVAL_NULL       0       /* not in an eval */
1073 #define EVAL_INEVAL     1       /* some enclosing scope is an eval */
1074 #define EVAL_WARNONLY   2       /* used by yywarn() when calling yyerror() */
1075 #define EVAL_KEEPERR    4       /* set by Perl_call_sv if G_KEEPERR */
1076 #define EVAL_INREQUIRE  8       /* The code is being required. */
1077
1078 /* Support for switching (stack and block) contexts.
1079  * This ensures magic doesn't invalidate local stack and cx pointers.
1080  */
1081
1082 #define PERLSI_UNKNOWN          -1
1083 #define PERLSI_UNDEF            0
1084 #define PERLSI_MAIN             1
1085 #define PERLSI_MAGIC            2
1086 #define PERLSI_SORT             3
1087 #define PERLSI_SIGNAL           4
1088 #define PERLSI_OVERLOAD         5
1089 #define PERLSI_DESTROY          6
1090 #define PERLSI_WARNHOOK         7
1091 #define PERLSI_DIEHOOK          8
1092 #define PERLSI_REQUIRE          9
1093
1094 struct stackinfo {
1095     AV *                si_stack;       /* stack for current runlevel */
1096     PERL_CONTEXT *      si_cxstack;     /* context stack for runlevel */
1097     struct stackinfo *  si_prev;
1098     struct stackinfo *  si_next;
1099     I32                 si_cxix;        /* current context index */
1100     I32                 si_cxmax;       /* maximum allocated index */
1101     I32                 si_type;        /* type of runlevel */
1102     I32                 si_markoff;     /* offset where markstack begins for us.
1103                                          * currently used only with DEBUGGING,
1104                                          * but not #ifdef-ed for bincompat */
1105 };
1106
1107 typedef struct stackinfo PERL_SI;
1108
1109 #define cxstack         (PL_curstackinfo->si_cxstack)
1110 #define cxstack_ix      (PL_curstackinfo->si_cxix)
1111 #define cxstack_max     (PL_curstackinfo->si_cxmax)
1112
1113 #ifdef DEBUGGING
1114 #  define       SET_MARK_OFFSET \
1115     PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
1116 #else
1117 #  define       SET_MARK_OFFSET NOOP
1118 #endif
1119
1120 #define PUSHSTACKi(type) \
1121     STMT_START {                                                        \
1122         PERL_SI *next = PL_curstackinfo->si_next;                       \
1123         DEBUG_l({                                                       \
1124             int i = 0; PERL_SI *p = PL_curstackinfo;                    \
1125             while (p) { i++; p = p->si_prev; }                          \
1126             Perl_deb(aTHX_ "push STACKINFO %d at %s:%d\n",              \
1127                          i, __FILE__, __LINE__);})                      \
1128         if (!next) {                                                    \
1129             next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1);    \
1130             next->si_prev = PL_curstackinfo;                            \
1131             PL_curstackinfo->si_next = next;                            \
1132         }                                                               \
1133         next->si_type = type;                                           \
1134         next->si_cxix = -1;                                             \
1135         AvFILLp(next->si_stack) = 0;                                    \
1136         SWITCHSTACK(PL_curstack,next->si_stack);                        \
1137         PL_curstackinfo = next;                                         \
1138         SET_MARK_OFFSET;                                                \
1139     } STMT_END
1140
1141 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
1142
1143 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
1144  * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
1145 #define POPSTACK \
1146     STMT_START {                                                        \
1147         dSP;                                                            \
1148         PERL_SI * const prev = PL_curstackinfo->si_prev;                \
1149         DEBUG_l({                                                       \
1150             int i = -1; PERL_SI *p = PL_curstackinfo;                   \
1151             while (p) { i++; p = p->si_prev; }                          \
1152             Perl_deb(aTHX_ "pop  STACKINFO %d at %s:%d\n",              \
1153                          i, __FILE__, __LINE__);})                      \
1154         if (!prev) {                                                    \
1155             PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");         \
1156             my_exit(1);                                                 \
1157         }                                                               \
1158         SWITCHSTACK(PL_curstack,prev->si_stack);                        \
1159         /* don't free prev here, free them all at the END{} */          \
1160         PL_curstackinfo = prev;                                         \
1161     } STMT_END
1162
1163 #define POPSTACK_TO(s) \
1164     STMT_START {                                                        \
1165         while (PL_curstack != s) {                                      \
1166             dounwind(-1);                                               \
1167             POPSTACK;                                                   \
1168         }                                                               \
1169     } STMT_END
1170
1171 #define IN_PERL_COMPILETIME     (PL_curcop == &PL_compiling)
1172 #define IN_PERL_RUNTIME         (PL_curcop != &PL_compiling)
1173
1174 /*
1175 =head1 Multicall Functions
1176
1177 =for apidoc Ams||dMULTICALL
1178 Declare local variables for a multicall. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1179
1180 =for apidoc Ams||PUSH_MULTICALL
1181 Opening bracket for a lightweight callback.
1182 See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1183
1184 =for apidoc Ams||MULTICALL
1185 Make a lightweight callback. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1186
1187 =for apidoc Ams||POP_MULTICALL
1188 Closing bracket for a lightweight callback.
1189 See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1190
1191 =cut
1192 */
1193
1194 #define dMULTICALL \
1195     SV **newsp;                 /* set by POPBLOCK */                   \
1196     PERL_CONTEXT *cx;                                                   \
1197     CV *multicall_cv;                                                   \
1198     OP *multicall_cop;                                                  \
1199     bool multicall_oldcatch;                                            \
1200     U8 hasargs = 0              /* used by PUSHSUB */
1201
1202 #define PUSH_MULTICALL(the_cv) \
1203     STMT_START {                                                        \
1204         CV * const _nOnclAshIngNamE_ = the_cv;                          \
1205         CV * const cv = _nOnclAshIngNamE_;                              \
1206         AV * const padlist = CvPADLIST(cv);                             \
1207         ENTER;                                                          \
1208         multicall_oldcatch = CATCH_GET;                                 \
1209         SAVETMPS; SAVEVPTR(PL_op);                                      \
1210         CATCH_SET(TRUE);                                                \
1211         PUSHSTACKi(PERLSI_SORT);                                        \
1212         PUSHBLOCK(cx, CXt_SUB|CXp_MULTICALL, PL_stack_sp);              \
1213         PUSHSUB(cx);                                                    \
1214         if (++CvDEPTH(cv) >= 2) {                                       \
1215             PERL_STACK_OVERFLOW_CHECK();                                \
1216             Perl_pad_push(aTHX_ padlist, CvDEPTH(cv));                  \
1217         }                                                               \
1218         SAVECOMPPAD();                                                  \
1219         PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv));                       \
1220         multicall_cv = cv;                                              \
1221         multicall_cop = CvSTART(cv);                                    \
1222     } STMT_END
1223
1224 #define MULTICALL \
1225     STMT_START {                                                        \
1226         PL_op = multicall_cop;                                          \
1227         CALLRUNOPS(aTHX);                                               \
1228     } STMT_END
1229
1230 #define POP_MULTICALL \
1231     STMT_START {                                                        \
1232         if (! --CvDEPTH(multicall_cv))                                  \
1233             LEAVESUB(multicall_cv);                                     \
1234         POPBLOCK(cx,PL_curpm);                                          \
1235         POPSTACK;                                                       \
1236         CATCH_SET(multicall_oldcatch);                                  \
1237         LEAVE;                                                          \
1238         SPAGAIN;                                                        \
1239     } STMT_END
1240
1241 /*
1242  * Local variables:
1243  * c-indentation-style: bsd
1244  * c-basic-offset: 4
1245  * indent-tabs-mode: t
1246  * End:
1247  *
1248  * ex: set ts=8 sts=4 sw=4 noet:
1249  */