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