create perl5160delta-to-be
[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 lower
167  * bits of PL_hints 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
299 /* Private for OP_(MAP|GREP)(WHILE|START) */
300 #define OPpGREP_LEX             2       /* iterate over lexical $_ */
301     
302 /* Private for OP_ENTEREVAL */
303 #define OPpEVAL_HAS_HH          2       /* Does it have a copy of %^H */
304 #define OPpEVAL_UNICODE         4
305 #define OPpEVAL_BYTES           8
306 #define OPpEVAL_COPHH           16      /* Construct %^H from cop hints */
307     
308 /* Private for OP_CALLER, OP_WANTARRAY and OP_RUNCV */
309 #define OPpOFFBYONE             128     /* Treat caller(1) as caller(2) */
310
311 /* Private for OP_COREARGS */
312 /* These must not conflict with OPpDONT_INIT_GV or OPpALLOW_FAKE.
313    See pp.c:S_rv2gv. */
314 #define OPpCOREARGS_DEREF1      1       /* Arg 1 is a handle constructor */
315 #define OPpCOREARGS_DEREF2      2       /* Arg 2 is a handle constructor */
316 #define OPpCOREARGS_SCALARMOD   64      /* \$ rather than \[$@%*] */
317 #define OPpCOREARGS_PUSHMARK    128     /* Call pp_pushmark */
318
319 struct op {
320     BASEOP
321 };
322
323 struct unop {
324     BASEOP
325     OP *        op_first;
326 };
327
328 struct binop {
329     BASEOP
330     OP *        op_first;
331     OP *        op_last;
332 };
333
334 struct logop {
335     BASEOP
336     OP *        op_first;
337     OP *        op_other;
338 };
339
340 struct listop {
341     BASEOP
342     OP *        op_first;
343     OP *        op_last;
344 };
345
346 struct pmop {
347     BASEOP
348     OP *        op_first;
349     OP *        op_last;
350 #ifdef USE_ITHREADS
351     IV          op_pmoffset;
352 #else
353     REGEXP *    op_pmregexp;            /* compiled expression */
354 #endif
355     U32         op_pmflags;
356     union {
357         OP *    op_pmreplroot;          /* For OP_SUBST */
358 #ifdef USE_ITHREADS
359         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
360 #else
361         GV *    op_pmtargetgv;
362 #endif
363     }   op_pmreplrootu;
364     union {
365         OP *    op_pmreplstart; /* Only used in OP_SUBST */
366 #ifdef USE_ITHREADS
367         struct {
368             char *      op_pmstashpv;   /* Only used in OP_MATCH, with PMf_ONCE set */
369             U32     op_pmstashflags;  /* currently only SVf_UTF8 or 0 */
370         } op_pmstashthr;
371 #else
372         HV *    op_pmstash;
373 #endif
374     }           op_pmstashstartu;
375 };
376
377 #ifdef USE_ITHREADS
378 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
379                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
380 /* The assignment is just to enforce type safety (or at least get a warning).
381  */
382 /* With first class regexps not via a reference one needs to assign
383    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
384    is cheaper. I guess we could allow NULL, but the check above would get
385    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
386 /* BEWARE - something that calls this macro passes (r) which has a side
387    effect.  */
388 #define PM_SETRE(o,r)   STMT_START {                                    \
389                             REGEXP *const _pm_setre = (r);              \
390                             assert(_pm_setre);                          \
391                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
392                         } STMT_END
393 #else
394 #define PM_GETRE(o)     ((o)->op_pmregexp)
395 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
396 #endif
397
398 /* Leave some space, so future bit allocations can go either in the shared or
399  * unshared area without affecting binary compatibility */
400 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
401
402 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
403 #define PMf_RETAINT     (1<<(PMf_BASE_SHIFT+0))
404
405 /* match successfully only once per reset, with related flag RXf_USED in
406  * re->extflags holding state.  This is used only for ?? matches, and only on
407  * OP_MATCH and OP_QR */
408 #define PMf_ONCE        (1<<(PMf_BASE_SHIFT+1))
409
410 /* replacement contains variables */
411 #define PMf_MAYBE_CONST (1<<(PMf_BASE_SHIFT+2))
412
413 /* PMf_ONCE has matched successfully.  Not used under threading. */
414 #define PMf_USED        (1<<(PMf_BASE_SHIFT+3))
415
416 /* subst replacement is constant */
417 #define PMf_CONST       (1<<(PMf_BASE_SHIFT+4))
418
419 /* keep 1st runtime pattern forever */
420 #define PMf_KEEP        (1<<(PMf_BASE_SHIFT+5))
421
422 #define PMf_GLOBAL      (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
423
424 /* don't reset pos() if //g fails */
425 #define PMf_CONTINUE    (1<<(PMf_BASE_SHIFT+7))
426
427 /* evaluating replacement as expr */
428 #define PMf_EVAL        (1<<(PMf_BASE_SHIFT+8))
429
430 /* Return substituted string instead of modifying it. */
431 #define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
432
433 #if PMf_BASE_SHIFT+9 > 31
434 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
435 #endif
436
437 #ifdef USE_ITHREADS
438
439 #  define PmopSTASHPV(o)                                                \
440     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstashthr.op_pmstashpv : NULL)
441 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
442 #    define PmopSTASHPV_set(o,pv)       ({                              \
443         assert((o)->op_pmflags & PMf_ONCE);                             \
444         ((o)->op_pmstashstartu.op_pmstashthr.op_pmstashpv = savesharedpv(pv));  \
445     })
446 #  else
447 #    define PmopSTASHPV_set(o,pv)                                       \
448     ((o)->op_pmstashstartu.op_pmstashthr.op_pmstashpv = savesharedpv(pv))
449 #  endif
450 #  define PmopSTASH_flags(o)           ((o)->op_pmstashstartu.op_pmstashthr.op_pmstashflags)
451 #  define PmopSTASH_flags_set(o,flags) ((o)->op_pmstashstartu.op_pmstashthr.op_pmstashflags = flags)
452 #  define PmopSTASH(o)         (PmopSTASHPV(o)                                     \
453                                 ? gv_stashpv((o)->op_pmstashstartu.op_pmstashthr.op_pmstashpv,   \
454                                             GV_ADD | PmopSTASH_flags(o)) : NULL)
455 #  define PmopSTASH_set(o,hv)  (PmopSTASHPV_set(o, (hv) ? HvNAME_get(hv) : NULL), \
456                                 PmopSTASH_flags_set(o,                            \
457                                             ((hv) && HvNAME_HEK(hv) &&           \
458                                                         HvNAMEUTF8(hv))           \
459                                                 ? SVf_UTF8                        \
460                                                 : 0))
461 #  define PmopSTASH_free(o)     PerlMemShared_free(PmopSTASHPV(o))
462
463 #else
464 #  define PmopSTASH(o)                                                  \
465     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
466 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
467 #    define PmopSTASH_set(o,hv)         ({                              \
468         assert((o)->op_pmflags & PMf_ONCE);                             \
469         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
470     })
471 #  else
472 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
473 #  endif
474 #  define PmopSTASHPV(o)        (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
475    /* op_pmstashstartu.op_pmstash is not refcounted */
476 #  define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
477 /* Note that if this becomes non-empty, then S_forget_pmop in op.c will need
478    changing */
479 #  define PmopSTASH_free(o)    
480 #endif
481
482 struct svop {
483     BASEOP
484     SV *        op_sv;
485 };
486
487 struct padop {
488     BASEOP
489     PADOFFSET   op_padix;
490 };
491
492 struct pvop {
493     BASEOP
494     char *      op_pv;
495 };
496
497 struct loop {
498     BASEOP
499     OP *        op_first;
500     OP *        op_last;
501     OP *        op_redoop;
502     OP *        op_nextop;
503     OP *        op_lastop;
504 };
505
506 #define cUNOPx(o)       ((UNOP*)o)
507 #define cBINOPx(o)      ((BINOP*)o)
508 #define cLISTOPx(o)     ((LISTOP*)o)
509 #define cLOGOPx(o)      ((LOGOP*)o)
510 #define cPMOPx(o)       ((PMOP*)o)
511 #define cSVOPx(o)       ((SVOP*)o)
512 #define cPADOPx(o)      ((PADOP*)o)
513 #define cPVOPx(o)       ((PVOP*)o)
514 #define cCOPx(o)        ((COP*)o)
515 #define cLOOPx(o)       ((LOOP*)o)
516
517 #define cUNOP           cUNOPx(PL_op)
518 #define cBINOP          cBINOPx(PL_op)
519 #define cLISTOP         cLISTOPx(PL_op)
520 #define cLOGOP          cLOGOPx(PL_op)
521 #define cPMOP           cPMOPx(PL_op)
522 #define cSVOP           cSVOPx(PL_op)
523 #define cPADOP          cPADOPx(PL_op)
524 #define cPVOP           cPVOPx(PL_op)
525 #define cCOP            cCOPx(PL_op)
526 #define cLOOP           cLOOPx(PL_op)
527
528 #define cUNOPo          cUNOPx(o)
529 #define cBINOPo         cBINOPx(o)
530 #define cLISTOPo        cLISTOPx(o)
531 #define cLOGOPo         cLOGOPx(o)
532 #define cPMOPo          cPMOPx(o)
533 #define cSVOPo          cSVOPx(o)
534 #define cPADOPo         cPADOPx(o)
535 #define cPVOPo          cPVOPx(o)
536 #define cCOPo           cCOPx(o)
537 #define cLOOPo          cLOOPx(o)
538
539 #define kUNOP           cUNOPx(kid)
540 #define kBINOP          cBINOPx(kid)
541 #define kLISTOP         cLISTOPx(kid)
542 #define kLOGOP          cLOGOPx(kid)
543 #define kPMOP           cPMOPx(kid)
544 #define kSVOP           cSVOPx(kid)
545 #define kPADOP          cPADOPx(kid)
546 #define kPVOP           cPVOPx(kid)
547 #define kCOP            cCOPx(kid)
548 #define kLOOP           cLOOPx(kid)
549
550
551 #ifdef USE_ITHREADS
552 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
553 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
554                                  && GvIN_PAD(v))
555 #  define       IS_PADCONST(v)  (v && SvREADONLY(v))
556 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
557                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
558 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
559                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
560 #else
561 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
562 #  define       IS_PADGV(v)     FALSE
563 #  define       IS_PADCONST(v)  FALSE
564 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
565 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
566 #endif
567
568 #define cGVOP_gv                cGVOPx_gv(PL_op)
569 #define cGVOPo_gv               cGVOPx_gv(o)
570 #define kGVOP_gv                cGVOPx_gv(kid)
571 #define cSVOP_sv                cSVOPx_sv(PL_op)
572 #define cSVOPo_sv               cSVOPx_sv(o)
573 #define kSVOP_sv                cSVOPx_sv(kid)
574
575 #ifndef PERL_CORE
576 #  define Nullop ((OP*)NULL)
577 #endif
578
579 /* Lowest byte of PL_opargs */
580 #define OA_MARK 1
581 #define OA_FOLDCONST 2
582 #define OA_RETSCALAR 4
583 #define OA_TARGET 8
584 #define OA_TARGLEX 16
585 #define OA_OTHERINT 32
586 #define OA_DANGEROUS 64
587 #define OA_DEFGV 128
588
589 /* The next 4 bits encode op class information */
590 #define OCSHIFT 8
591
592 #define OA_CLASS_MASK (15 << OCSHIFT)
593
594 #define OA_BASEOP (0 << OCSHIFT)
595 #define OA_UNOP (1 << OCSHIFT)
596 #define OA_BINOP (2 << OCSHIFT)
597 #define OA_LOGOP (3 << OCSHIFT)
598 #define OA_LISTOP (4 << OCSHIFT)
599 #define OA_PMOP (5 << OCSHIFT)
600 #define OA_SVOP (6 << OCSHIFT)
601 #define OA_PADOP (7 << OCSHIFT)
602 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
603 #define OA_LOOP (9 << OCSHIFT)
604 #define OA_COP (10 << OCSHIFT)
605 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
606 #define OA_FILESTATOP (12 << OCSHIFT)
607 #define OA_LOOPEXOP (13 << OCSHIFT)
608
609 #define OASHIFT 12
610
611 /* Remaining nybbles of PL_opargs */
612 #define OA_SCALAR 1
613 #define OA_LIST 2
614 #define OA_AVREF 3
615 #define OA_HVREF 4
616 #define OA_CVREF 5
617 #define OA_FILEREF 6
618 #define OA_SCALARREF 7
619 #define OA_OPTIONAL 8
620
621 /* Op_REFCNT is a reference count at the head of each op tree: needed
622  * since the tree is shared between threads, and between cloned closure
623  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
624  * this count.
625  * The same mutex is used to protect the refcounts of the reg_trie_data
626  * and reg_ac_data structures, which are shared between duplicated
627  * regexes.
628  */
629
630 #ifdef USE_ITHREADS
631 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
632 #  ifdef PERL_CORE
633 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
634 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
635 #  else
636 #    define OP_REFCNT_LOCK              op_refcnt_lock()
637 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
638 #  endif
639 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
640 #else
641 #  define OP_REFCNT_INIT                NOOP
642 #  define OP_REFCNT_LOCK                NOOP
643 #  define OP_REFCNT_UNLOCK              NOOP
644 #  define OP_REFCNT_TERM                NOOP
645 #endif
646
647 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
648 #ifdef PERL_DEBUG_READONLY_OPS
649 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
650 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
651 #else
652 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
653 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
654 #endif
655
656 /* flags used by Perl_load_module() */
657 #define PERL_LOADMOD_DENY               0x1     /* no Module */
658 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
659 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* use Module (...) */
660
661 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
662 #define ref(o, type) doref(o, type, TRUE)
663 #endif
664
665 /*
666 =head1 Optree Manipulation Functions
667
668 =for apidoc Am|OP*|LINKLIST|OP *o
669 Given the root of an optree, link the tree in execution order using the
670 C<op_next> pointers and return the first op executed. If this has
671 already been done, it will not be redone, and C<< o->op_next >> will be
672 returned. If C<< o->op_next >> is not already set, I<o> should be at
673 least an C<UNOP>.
674
675 =cut
676 */
677
678 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
679
680 /* no longer used anywhere in core */
681 #ifndef PERL_CORE
682 #define cv_ckproto(cv, gv, p) \
683    cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
684 #endif
685
686 #ifdef PERL_CORE
687 #  define my(o) my_attrs((o), NULL)
688 #endif
689
690 #ifdef USE_REENTRANT_API
691 #include "reentr.h"
692 #endif
693
694 #if defined(PL_OP_SLAB_ALLOC)
695 #define NewOp(m,var,c,type)     \
696         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
697 #define NewOpSz(m,var,size)     \
698         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
699 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
700 #else
701 #define NewOp(m, var, c, type)  \
702         (var = (MEM_WRAP_CHECK_(c,type) \
703          (type*)PerlMemShared_calloc(c, sizeof(type))))
704 #define NewOpSz(m, var, size)   \
705         (var = (OP*)PerlMemShared_calloc(1, size))
706 #define FreeOp(p) PerlMemShared_free(p)
707 #endif
708
709 struct block_hooks {
710     U32     bhk_flags;
711     void    (*bhk_start)        (pTHX_ int full);
712     void    (*bhk_pre_end)      (pTHX_ OP **seq);
713     void    (*bhk_post_end)     (pTHX_ OP **seq);
714     void    (*bhk_eval)         (pTHX_ OP *const saveop);
715 };
716
717 /*
718 =head1 Compile-time scope hooks
719
720 =for apidoc mx|U32|BhkFLAGS|BHK *hk
721 Return the BHK's flags.
722
723 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
724 Return an entry from the BHK structure. I<which> is a preprocessor token
725 indicating which entry to return. If the appropriate flag is not set
726 this will return NULL. The type of the return value depends on which
727 entry you ask for.
728
729 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
730 Set an entry in the BHK structure, and set the flags to indicate it is
731 valid. I<which> is a preprocessing token indicating which entry to set.
732 The type of I<ptr> depends on the entry.
733
734 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
735 Temporarily disable an entry in this BHK structure, by clearing the
736 appropriate flag. I<which> is a preprocessor token indicating which
737 entry to disable.
738
739 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
740 Re-enable an entry in this BHK structure, by setting the appropriate
741 flag. I<which> is a preprocessor token indicating which entry to enable.
742 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
743 pointer.
744
745 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
746 Call all the registered block hooks for type I<which>. I<which> is a
747 preprocessing token; the type of I<arg> depends on I<which>.
748
749 =cut
750 */
751
752 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
753
754 #define BHKf_bhk_start      0x01
755 #define BHKf_bhk_pre_end    0x02
756 #define BHKf_bhk_post_end   0x04
757 #define BHKf_bhk_eval       0x08
758
759 #define BhkENTRY(hk, which) \
760     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
761
762 #define BhkENABLE(hk, which) \
763     STMT_START { \
764         BhkFLAGS(hk) |= BHKf_ ## which; \
765         assert(BhkENTRY(hk, which)); \
766     } STMT_END
767
768 #define BhkDISABLE(hk, which) \
769     STMT_START { \
770         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
771     } STMT_END
772
773 #define BhkENTRY_set(hk, which, ptr) \
774     STMT_START { \
775         (hk)->which = ptr; \
776         BhkENABLE(hk, which); \
777     } STMT_END
778
779 #define CALL_BLOCK_HOOKS(which, arg) \
780     STMT_START { \
781         if (PL_blockhooks) { \
782             I32 i; \
783             for (i = av_len(PL_blockhooks); i >= 0; i--) { \
784                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
785                 BHK *hk; \
786                 \
787                 assert(SvIOK(sv)); \
788                 if (SvUOK(sv)) \
789                     hk = INT2PTR(BHK *, SvUVX(sv)); \
790                 else \
791                     hk = INT2PTR(BHK *, SvIVX(sv)); \
792                 \
793                 if (BhkENTRY(hk, which)) \
794                     BhkENTRY(hk, which)(aTHX_ arg); \
795             } \
796         } \
797     } STMT_END
798
799 /* flags for rv2cv_op_cv */
800
801 #define RV2CVOPCV_MARK_EARLY     0x00000001
802 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
803
804 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
805
806 /* flags for op_lvalue_flags */
807
808 #define OP_LVALUE_NO_CROAK 1
809
810 /*
811 =head1 Custom Operators
812
813 =for apidoc Am|U32|XopFLAGS|XOP *xop
814 Return the XOP's flags.
815
816 =for apidoc Am||XopENTRY|XOP *xop|which
817 Return a member of the XOP structure. I<which> is a cpp token indicating
818 which entry to return. If the member is not set this will return a
819 default value. The return type depends on I<which>.
820
821 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
822 Set a member of the XOP structure. I<which> is a cpp token indicating
823 which entry to set. See L<perlguts/"Custom Operators"> for details about
824 the available members and how they are used.
825
826 =for apidoc Am|void|XopDISABLE|XOP *xop|which
827 Temporarily disable a member of the XOP, by clearing the appropriate flag.
828
829 =for apidoc Am|void|XopENABLE|XOP *xop|which
830 Reenable a member of the XOP which has been disabled.
831
832 =cut
833 */
834
835 struct custom_op {
836     U32             xop_flags;    
837     const char     *xop_name;
838     const char     *xop_desc;
839     U32             xop_class;
840     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
841 };
842
843 #define XopFLAGS(xop) ((xop)->xop_flags)
844
845 #define XOPf_xop_name   0x01
846 #define XOPf_xop_desc   0x02
847 #define XOPf_xop_class  0x04
848 #define XOPf_xop_peep   0x08
849
850 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
851 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
852 #define XOPd_xop_class  OA_BASEOP
853 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
854
855 #define XopENTRY_set(xop, which, to) \
856     STMT_START { \
857         (xop)->which = (to); \
858         (xop)->xop_flags |= XOPf_ ## which; \
859     } STMT_END
860
861 #define XopENTRY(xop, which) \
862     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
863
864 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
865 #define XopENABLE(xop, which) \
866     STMT_START { \
867         (xop)->xop_flags |= XOPf_ ## which; \
868         assert(XopENTRY(xop, which)); \
869     } STMT_END
870
871 /*
872 =head1 Optree Manipulation Functions
873
874 =for apidoc Am|const char *|OP_NAME|OP *o
875 Return the name of the provided OP. For core ops this looks up the name
876 from the op_type; for custom ops from the op_ppaddr.
877
878 =for apidoc Am|const char *|OP_DESC|OP *o
879 Return a short description of the provided OP.
880
881 =for apidoc Am|U32|OP_CLASS|OP *o
882 Return the class of the provided OP: that is, which of the *OP
883 structures it uses. For core ops this currently gets the information out
884 of PL_opargs, which does not always accurately reflect the type used.
885 For custom ops the type is returned from the registration, and it is up
886 to the registree to ensure it is accurate. The value returned will be
887 one of the OA_* constants from op.h.
888
889 =cut
890 */
891
892 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
893                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_name) \
894                     : PL_op_name[(o)->op_type])
895 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
896                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_desc) \
897                     : PL_op_desc[(o)->op_type])
898 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
899                      ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_class) \
900                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
901
902 #define newSUB(f, o, p, b)      Perl_newATTRSUB(aTHX_ (f), (o), (p), NULL, (b))
903
904 #ifdef PERL_MAD
905 #  define MAD_NULL 1
906 #  define MAD_PV 2
907 #  define MAD_OP 3
908 #  define MAD_SV 4
909
910 struct madprop {
911     MADPROP* mad_next;
912     void *mad_val;
913     U32 mad_vlen;
914 /*    short mad_count; */
915     char mad_key;
916     char mad_type;
917 };
918
919 struct token {
920     I32 tk_type;
921     YYSTYPE tk_lval;
922     MADPROP* tk_mad;
923 };
924 #endif
925
926 /*
927  * Values that can be held by mad_key :
928  * ^       unfilled head spot
929  * ,       literal ,
930  * ;       literal ; (blank if implicit ; at end of block)
931  * :       literal : from ?: or attr list
932  * +       unary +
933  * ?       literal ? from ?:
934  * (       literal (
935  * )       literal )
936  * [       literal [
937  * ]       literal ]
938  * {       literal {
939  * }       literal }
940  * @       literal @ sigil
941  * $       literal $ sigil
942  * *       literal * sigil
943  * !       use is source filtered
944  * &       & or sub
945  * #       whitespace/comment following ; or }
946  * #       $# sigil
947  * 1       1st ; from for(;;)
948  * 1       retired protasis
949  * 2       2nd ; from for(;;)
950  * 2       retired apodosis
951  * 3       C-style for list
952  * a       sub or var attributes
953  * a       non-method arrow operator
954  * A       method arrow operator
955  * A       use import args
956  * b       format block
957  * B       retired stub block
958  * C       constant conditional op
959  * d       declarator
960  * D       do block
961  * e       unreached "else" (see C)
962  * e       expression producing E
963  * E       tr/E/R/, /E/
964  * f       folded constant op
965  * F       peg op for format
966  * g       op was forced to be a word
967  * i       if/unless modifier
968  * I       if/elsif/unless statement
969  * k       local declarator
970  * K       retired kid op
971  * l       last index of array ($#foo)
972  * L       label
973  * m       modifier on regex
974  * n       sub or format name
975  * o       current operator/declarator name
976  * o       else/continue
977  * O       generic optimized op
978  * p       peg to hold extra whitespace at statement level
979  * P       peg op for package declaration
980  * q       opening quote
981  * =       quoted material
982  * Q       closing quote
983  * Q       optimized qw//
984  * r       expression producing R
985  * R       tr/E/R/ s/E/R/
986  * s       sub signature
987  * S       use import stub (no import)
988  * S       retired sort block
989  * t       unreached "then" (see C)
990  * U       use import op
991  * v       private sv of for loop
992  * V       use version
993  * w       while/until modifier
994  * W       while/for statement
995  * x       optimized qw
996  * X       random thing
997  * _       whitespace/comments preceding anything else
998  * ~       =~ operator
999  */
1000
1001 /*
1002  * Local variables:
1003  * c-indentation-style: bsd
1004  * c-basic-offset: 4
1005  * indent-tabs-mode: t
1006  * End:
1007  *
1008  * ex: set ts=8 sts=4 sw=4 noet:
1009  */