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