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