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