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