This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
op_reg_common.h: Continue refactoring
[perl5.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*         (CPERLscope(*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 OP_ENTERITER, loop var is per-thread */
127                                 /*  On pushre, rx is used as part of split, e.g. split " " */
128                                 /*  On regcomp, "use re 'eval'" was in scope */
129                                 /*  On OP_READLINE, was <$filehandle> */
130                                 /*  On RV2[ACGHS]V, don't create GV--in
131                                     defined()*/
132                                 /*  On OP_DBSTATE, indicates breakpoint
133                                  *    (runtime property) */
134                                 /*  On OP_AELEMFAST, indiciates pad var */
135                                 /*  On OP_REQUIRE, was seen as CORE::require */
136                                 /*  On OP_ENTERWHEN, there's no condition */
137                                 /*  On OP_BREAK, an implicit break */
138                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
139                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
140                                     reference to the new anon hash or array */
141                                 /*  On OP_ENTER, store caller context */
142                                 /*  On OP_HELEM and OP_HSLICE, localization will be followed
143                                     by assignment, so do not wipe the target if it is special
144                                     (e.g. a glob or a magic SV) */
145
146 /* old names; don't use in new code, but don't break them, either */
147 #define OPf_LIST        OPf_WANT_LIST
148 #define OPf_KNOW        OPf_WANT
149
150 #define GIMME \
151           (PL_op->op_flags & OPf_WANT                                   \
152            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
153               ? G_ARRAY                                                 \
154               : G_SCALAR)                                               \
155            : dowantarray())
156
157 /* NOTE: OP_NEXTSTATE and OP_DBSTATE (i.e. COPs) carry lower
158  * bits of PL_hints in op_private */
159
160 /* Private for lvalues */
161 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
162
163 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
164 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
165
166 /* Private for OP_AASSIGN */
167 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
168
169 /* Private for OP_SASSIGN */
170 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
171 #define OPpASSIGN_CV_TO_GV      128     /* Possible optimisation for constants. */
172
173 /* Private for OP_MATCH and OP_SUBST{,CONST} */
174 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
175
176 /* Private for OP_TRANS */
177 #define OPpTRANS_FROM_UTF       1
178 #define OPpTRANS_TO_UTF         2
179 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
180 #define OPpTRANS_SQUASH         8
181     /* 16 is used for OPpTARGET_MY */
182 #define OPpTRANS_COMPLEMENT     32
183 #define OPpTRANS_GROWS          64
184 #define OPpTRANS_DELETE         128
185 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
186
187 /* Private for OP_REPEAT */
188 #define OPpREPEAT_DOLIST        64      /* List replication. */
189
190 /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
191 #define OPpDEREF                (32|64) /* autovivify: Want ref to something: */
192 #define OPpDEREF_AV             32      /*   Want ref to AV. */
193 #define OPpDEREF_HV             64      /*   Want ref to HV. */
194 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
195 /* Private for OP_RV2SV, OP_RV2AV, OP_RV2AV */
196 #define OPpDEREFed              4       /* prev op was OPpDEREF */
197   /* OP_ENTERSUB only */
198 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
199 #define OPpENTERSUB_HASTARG     32      /* Called from OP tree. */
200 #define OPpENTERSUB_NOMOD       64      /* Immune to mod() for :attrlist. */
201   /* OP_ENTERSUB and OP_RV2CV only */
202 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
203 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
204 #define OPpENTERSUB_INARGS      4       /* Lval used as arg to a sub. */
205   /* OP_GV only */
206 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
207   /* OP_?ELEM only */
208 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
209   /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
210 #define OPpOUR_INTRO            16      /* Variable was in an our() */
211   /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM */
212 #define OPpMAYBE_LVSUB          8       /* We might be an lvalue to return */
213   /* OP_PADSV only */
214 #define OPpPAD_STATE            16      /* is a "state" pad */
215   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
216
217   /* OP_RV2GV only */
218 #define OPpDONT_INIT_GV         4       /* Call gv_fetchpv with GV_NOINIT */
219 /* (Therefore will return whatever is currently in the symbol table, not
220    guaranteed to be a PVGV)  */
221
222   /* OP_RV2CV only */
223 #define OPpMAY_RETURN_CONSTANT  1       /* If a constant sub, return the constant */
224
225 /* Private for OPs with TARGLEX */
226   /* (lower bits may carry MAXARG) */
227 #define OPpTARGET_MY            16      /* Target is PADMY. */
228
229 /* Private for OP_ENTERITER and OP_ITER */
230 #define OPpITER_REVERSED        4       /* for (reverse ...) */
231 #define OPpITER_DEF             8       /* for $_ or for my $_ */
232
233 /* Private for OP_CONST */
234 #define OPpCONST_NOVER          2       /* no 6; */
235 #define OPpCONST_SHORTCIRCUIT   4       /* eg the constant 5 in (5 || foo) */
236 #define OPpCONST_STRICT         8       /* bearword subject to strict 'subs' */
237 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
238 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
239 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
240 #define OPpCONST_WARNING        128     /* Was a $^W translated to constant. */
241
242 /* Private for OP_FLIP/FLOP */
243 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
244
245 /* Private for OP_LIST */
246 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
247
248 /* Private for OP_DELETE */
249 #define OPpSLICE                64      /* Operating on a list of keys */
250 /* Also OPpLVAL_INTRO (128) */
251
252 /* Private for OP_EXISTS */
253 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
254
255 /* Private for OP_SORT */
256 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
257 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
258 #define OPpSORT_REVERSE         4       /* Reversed sort */
259 #define OPpSORT_INPLACE         8       /* sort in-place; eg @a = sort @a */
260 #define OPpSORT_DESCEND         16      /* Descending sort */
261 #define OPpSORT_QSORT           32      /* Use quicksort (not mergesort) */
262 #define OPpSORT_STABLE          64      /* Use a stable algorithm */
263
264 /* Private for OP_REVERSE */
265 #define OPpREVERSE_INPLACE      8       /* reverse in-place (@a = reverse @a) */
266
267 /* Private for OP_OPEN and OP_BACKTICK */
268 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
269 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
270 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
271 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
272
273 /* Private for OP_EXIT, HUSH also for OP_DIE */
274 #define OPpHUSH_VMSISH          64      /* hush DCL exit msg vmsish mode*/
275 #define OPpEXIT_VMSISH          128     /* exit(0) vs. exit(1) vmsish mode*/
276
277 /* Private for OP_FTXXX */
278 #define OPpFT_ACCESS            2       /* use filetest 'access' */
279 #define OPpFT_STACKED           4       /* stacked filetest, as in "-f -x $f" */
280
281 /* Private for OP_(MAP|GREP)(WHILE|START) */
282 #define OPpGREP_LEX             2       /* iterate over lexical $_ */
283     
284 /* Private for OP_ENTEREVAL */
285 #define OPpEVAL_HAS_HH          2       /* Does it have a copy of %^H */
286     
287 struct op {
288     BASEOP
289 };
290
291 struct unop {
292     BASEOP
293     OP *        op_first;
294 };
295
296 struct binop {
297     BASEOP
298     OP *        op_first;
299     OP *        op_last;
300 };
301
302 struct logop {
303     BASEOP
304     OP *        op_first;
305     OP *        op_other;
306 };
307
308 struct listop {
309     BASEOP
310     OP *        op_first;
311     OP *        op_last;
312 };
313
314 struct pmop {
315     BASEOP
316     OP *        op_first;
317     OP *        op_last;
318 #ifdef USE_ITHREADS
319     IV          op_pmoffset;
320 #else
321     REGEXP *    op_pmregexp;            /* compiled expression */
322 #endif
323     U32         op_pmflags;
324     union {
325         OP *    op_pmreplroot;          /* For OP_SUBST */
326 #ifdef USE_ITHREADS
327         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
328 #else
329         GV *    op_pmtargetgv;
330 #endif
331     }   op_pmreplrootu;
332     union {
333         OP *    op_pmreplstart; /* Only used in OP_SUBST */
334 #ifdef USE_ITHREADS
335         char *  op_pmstashpv;   /* Only used in OP_MATCH, with PMf_ONCE set */
336 #else
337         HV *    op_pmstash;
338 #endif
339     }           op_pmstashstartu;
340 };
341
342 #ifdef USE_ITHREADS
343 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
344                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
345 /* The assignment is just to enforce type safety (or at least get a warning).
346  */
347 /* With first class regexps not via a reference one needs to assign
348    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
349    is cheaper. I guess we could allow NULL, but the check above would get
350    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
351 /* BEWARE - something that calls this macro passes (r) which has a side
352    effect.  */
353 #define PM_SETRE(o,r)   STMT_START {                                    \
354                             REGEXP *const _pm_setre = (r);              \
355                             assert(_pm_setre);                          \
356                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
357                         } STMT_END
358 #else
359 #define PM_GETRE(o)     ((o)->op_pmregexp)
360 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
361 #endif
362
363 #define PMf_BASE_SHIFT ((_RXf_PMf_SHIFT_NEXT)-1)
364
365 /* taint $1 etc. if target tainted */
366 #define PMf_RETAINT     (1<<(PMf_BASE_SHIFT+1))
367
368 /* match successfully only once per reset, with related flag RXf_USED in
369  * re->extflags holding state.  This is used only for ?? matches, and only on
370  * OP_MATCH and OP_QR */
371 #define PMf_ONCE        (1<<(PMf_BASE_SHIFT+2))
372
373 /* replacement contains variables */
374 #define PMf_MAYBE_CONST (1<<(PMf_BASE_SHIFT+3))
375
376 /* PMf_ONCE has matched successfully.  Not used under threading. */
377 #define PMf_USED        (1<<(PMf_BASE_SHIFT+4))
378
379 /* subst replacement is constant */
380 #define PMf_CONST       (1<<(PMf_BASE_SHIFT+5))
381
382 /* keep 1st runtime pattern forever */
383 #define PMf_KEEP        (1<<(PMf_BASE_SHIFT+6))
384 #define PMf_GLOBAL      (1<<(PMf_BASE_SHIFT+7)) /* pattern had a g modifier */
385
386 /* don't reset pos() if //g fails */
387 #define PMf_CONTINUE    (1<<(PMf_BASE_SHIFT+8))
388
389 /* evaluating replacement as expr */
390 #define PMf_EVAL        (1<<(PMf_BASE_SHIFT+9))
391
392 /* Return substituted string instead of modifying it. */
393 #define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+10))
394
395 #if PMf_BASE_SHIFT+10 > 31
396 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
397 #endif
398
399 #ifdef USE_ITHREADS
400
401 #  define PmopSTASHPV(o)                                                \
402     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstashpv : NULL)
403 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
404 #    define PmopSTASHPV_set(o,pv)       ({                              \
405         assert((o)->op_pmflags & PMf_ONCE);                             \
406         ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv));        \
407     })
408 #  else
409 #    define PmopSTASHPV_set(o,pv)                                       \
410     ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv))
411 #  endif
412 #  define PmopSTASH(o)          (PmopSTASHPV(o) \
413                                  ? gv_stashpv((o)->op_pmstashstartu.op_pmstashpv,GV_ADD) : NULL)
414 #  define PmopSTASH_set(o,hv)   PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : NULL))
415 #  define PmopSTASH_free(o)     PerlMemShared_free(PmopSTASHPV(o))
416
417 #else
418 #  define PmopSTASH(o)                                                  \
419     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
420 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
421 #    define PmopSTASH_set(o,hv)         ({                              \
422         assert((o)->op_pmflags & PMf_ONCE);                             \
423         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
424     })
425 #  else
426 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
427 #  endif
428 #  define PmopSTASHPV(o)        (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
429    /* op_pmstashstartu.op_pmstash is not refcounted */
430 #  define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
431 /* Note that if this becomes non-empty, then S_forget_pmop in op.c will need
432    changing */
433 #  define PmopSTASH_free(o)    
434 #endif
435
436 struct svop {
437     BASEOP
438     SV *        op_sv;
439 };
440
441 struct padop {
442     BASEOP
443     PADOFFSET   op_padix;
444 };
445
446 struct pvop {
447     BASEOP
448     char *      op_pv;
449 };
450
451 struct loop {
452     BASEOP
453     OP *        op_first;
454     OP *        op_last;
455     OP *        op_redoop;
456     OP *        op_nextop;
457     OP *        op_lastop;
458 };
459
460 #define cUNOPx(o)       ((UNOP*)o)
461 #define cBINOPx(o)      ((BINOP*)o)
462 #define cLISTOPx(o)     ((LISTOP*)o)
463 #define cLOGOPx(o)      ((LOGOP*)o)
464 #define cPMOPx(o)       ((PMOP*)o)
465 #define cSVOPx(o)       ((SVOP*)o)
466 #define cPADOPx(o)      ((PADOP*)o)
467 #define cPVOPx(o)       ((PVOP*)o)
468 #define cCOPx(o)        ((COP*)o)
469 #define cLOOPx(o)       ((LOOP*)o)
470
471 #define cUNOP           cUNOPx(PL_op)
472 #define cBINOP          cBINOPx(PL_op)
473 #define cLISTOP         cLISTOPx(PL_op)
474 #define cLOGOP          cLOGOPx(PL_op)
475 #define cPMOP           cPMOPx(PL_op)
476 #define cSVOP           cSVOPx(PL_op)
477 #define cPADOP          cPADOPx(PL_op)
478 #define cPVOP           cPVOPx(PL_op)
479 #define cCOP            cCOPx(PL_op)
480 #define cLOOP           cLOOPx(PL_op)
481
482 #define cUNOPo          cUNOPx(o)
483 #define cBINOPo         cBINOPx(o)
484 #define cLISTOPo        cLISTOPx(o)
485 #define cLOGOPo         cLOGOPx(o)
486 #define cPMOPo          cPMOPx(o)
487 #define cSVOPo          cSVOPx(o)
488 #define cPADOPo         cPADOPx(o)
489 #define cPVOPo          cPVOPx(o)
490 #define cCOPo           cCOPx(o)
491 #define cLOOPo          cLOOPx(o)
492
493 #define kUNOP           cUNOPx(kid)
494 #define kBINOP          cBINOPx(kid)
495 #define kLISTOP         cLISTOPx(kid)
496 #define kLOGOP          cLOGOPx(kid)
497 #define kPMOP           cPMOPx(kid)
498 #define kSVOP           cSVOPx(kid)
499 #define kPADOP          cPADOPx(kid)
500 #define kPVOP           cPVOPx(kid)
501 #define kCOP            cCOPx(kid)
502 #define kLOOP           cLOOPx(kid)
503
504
505 #ifdef USE_ITHREADS
506 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
507 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
508                                  && GvIN_PAD(v))
509 #  define       IS_PADCONST(v)  (v && SvREADONLY(v))
510 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
511                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
512 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
513                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
514 #else
515 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
516 #  define       IS_PADGV(v)     FALSE
517 #  define       IS_PADCONST(v)  FALSE
518 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
519 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
520 #endif
521
522 #define cGVOP_gv                cGVOPx_gv(PL_op)
523 #define cGVOPo_gv               cGVOPx_gv(o)
524 #define kGVOP_gv                cGVOPx_gv(kid)
525 #define cSVOP_sv                cSVOPx_sv(PL_op)
526 #define cSVOPo_sv               cSVOPx_sv(o)
527 #define kSVOP_sv                cSVOPx_sv(kid)
528
529 #ifndef PERL_CORE
530 #  define Nullop ((OP*)NULL)
531 #endif
532
533 /* Lowest byte-and-a-bit of PL_opargs */
534 #define OA_MARK 1
535 #define OA_FOLDCONST 2
536 #define OA_RETSCALAR 4
537 #define OA_TARGET 8
538 #define OA_RETINTEGER 16
539 #define OA_OTHERINT 32
540 #define OA_DANGEROUS 64
541 #define OA_DEFGV 128
542 #define OA_TARGLEX 256
543
544 /* The next 4 bits encode op class information */
545 #define OCSHIFT 9
546
547 #define OA_CLASS_MASK (15 << OCSHIFT)
548
549 #define OA_BASEOP (0 << OCSHIFT)
550 #define OA_UNOP (1 << OCSHIFT)
551 #define OA_BINOP (2 << OCSHIFT)
552 #define OA_LOGOP (3 << OCSHIFT)
553 #define OA_LISTOP (4 << OCSHIFT)
554 #define OA_PMOP (5 << OCSHIFT)
555 #define OA_SVOP (6 << OCSHIFT)
556 #define OA_PADOP (7 << OCSHIFT)
557 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
558 #define OA_LOOP (9 << OCSHIFT)
559 #define OA_COP (10 << OCSHIFT)
560 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
561 #define OA_FILESTATOP (12 << OCSHIFT)
562 #define OA_LOOPEXOP (13 << OCSHIFT)
563
564 #define OASHIFT 13
565
566 /* Remaining nybbles of PL_opargs */
567 #define OA_SCALAR 1
568 #define OA_LIST 2
569 #define OA_AVREF 3
570 #define OA_HVREF 4
571 #define OA_CVREF 5
572 #define OA_FILEREF 6
573 #define OA_SCALARREF 7
574 #define OA_OPTIONAL 8
575
576 /* Op_REFCNT is a reference count at the head of each op tree: needed
577  * since the tree is shared between threads, and between cloned closure
578  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
579  * this count.
580  * The same mutex is used to protect the refcounts of the reg_trie_data
581  * and reg_ac_data structures, which are shared between duplicated
582  * regexes.
583  */
584
585 #ifdef USE_ITHREADS
586 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
587 #  ifdef PERL_CORE
588 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
589 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
590 #  else
591 #    define OP_REFCNT_LOCK              op_refcnt_lock()
592 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
593 #  endif
594 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
595 #else
596 #  define OP_REFCNT_INIT                NOOP
597 #  define OP_REFCNT_LOCK                NOOP
598 #  define OP_REFCNT_UNLOCK              NOOP
599 #  define OP_REFCNT_TERM                NOOP
600 #endif
601
602 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
603 #ifdef PERL_DEBUG_READONLY_OPS
604 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
605 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
606 #else
607 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
608 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
609 #endif
610
611 /* flags used by Perl_load_module() */
612 #define PERL_LOADMOD_DENY               0x1     /* no Module */
613 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
614 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* use Module (...) */
615
616 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
617 #define ref(o, type) doref(o, type, TRUE)
618 #endif
619
620 /* no longer used anywhere in core */
621 #ifndef PERL_CORE
622 #define cv_ckproto(cv, gv, p) \
623    cv_ckproto_len((cv), (gv), (p), (p) ? strlen(p) : 0)
624 #endif
625
626 #ifdef PERL_CORE
627 #  define my(o) my_attrs((o), NULL)
628 #endif
629
630 #ifdef USE_REENTRANT_API
631 #include "reentr.h"
632 #endif
633
634 #if defined(PL_OP_SLAB_ALLOC)
635 #define NewOp(m,var,c,type)     \
636         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
637 #define NewOpSz(m,var,size)     \
638         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
639 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
640 #else
641 #define NewOp(m, var, c, type)  \
642         (var = (MEM_WRAP_CHECK_(c,type) \
643          (type*)PerlMemShared_calloc(c, sizeof(type))))
644 #define NewOpSz(m, var, size)   \
645         (var = (OP*)PerlMemShared_calloc(1, size))
646 #define FreeOp(p) PerlMemShared_free(p)
647 #endif
648
649 struct block_hooks {
650     U32     bhk_flags;
651     void    (*bhk_start)        (pTHX_ int full);
652     void    (*bhk_pre_end)      (pTHX_ OP **seq);
653     void    (*bhk_post_end)     (pTHX_ OP **seq);
654     void    (*bhk_eval)         (pTHX_ OP *const saveop);
655 };
656
657 /*
658 =head1 Compile-time scope hooks
659
660 =for apidoc m|U32|BhkFLAGS|BHK *hk
661 Return the BHK's flags.
662
663 =for apidoc m|void *|BhkENTRY|BHK *hk|which
664 Return an entry from the BHK structure. I<which> is a preprocessor token
665 indicating which entry to return. If the appropriate flag is not set
666 this will return NULL. The type of the return value depends on which
667 entry you ask for.
668
669 =for apidoc Am|void|BhkENTRY_set|BHK *hk|which|void *ptr
670 Set an entry in the BHK structure, and set the flags to indicate it is
671 valid. I<which> is a preprocessing token indicating which entry to set.
672 The type of I<ptr> depends on the entry.
673
674 =for apidoc Am|void|BhkDISABLE|BHK *hk|which
675 Temporarily disable an entry in this BHK structure, by clearing the
676 appropriate flag. I<which> is a preprocessor token indicating which
677 entry to disable.
678
679 =for apidoc Am|void|BhkENABLE|BHK *hk|which
680 Re-enable an entry in this BHK structure, by setting the appropriate
681 flag. I<which> is a preprocessor token indicating which entry to enable.
682 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
683 pointer.
684
685 =for apidoc m|void|CALL_BLOCK_HOOKS|which|arg
686 Call all the registered block hooks for type I<which>. I<which> is a
687 preprocessing token; the type of I<arg> depends on I<which>.
688
689 =cut
690 */
691
692 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
693
694 #define BHKf_start          0x01
695 #define BHKf_pre_end        0x02
696 #define BHKf_post_end       0x04
697 #define BHKf_eval           0x08
698
699 #define BhkENTRY(hk, which) \
700     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->bhk_ ## which) : NULL)
701
702 #define BhkENABLE(hk, which) \
703     STMT_START { \
704         BhkFLAGS(hk) |= BHKf_ ## which; \
705         assert(BhkENTRY(hk, which)); \
706     } STMT_END
707
708 #define BhkDISABLE(hk, which) \
709     STMT_START { \
710         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
711     } STMT_END
712
713 #define BhkENTRY_set(hk, which, ptr) \
714     STMT_START { \
715         (hk)->bhk_ ## which = ptr; \
716         BhkENABLE(hk, which); \
717     } STMT_END
718
719 #define CALL_BLOCK_HOOKS(which, arg) \
720     STMT_START { \
721         if (PL_blockhooks) { \
722             I32 i; \
723             for (i = av_len(PL_blockhooks); i >= 0; i--) { \
724                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
725                 BHK *hk; \
726                 \
727                 assert(SvIOK(sv)); \
728                 if (SvUOK(sv)) \
729                     hk = INT2PTR(BHK *, SvUVX(sv)); \
730                 else \
731                     hk = INT2PTR(BHK *, SvIVX(sv)); \
732                 \
733                 if (BhkENTRY(hk, which)) \
734                     CALL_FPTR(BhkENTRY(hk, which))(aTHX_ arg); \
735             } \
736         } \
737     } STMT_END
738
739 #ifdef PERL_MAD
740 #  define MAD_NULL 1
741 #  define MAD_PV 2
742 #  define MAD_OP 3
743 #  define MAD_SV 4
744
745 struct madprop {
746     MADPROP* mad_next;
747     void *mad_val;
748     U32 mad_vlen;
749 /*    short mad_count; */
750     char mad_key;
751     char mad_type;
752 };
753
754 struct token {
755     I32 tk_type;
756     YYSTYPE tk_lval;
757     MADPROP* tk_mad;
758 };
759 #endif
760
761 /*
762  * Values that can be held by mad_key :
763  * ^       unfilled head spot
764  * ,       literal ,
765  * ;       literal ; (blank if implicit ; at end of block)
766  * :       literal : from ?: or attr list
767  * +       unary +
768  * ?       literal ? from ?:
769  * (       literal (
770  * )       literal )
771  * [       literal [
772  * ]       literal ]
773  * {       literal {
774  * }       literal }
775  * @       literal @ sigil
776  * $       literal $ sigil
777  * *       literal * sigil
778  * !       use is source filtered
779  * &       & or sub
780  * #       whitespace/comment following ; or }
781  * #       $# sigil
782  * 1       1st ; from for(;;)
783  * 1       retired protasis
784  * 2       2nd ; from for(;;)
785  * 2       retired apodosis
786  * 3       C-style for list
787  * a       sub or var attributes
788  * a       non-method arrow operator
789  * A       method arrow operator
790  * A       use import args
791  * b       format block
792  * B       retired stub block
793  * C       constant conditional op
794  * d       declarator
795  * D       do block
796  * e       unreached "else" (see C)
797  * e       expression producing E
798  * E       tr/E/R/, /E/
799  * f       folded constant op
800  * F       peg op for format
801  * g       op was forced to be a word
802  * i       if/unless modifier
803  * I       if/elsif/unless statement
804  * k       local declarator
805  * K       retired kid op
806  * l       last index of array ($#foo)
807  * L       label
808  * m       modifier on regex
809  * n       sub or format name
810  * o       current operator/declarator name
811  * o       else/continue
812  * O       generic optimized op
813  * p       peg to hold extra whitespace at statement level
814  * P       peg op for package declaration
815  * q       opening quote
816  * =       quoted material
817  * Q       closing quote
818  * Q       optimized qw//
819  * r       expression producing R
820  * R       tr/E/R/ s/E/R/
821  * s       sub signature
822  * S       use import stub (no import)
823  * S       retired sort block
824  * t       unreached "then" (see C)
825  * U       use import op
826  * v       private sv of for loop
827  * V       use version
828  * w       while/until modifier
829  * W       while/for statement
830  * x       optimized qw
831  * X       random thing
832  * _       whitespace/comments preceding anything else
833  * ~       =~ operator
834  */
835
836 /*
837  * Local variables:
838  * c-indentation-style: bsd
839  * c-basic-offset: 4
840  * indent-tabs-mode: t
841  * End:
842  *
843  * ex: set ts=8 sts=4 sw=4 noet:
844  */