Fix context propagation below return()
[perl.git] / op.h
1 /*    op.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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  */
10
11 /*
12  * The fields of BASEOP are:
13  *      op_next         Pointer to next ppcode to execute after this one.
14  *                      (Top level pre-grafted op points to first op,
15  *                      but this is replaced when op is grafted in, when
16  *                      this op will point to the real next op, and the new
17  *                      parent takes over role of remembering starting op.)
18  *      op_ppaddr       Pointer to current ppcode's function.
19  *      op_type         The type of the operation.
20  *      op_opt          Whether or not the op has been optimised by the
21  *                      peephole optimiser.
22  *
23  *                      See the comments in S_clear_yystack() for more
24  *                      details on the following three flags:
25  *
26  *      op_latefree     tell op_free() to clear this op (and free any kids)
27  *                      but not yet deallocate the struct. This means that
28  *                      the op may be safely op_free()d multiple times
29  *      op_latefreed    an op_latefree op has been op_free()d
30  *      op_attached     this op (sub)tree has been attached to a CV
31  *
32  *      op_spare        three spare bits!
33  *      op_flags        Flags common to all operations.  See OPf_* below.
34  *      op_private      Flags peculiar to a particular operation (BUT,
35  *                      by default, set to the number of children until
36  *                      the operation is privatized by a check routine,
37  *                      which may or may not check number of children).
38  */
39 #include "op_reg_common.h"
40
41 #define OPCODE U16
42
43 #ifdef PERL_MAD
44 #  define MADPROP_IN_BASEOP     MADPROP*        op_madprop;
45 #else
46 #  define MADPROP_IN_BASEOP
47 #endif
48
49 typedef PERL_BITFIELD16 Optype;
50
51 #ifdef BASEOP_DEFINITION
52 #define BASEOP BASEOP_DEFINITION
53 #else
54 #define BASEOP                          \
55     OP*         op_next;                \
56     OP*         op_sibling;             \
57     OP*         (*op_ppaddr)(pTHX);     \
58     MADPROP_IN_BASEOP                   \
59     PADOFFSET   op_targ;                \
60     PERL_BITFIELD16 op_type:9;          \
61     PERL_BITFIELD16 op_opt:1;           \
62     PERL_BITFIELD16 op_latefree:1;      \
63     PERL_BITFIELD16 op_latefreed:1;     \
64     PERL_BITFIELD16 op_attached:1;      \
65     PERL_BITFIELD16 op_spare:3;         \
66     U8          op_flags;               \
67     U8          op_private;
68 #endif
69
70 /* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
71    Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
72    then all the other bit-fields before/after it should change their
73    types too to let VC pack them into the same 4 byte integer.*/
74
75 #define OP_GIMME(op,dfl) \
76         (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID   ? G_VOID   : \
77          ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
78          ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST   ? G_ARRAY   : \
79          dfl)
80
81 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
82
83 /*
84 =head1 "Gimme" Values
85
86 =for apidoc Amn|U32|GIMME_V
87 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
88 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
89 respectively. See L<perlcall> for a usage example.
90
91 =for apidoc Amn|U32|GIMME
92 A backward-compatible version of C<GIMME_V> which can only return
93 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
94 Deprecated.  Use C<GIMME_V> instead.
95
96 =cut
97 */
98
99 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
100
101 /* Public flags */
102
103 #define OPf_WANT        3       /* Mask for "want" bits: */
104 #define  OPf_WANT_VOID   1      /*   Want nothing */
105 #define  OPf_WANT_SCALAR 2      /*   Want single value */
106 #define  OPf_WANT_LIST   3      /*   Want list of any length */
107 #define OPf_KIDS        4       /* There is a firstborn child. */
108 #define OPf_PARENS      8       /* This operator was parenthesized. */
109                                 /*  (Or block needs explicit scope entry.) */
110 #define OPf_REF         16      /* Certified reference. */
111                                 /*  (Return container, not containee). */
112 #define OPf_MOD         32      /* Will modify (lvalue). */
113 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
114 #define OPf_SPECIAL     128     /* Do something weird for this op: */
115                                 /*  On local LVAL, don't init local value. */
116                                 /*  On OP_SORT, subroutine is inlined. */
117                                 /*  On OP_NOT, inversion was implicit. */
118                                 /*  On OP_LEAVE, don't restore curpm. */
119                                 /*  On truncate, we truncate filehandle */
120                                 /*  On control verbs, we saw no label */
121                                 /*  On flipflop, we saw ... instead of .. */
122                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
123                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
124                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
125                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
126                                 /*  On pushre, rx is used as part of split, e.g. split " " */
127                                 /*  On regcomp, "use re 'eval'" was in scope */
128                                 /*  On OP_READLINE, was <$filehandle> */
129                                 /*  On RV2[ACGHS]V, don't create GV--in
130                                     defined()*/
131                                 /*  On OP_DBSTATE, indicates breakpoint
132                                  *    (runtime property) */
133                                 /*  On OP_REQUIRE, was seen as CORE::require */
134                                 /*  On OP_ENTERWHEN, there's no condition */
135                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
136                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
137                                     reference to the new anon hash or array */
138                                 /*  On OP_HELEM and OP_HSLICE, localization will be followed
139                                     by assignment, so do not wipe the target if it is special
140                                     (e.g. a glob or a magic SV) */
141                                 /*  On OP_MATCH, OP_SUBST & OP_TRANS, the
142                                     operand of a logical or conditional
143                                     that was optimised away, so it should
144                                     not be bound via =~ */
145                                 /*  On OP_CONST, from a constant CV */
146                                 /*  On OP_GLOB, use Perl glob function */
147
148 /* old names; don't use in new code, but don't break them, either */
149 #define OPf_LIST        OPf_WANT_LIST
150 #define OPf_KNOW        OPf_WANT
151
152 #define GIMME \
153           (PL_op->op_flags & OPf_WANT                                   \
154            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
155               ? G_ARRAY                                                 \
156               : G_SCALAR)                                               \
157            : dowantarray())
158
159 /* NOTE: OP_NEXTSTATE and OP_DBSTATE (i.e. COPs) carry lower
160  * bits of PL_hints in op_private */
161
162 /* Private for lvalues */
163 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
164
165 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
166 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
167
168 /* Private for OP_AASSIGN */
169 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
170
171 /* Private for OP_SASSIGN */
172 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
173 #define OPpASSIGN_CV_TO_GV      128     /* Possible optimisation for constants. */
174
175 /* Private for OP_MATCH and OP_SUBST{,CONST} */
176 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
177
178 /* Private for OP_TRANS */
179 #define OPpTRANS_FROM_UTF       1
180 #define OPpTRANS_TO_UTF         2
181 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
182 #define OPpTRANS_SQUASH         8
183     /* 16 is used for OPpTARGET_MY */
184 #define OPpTRANS_COMPLEMENT     32
185 #define OPpTRANS_GROWS          64
186 #define OPpTRANS_DELETE         128
187 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
188
189 /* Private for OP_REPEAT */
190 #define OPpREPEAT_DOLIST        64      /* List replication. */
191
192 /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
193 #define OPpDEREF                (32|64) /* autovivify: Want ref to something: */
194 #define OPpDEREF_AV             32      /*   Want ref to AV. */
195 #define OPpDEREF_HV             64      /*   Want ref to HV. */
196 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
197 /* Private for OP_RV2SV, OP_RV2AV, OP_RV2AV */
198 #define OPpDEREFed              4       /* prev op was OPpDEREF */
199   /* OP_ENTERSUB only */
200 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
201 #define OPpENTERSUB_HASTARG     32      /* Called from OP tree. */
202 #define OPpENTERSUB_NOMOD       64      /* Immune to op_lvalue() for :attrlist. */
203 #define OPpENTERSUB_INARGS      4       /* Lval used as arg to a sub. */
204 #define OPpENTERSUB_DEREF       1       /* Lval call that autovivifies. */
205   /* OP_RV2CV only */
206 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
207 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
208 #define OPpMAY_RETURN_CONSTANT  1       /* If a constant sub, return the constant */
209
210   /* OP_GV only */
211 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
212   /* OP_?ELEM only */
213 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
214   /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
215 #define OPpOUR_INTRO            16      /* Variable was in an our() */
216   /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM, OP_[AH]SLICE OP_AV2ARYLEN,
217      OP_R?KEYS, OP_SUBSTR, OP_POS, OP_VEC */
218 #define OPpMAYBE_LVSUB          8       /* We might be an lvalue to return */
219   /* OP_PADSV only */
220 #define OPpPAD_STATE            16      /* is a "state" pad */
221   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
222
223   /* OP_RV2GV only */
224 #define OPpDONT_INIT_GV         4       /* Call gv_fetchpv with GV_NOINIT */
225 /* (Therefore will return whatever is currently in the symbol table, not
226    guaranteed to be a PVGV)  */
227
228 /* Private for OPs with TARGLEX */
229   /* (lower bits may carry MAXARG) */
230 #define OPpTARGET_MY            16      /* Target is PADMY. */
231
232 /* Private for OP_ENTERITER and OP_ITER */
233 #define OPpITER_REVERSED        4       /* for (reverse ...) */
234 #define OPpITER_DEF             8       /* for $_ or for my $_ */
235
236 /* Private for OP_CONST */
237 #define OPpCONST_NOVER          2       /* no 6; */
238 #define OPpCONST_SHORTCIRCUIT   4       /* eg the constant 5 in (5 || foo) */
239 #define OPpCONST_STRICT         8       /* bareword subject to strict 'subs' */
240 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
241 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
242 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
243 #define OPpCONST_WARNING        128     /* Was a $^W translated to constant. */
244
245 /* Private for OP_FLIP/FLOP */
246 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
247
248 /* Private for OP_LIST */
249 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
250
251 /* Private for OP_DELETE */
252 #define OPpSLICE                64      /* Operating on a list of keys */
253 /* Also OPpLVAL_INTRO (128) */
254
255 /* Private for OP_EXISTS */
256 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
257
258 /* Private for OP_SORT */
259 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
260 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
261 #define OPpSORT_REVERSE         4       /* Reversed sort */
262 #define OPpSORT_INPLACE         8       /* sort in-place; eg @a = sort @a */
263 #define OPpSORT_DESCEND         16      /* Descending sort */
264 #define OPpSORT_QSORT           32      /* Use quicksort (not mergesort) */
265 #define OPpSORT_STABLE          64      /* Use a stable algorithm */
266
267 /* Private for OP_REVERSE */
268 #define OPpREVERSE_INPLACE      8       /* reverse in-place (@a = reverse @a) */
269
270 /* Private for OP_OPEN and OP_BACKTICK */
271 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
272 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
273 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
274 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
275
276 /* Private for OP_EXIT, HUSH also for OP_DIE */
277 #define OPpHUSH_VMSISH          64      /* hush DCL exit msg vmsish mode*/
278 #define OPpEXIT_VMSISH          128     /* exit(0) vs. exit(1) vmsish mode*/
279
280 /* Private for OP_FTXXX */
281 #define OPpFT_ACCESS            2       /* use filetest 'access' */
282 #define OPpFT_STACKED           4       /* stacked filetest, as in "-f -x $f" */
283
284 /* Private for OP_(MAP|GREP)(WHILE|START) */
285 #define OPpGREP_LEX             2       /* iterate over lexical $_ */
286     
287 /* Private for OP_ENTEREVAL */
288 #define OPpEVAL_HAS_HH          2       /* Does it have a copy of %^H */
289     
290 struct op {
291     BASEOP
292 };
293
294 struct unop {
295     BASEOP
296     OP *        op_first;
297 };
298
299 struct binop {
300     BASEOP
301     OP *        op_first;
302     OP *        op_last;
303 };
304
305 struct logop {
306     BASEOP
307     OP *        op_first;
308     OP *        op_other;
309 };
310
311 struct listop {
312     BASEOP
313     OP *        op_first;
314     OP *        op_last;
315 };
316
317 struct pmop {
318     BASEOP
319     OP *        op_first;
320     OP *        op_last;
321 #ifdef USE_ITHREADS
322     IV          op_pmoffset;
323 #else
324     REGEXP *    op_pmregexp;            /* compiled expression */
325 #endif
326     U32         op_pmflags;
327     union {
328         OP *    op_pmreplroot;          /* For OP_SUBST */
329 #ifdef USE_ITHREADS
330         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
331 #else
332         GV *    op_pmtargetgv;
333 #endif
334     }   op_pmreplrootu;
335     union {
336         OP *    op_pmreplstart; /* Only used in OP_SUBST */
337 #ifdef USE_ITHREADS
338         char *  op_pmstashpv;   /* Only used in OP_MATCH, with PMf_ONCE set */
339 #else
340         HV *    op_pmstash;
341 #endif
342     }           op_pmstashstartu;
343 };
344
345 #ifdef USE_ITHREADS
346 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
347                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
348 /* The assignment is just to enforce type safety (or at least get a warning).
349  */
350 /* With first class regexps not via a reference one needs to assign
351    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
352    is cheaper. I guess we could allow NULL, but the check above would get
353    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
354 /* BEWARE - something that calls this macro passes (r) which has a side
355    effect.  */
356 #define PM_SETRE(o,r)   STMT_START {                                    \
357                             REGEXP *const _pm_setre = (r);              \
358                             assert(_pm_setre);                          \
359                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
360                         } STMT_END
361 #else
362 #define PM_GETRE(o)     ((o)->op_pmregexp)
363 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
364 #endif
365
366 /* Leave some space, so future bit allocations can go either in the shared or
367  * unshared area without affecting binary compatibility */
368 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
369
370 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
371 #define PMf_RETAINT     (1<<(PMf_BASE_SHIFT+0))
372
373 /* match successfully only once per reset, with related flag RXf_USED in
374  * re->extflags holding state.  This is used only for ?? matches, and only on
375  * OP_MATCH and OP_QR */
376 #define PMf_ONCE        (1<<(PMf_BASE_SHIFT+1))
377
378 /* replacement contains variables */
379 #define PMf_MAYBE_CONST (1<<(PMf_BASE_SHIFT+2))
380
381 /* PMf_ONCE has matched successfully.  Not used under threading. */
382 #define PMf_USED        (1<<(PMf_BASE_SHIFT+3))
383
384 /* subst replacement is constant */
385 #define PMf_CONST       (1<<(PMf_BASE_SHIFT+4))
386
387 /* keep 1st runtime pattern forever */
388 #define PMf_KEEP        (1<<(PMf_BASE_SHIFT+5))
389
390 #define PMf_GLOBAL      (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
391
392 /* don't reset pos() if //g fails */
393 #define PMf_CONTINUE    (1<<(PMf_BASE_SHIFT+7))
394
395 /* evaluating replacement as expr */
396 #define PMf_EVAL        (1<<(PMf_BASE_SHIFT+8))
397
398 /* Return substituted string instead of modifying it. */
399 #define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
400
401 #if PMf_BASE_SHIFT+9 > 31
402 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
403 #endif
404
405 #ifdef USE_ITHREADS
406
407 #  define PmopSTASHPV(o)                                                \
408     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstashpv : NULL)
409 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
410 #    define PmopSTASHPV_set(o,pv)       ({                              \
411         assert((o)->op_pmflags & PMf_ONCE);                             \
412         ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv));        \
413     })
414 #  else
415 #    define PmopSTASHPV_set(o,pv)                                       \
416     ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv))
417 #  endif
418 #  define PmopSTASH(o)          (PmopSTASHPV(o) \
419                                  ? gv_stashpv((o)->op_pmstashstartu.op_pmstashpv,GV_ADD) : NULL)
420 #  define PmopSTASH_set(o,hv)   PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : NULL))
421 #  define PmopSTASH_free(o)     PerlMemShared_free(PmopSTASHPV(o))
422
423 #else
424 #  define PmopSTASH(o)                                                  \
425     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
426 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
427 #    define PmopSTASH_set(o,hv)         ({                              \
428         assert((o)->op_pmflags & PMf_ONCE);                             \
429         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
430     })
431 #  else
432 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
433 #  endif
434 #  define PmopSTASHPV(o)        (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
435    /* op_pmstashstartu.op_pmstash is not refcounted */
436 #  define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
437 /* Note that if this becomes non-empty, then S_forget_pmop in op.c will need
438    changing */
439 #  define PmopSTASH_free(o)    
440 #endif
441
442 struct svop {
443     BASEOP
444     SV *        op_sv;
445 };
446
447 struct padop {
448     BASEOP
449     PADOFFSET   op_padix;
450 };
451
452 struct pvop {
453     BASEOP
454     char *      op_pv;
455 };
456
457 struct loop {
458     BASEOP
459     OP *        op_first;
460     OP *        op_last;
461     OP *        op_redoop;
462     OP *        op_nextop;
463     OP *        op_lastop;
464 };
465
466 #define cUNOPx(o)       ((UNOP*)o)
467 #define cBINOPx(o)      ((BINOP*)o)
468 #define cLISTOPx(o)     ((LISTOP*)o)
469 #define cLOGOPx(o)      ((LOGOP*)o)
470 #define cPMOPx(o)       ((PMOP*)o)
471 #define cSVOPx(o)       ((SVOP*)o)
472 #define cPADOPx(o)      ((PADOP*)o)
473 #define cPVOPx(o)       ((PVOP*)o)
474 #define cCOPx(o)        ((COP*)o)
475 #define cLOOPx(o)       ((LOOP*)o)
476
477 #define cUNOP           cUNOPx(PL_op)
478 #define cBINOP          cBINOPx(PL_op)
479 #define cLISTOP         cLISTOPx(PL_op)
480 #define cLOGOP          cLOGOPx(PL_op)
481 #define cPMOP           cPMOPx(PL_op)
482 #define cSVOP           cSVOPx(PL_op)
483 #define cPADOP          cPADOPx(PL_op)
484 #define cPVOP           cPVOPx(PL_op)
485 #define cCOP            cCOPx(PL_op)
486 #define cLOOP           cLOOPx(PL_op)
487
488 #define cUNOPo          cUNOPx(o)
489 #define cBINOPo         cBINOPx(o)
490 #define cLISTOPo        cLISTOPx(o)
491 #define cLOGOPo         cLOGOPx(o)
492 #define cPMOPo          cPMOPx(o)
493 #define cSVOPo          cSVOPx(o)
494 #define cPADOPo         cPADOPx(o)
495 #define cPVOPo          cPVOPx(o)
496 #define cCOPo           cCOPx(o)
497 #define cLOOPo          cLOOPx(o)
498
499 #define kUNOP           cUNOPx(kid)
500 #define kBINOP          cBINOPx(kid)
501 #define kLISTOP         cLISTOPx(kid)
502 #define kLOGOP          cLOGOPx(kid)
503 #define kPMOP           cPMOPx(kid)
504 #define kSVOP           cSVOPx(kid)
505 #define kPADOP          cPADOPx(kid)
506 #define kPVOP           cPVOPx(kid)
507 #define kCOP            cCOPx(kid)
508 #define kLOOP           cLOOPx(kid)
509
510
511 #ifdef USE_ITHREADS
512 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
513 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
514                                  && GvIN_PAD(v))
515 #  define       IS_PADCONST(v)  (v && SvREADONLY(v))
516 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
517                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
518 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
519                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
520 #else
521 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
522 #  define       IS_PADGV(v)     FALSE
523 #  define       IS_PADCONST(v)  FALSE
524 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
525 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
526 #endif
527
528 #define cGVOP_gv                cGVOPx_gv(PL_op)
529 #define cGVOPo_gv               cGVOPx_gv(o)
530 #define kGVOP_gv                cGVOPx_gv(kid)
531 #define cSVOP_sv                cSVOPx_sv(PL_op)
532 #define cSVOPo_sv               cSVOPx_sv(o)
533 #define kSVOP_sv                cSVOPx_sv(kid)
534
535 #ifndef PERL_CORE
536 #  define Nullop ((OP*)NULL)
537 #endif
538
539 /* Lowest byte of PL_opargs */
540 #define OA_MARK 1
541 #define OA_FOLDCONST 2
542 #define OA_RETSCALAR 4
543 #define OA_TARGET 8
544 #define OA_TARGLEX 16
545 #define OA_OTHERINT 32
546 #define OA_DANGEROUS 64
547 #define OA_DEFGV 128
548
549 /* The next 4 bits encode op class information */
550 #define OCSHIFT 8
551
552 #define OA_CLASS_MASK (15 << OCSHIFT)
553
554 #define OA_BASEOP (0 << OCSHIFT)
555 #define OA_UNOP (1 << OCSHIFT)
556 #define OA_BINOP (2 << OCSHIFT)
557 #define OA_LOGOP (3 << OCSHIFT)
558 #define OA_LISTOP (4 << OCSHIFT)
559 #define OA_PMOP (5 << OCSHIFT)
560 #define OA_SVOP (6 << OCSHIFT)
561 #define OA_PADOP (7 << OCSHIFT)
562 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
563 #define OA_LOOP (9 << OCSHIFT)
564 #define OA_COP (10 << OCSHIFT)
565 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
566 #define OA_FILESTATOP (12 << OCSHIFT)
567 #define OA_LOOPEXOP (13 << OCSHIFT)
568
569 #define OASHIFT 12
570
571 /* Remaining nybbles of PL_opargs */
572 #define OA_SCALAR 1
573 #define OA_LIST 2
574 #define OA_AVREF 3
575 #define OA_HVREF 4
576 #define OA_CVREF 5
577 #define OA_FILEREF 6
578 #define OA_SCALARREF 7
579 #define OA_OPTIONAL 8
580
581 /* Op_REFCNT is a reference count at the head of each op tree: needed
582  * since the tree is shared between threads, and between cloned closure
583  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
584  * this count.
585  * The same mutex is used to protect the refcounts of the reg_trie_data
586  * and reg_ac_data structures, which are shared between duplicated
587  * regexes.
588  */
589
590 #ifdef USE_ITHREADS
591 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
592 #  ifdef PERL_CORE
593 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
594 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
595 #  else
596 #    define OP_REFCNT_LOCK              op_refcnt_lock()
597 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
598 #  endif
599 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
600 #else
601 #  define OP_REFCNT_INIT                NOOP
602 #  define OP_REFCNT_LOCK                NOOP
603 #  define OP_REFCNT_UNLOCK              NOOP
604 #  define OP_REFCNT_TERM                NOOP
605 #endif
606
607 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
608 #ifdef PERL_DEBUG_READONLY_OPS
609 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
610 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
611 #else
612 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
613 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
614 #endif
615
616 /* flags used by Perl_load_module() */
617 #define PERL_LOADMOD_DENY               0x1     /* no Module */
618 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
619 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* use Module (...) */
620
621 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
622 #define ref(o, type) doref(o, type, TRUE)
623 #endif
624
625 /*
626 =head1 Optree Manipulation Functions
627
628 =for apidoc Am|OP*|LINKLIST|OP *o
629 Given the root of an optree, link the tree in execution order using the
630 C<op_next> pointers and return the first op executed. If this has
631 already been done, it will not be redone, and C<< o->op_next >> will be
632 returned. If C<< o->op_next >> is not already set, I<o> should be at
633 least an C<UNOP>.
634
635 =cut
636 */
637
638 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
639
640 /* no longer used anywhere in core */
641 #ifndef PERL_CORE
642 #define cv_ckproto(cv, gv, p) \
643    cv_ckproto_len((cv), (gv), (p), (p) ? strlen(p) : 0)
644 #endif
645
646 #ifdef PERL_CORE
647 #  define my(o) my_attrs((o), NULL)
648 #endif
649
650 #ifdef USE_REENTRANT_API
651 #include "reentr.h"
652 #endif
653
654 #if defined(PL_OP_SLAB_ALLOC)
655 #define NewOp(m,var,c,type)     \
656         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
657 #define NewOpSz(m,var,size)     \
658         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
659 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
660 #else
661 #define NewOp(m, var, c, type)  \
662         (var = (MEM_WRAP_CHECK_(c,type) \
663          (type*)PerlMemShared_calloc(c, sizeof(type))))
664 #define NewOpSz(m, var, size)   \
665         (var = (OP*)PerlMemShared_calloc(1, size))
666 #define FreeOp(p) PerlMemShared_free(p)
667 #endif
668
669 struct block_hooks {
670     U32     bhk_flags;
671     void    (*bhk_start)        (pTHX_ int full);
672     void    (*bhk_pre_end)      (pTHX_ OP **seq);
673     void    (*bhk_post_end)     (pTHX_ OP **seq);
674     void    (*bhk_eval)         (pTHX_ OP *const saveop);
675 };
676
677 /*
678 =head1 Compile-time scope hooks
679
680 =for apidoc mx|U32|BhkFLAGS|BHK *hk
681 Return the BHK's flags.
682
683 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
684 Return an entry from the BHK structure. I<which> is a preprocessor token
685 indicating which entry to return. If the appropriate flag is not set
686 this will return NULL. The type of the return value depends on which
687 entry you ask for.
688
689 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
690 Set an entry in the BHK structure, and set the flags to indicate it is
691 valid. I<which> is a preprocessing token indicating which entry to set.
692 The type of I<ptr> depends on the entry.
693
694 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
695 Temporarily disable an entry in this BHK structure, by clearing the
696 appropriate flag. I<which> is a preprocessor token indicating which
697 entry to disable.
698
699 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
700 Re-enable an entry in this BHK structure, by setting the appropriate
701 flag. I<which> is a preprocessor token indicating which entry to enable.
702 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
703 pointer.
704
705 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
706 Call all the registered block hooks for type I<which>. I<which> is a
707 preprocessing token; the type of I<arg> depends on I<which>.
708
709 =cut
710 */
711
712 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
713
714 #define BHKf_bhk_start      0x01
715 #define BHKf_bhk_pre_end    0x02
716 #define BHKf_bhk_post_end   0x04
717 #define BHKf_bhk_eval       0x08
718
719 #define BhkENTRY(hk, which) \
720     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
721
722 #define BhkENABLE(hk, which) \
723     STMT_START { \
724         BhkFLAGS(hk) |= BHKf_ ## which; \
725         assert(BhkENTRY(hk, which)); \
726     } STMT_END
727
728 #define BhkDISABLE(hk, which) \
729     STMT_START { \
730         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
731     } STMT_END
732
733 #define BhkENTRY_set(hk, which, ptr) \
734     STMT_START { \
735         (hk)->which = ptr; \
736         BhkENABLE(hk, which); \
737     } STMT_END
738
739 #define CALL_BLOCK_HOOKS(which, arg) \
740     STMT_START { \
741         if (PL_blockhooks) { \
742             I32 i; \
743             for (i = av_len(PL_blockhooks); i >= 0; i--) { \
744                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
745                 BHK *hk; \
746                 \
747                 assert(SvIOK(sv)); \
748                 if (SvUOK(sv)) \
749                     hk = INT2PTR(BHK *, SvUVX(sv)); \
750                 else \
751                     hk = INT2PTR(BHK *, SvIVX(sv)); \
752                 \
753                 if (BhkENTRY(hk, which)) \
754                     BhkENTRY(hk, which)(aTHX_ arg); \
755             } \
756         } \
757     } STMT_END
758
759 /* flags for rv2cv_op_cv */
760
761 #define RV2CVOPCV_MARK_EARLY     0x00000001
762 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
763
764 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
765
766 /* flags for op_lvalue_flags */
767
768 #define OP_LVALUE_NO_CROAK 1
769
770 /*
771 =head1 Custom Operators
772
773 =for apidoc Am|U32|XopFLAGS|XOP *xop
774 Return the XOP's flags.
775
776 =for apidoc Am||XopENTRY|XOP *xop|which
777 Return a member of the XOP structure. I<which> is a cpp token indicating
778 which entry to return. If the member is not set this will return a
779 default value. The return type depends on I<which>.
780
781 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
782 Set a member of the XOP structure. I<which> is a cpp token indicating
783 which entry to set. See L<perlguts/"Custom Operators"> for details about
784 the available members and how they are used.
785
786 =for apidoc Am|void|XopDISABLE|XOP *xop|which
787 Temporarily disable a member of the XOP, by clearing the appropriate flag.
788
789 =for apidoc Am|void|XopENABLE|XOP *xop|which
790 Reenable a member of the XOP which has been disabled.
791
792 =cut
793 */
794
795 struct custom_op {
796     U32             xop_flags;    
797     const char     *xop_name;
798     const char     *xop_desc;
799     U32             xop_class;
800     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
801 };
802
803 #define XopFLAGS(xop) ((xop)->xop_flags)
804
805 #define XOPf_xop_name   0x01
806 #define XOPf_xop_desc   0x02
807 #define XOPf_xop_class  0x04
808 #define XOPf_xop_peep   0x08
809
810 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
811 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
812 #define XOPd_xop_class  OA_BASEOP
813 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
814
815 #define XopENTRY_set(xop, which, to) \
816     STMT_START { \
817         (xop)->which = (to); \
818         (xop)->xop_flags |= XOPf_ ## which; \
819     } STMT_END
820
821 #define XopENTRY(xop, which) \
822     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
823
824 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
825 #define XopENABLE(xop, which) \
826     STMT_START { \
827         (xop)->xop_flags |= XOPf_ ## which; \
828         assert(XopENTRY(xop, which)); \
829     } STMT_END
830
831 /*
832 =head1 Optree Manipulation Functions
833
834 =for apidoc Am|const char *|OP_NAME|OP *o
835 Return the name of the provided OP. For core ops this looks up the name
836 from the op_type; for custom ops from the op_ppaddr.
837
838 =for apidoc Am|const char *|OP_DESC|OP *o
839 Return a short description of the provided OP.
840
841 =for apidoc Am|U32|OP_CLASS|OP *o
842 Return the class of the provided OP: that is, which of the *OP
843 structures it uses. For core ops this currently gets the information out
844 of PL_opargs, which does not always accurately reflect the type used.
845 For custom ops the type is returned from the registration, and it is up
846 to the registree to ensure it is accurate. The value returned will be
847 one of the OA_* constants from op.h.
848
849 =cut
850 */
851
852 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
853                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_name) \
854                     : PL_op_name[(o)->op_type])
855 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
856                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_desc) \
857                     : PL_op_desc[(o)->op_type])
858 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
859                      ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_class) \
860                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
861
862 #define newSUB(f, o, p, b)      Perl_newATTRSUB(aTHX_ (f), (o), (p), NULL, (b))
863
864 #ifdef PERL_MAD
865 #  define MAD_NULL 1
866 #  define MAD_PV 2
867 #  define MAD_OP 3
868 #  define MAD_SV 4
869
870 struct madprop {
871     MADPROP* mad_next;
872     void *mad_val;
873     U32 mad_vlen;
874 /*    short mad_count; */
875     char mad_key;
876     char mad_type;
877 };
878
879 struct token {
880     I32 tk_type;
881     YYSTYPE tk_lval;
882     MADPROP* tk_mad;
883 };
884 #endif
885
886 /*
887  * Values that can be held by mad_key :
888  * ^       unfilled head spot
889  * ,       literal ,
890  * ;       literal ; (blank if implicit ; at end of block)
891  * :       literal : from ?: or attr list
892  * +       unary +
893  * ?       literal ? from ?:
894  * (       literal (
895  * )       literal )
896  * [       literal [
897  * ]       literal ]
898  * {       literal {
899  * }       literal }
900  * @       literal @ sigil
901  * $       literal $ sigil
902  * *       literal * sigil
903  * !       use is source filtered
904  * &       & or sub
905  * #       whitespace/comment following ; or }
906  * #       $# sigil
907  * 1       1st ; from for(;;)
908  * 1       retired protasis
909  * 2       2nd ; from for(;;)
910  * 2       retired apodosis
911  * 3       C-style for list
912  * a       sub or var attributes
913  * a       non-method arrow operator
914  * A       method arrow operator
915  * A       use import args
916  * b       format block
917  * B       retired stub block
918  * C       constant conditional op
919  * d       declarator
920  * D       do block
921  * e       unreached "else" (see C)
922  * e       expression producing E
923  * E       tr/E/R/, /E/
924  * f       folded constant op
925  * F       peg op for format
926  * g       op was forced to be a word
927  * i       if/unless modifier
928  * I       if/elsif/unless statement
929  * k       local declarator
930  * K       retired kid op
931  * l       last index of array ($#foo)
932  * L       label
933  * m       modifier on regex
934  * n       sub or format name
935  * o       current operator/declarator name
936  * o       else/continue
937  * O       generic optimized op
938  * p       peg to hold extra whitespace at statement level
939  * P       peg op for package declaration
940  * q       opening quote
941  * =       quoted material
942  * Q       closing quote
943  * Q       optimized qw//
944  * r       expression producing R
945  * R       tr/E/R/ s/E/R/
946  * s       sub signature
947  * S       use import stub (no import)
948  * S       retired sort block
949  * t       unreached "then" (see C)
950  * U       use import op
951  * v       private sv of for loop
952  * V       use version
953  * w       while/until modifier
954  * W       while/for statement
955  * x       optimized qw
956  * X       random thing
957  * _       whitespace/comments preceding anything else
958  * ~       =~ operator
959  */
960
961 /*
962  * Local variables:
963  * c-indentation-style: bsd
964  * c-basic-offset: 4
965  * indent-tabs-mode: t
966  * End:
967  *
968  * ex: set ts=8 sts=4 sw=4 noet:
969  */