Merge branch 'feature/package-name-version' into blead
[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
40 #define OPCODE U16
41
42 #ifdef PERL_MAD
43 #  define MADPROP_IN_BASEOP     MADPROP*        op_madprop;
44 #else
45 #  define MADPROP_IN_BASEOP
46 #endif
47
48 typedef PERL_BITFIELD16 Optype;
49
50 #ifdef BASEOP_DEFINITION
51 #define BASEOP BASEOP_DEFINITION
52 #else
53 #define BASEOP                          \
54     OP*         op_next;                \
55     OP*         op_sibling;             \
56     OP*         (CPERLscope(*op_ppaddr))(pTHX);         \
57     MADPROP_IN_BASEOP                   \
58     PADOFFSET   op_targ;                \
59     PERL_BITFIELD16 op_type:9;          \
60     PERL_BITFIELD16 op_opt:1;           \
61     PERL_BITFIELD16 op_latefree:1;      \
62     PERL_BITFIELD16 op_latefreed:1;     \
63     PERL_BITFIELD16 op_attached:1;      \
64     PERL_BITFIELD16 op_spare:3;         \
65     U8          op_flags;               \
66     U8          op_private;
67 #endif
68
69 /* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
70    Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
71    then all the other bit-fields before/after it should change their
72    types too to let VC pack them into the same 4 byte integer.*/
73
74 #define OP_GIMME(op,dfl) \
75         (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID   ? G_VOID   : \
76          ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
77          ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST   ? G_ARRAY   : \
78          dfl)
79
80 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
81
82 /*
83 =head1 "Gimme" Values
84
85 =for apidoc Amn|U32|GIMME_V
86 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
87 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
88 respectively.
89
90 =for apidoc Amn|U32|GIMME
91 A backward-compatible version of C<GIMME_V> which can only return
92 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
93 Deprecated.  Use C<GIMME_V> instead.
94
95 =cut
96 */
97
98 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
99
100 /* Public flags */
101
102 #define OPf_WANT        3       /* Mask for "want" bits: */
103 #define  OPf_WANT_VOID   1      /*   Want nothing */
104 #define  OPf_WANT_SCALAR 2      /*   Want single value */
105 #define  OPf_WANT_LIST   3      /*   Want list of any length */
106 #define OPf_KIDS        4       /* There is a firstborn child. */
107 #define OPf_PARENS      8       /* This operator was parenthesized. */
108                                 /*  (Or block needs explicit scope entry.) */
109 #define OPf_REF         16      /* Certified reference. */
110                                 /*  (Return container, not containee). */
111 #define OPf_MOD         32      /* Will modify (lvalue). */
112 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
113 #define OPf_SPECIAL     128     /* Do something weird for this op: */
114                                 /*  On local LVAL, don't init local value. */
115                                 /*  On OP_SORT, subroutine is inlined. */
116                                 /*  On OP_NOT, inversion was implicit. */
117                                 /*  On OP_LEAVE, don't restore curpm. */
118                                 /*  On truncate, we truncate filehandle */
119                                 /*  On control verbs, we saw no label */
120                                 /*  On flipflop, we saw ... instead of .. */
121                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
122                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
123                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
124                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
125                                 /*  On OP_ENTERITER, loop var is per-thread */
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_AELEMFAST, indiciates pad var */
134                                 /*  On OP_REQUIRE, was seen as CORE::require */
135                                 /*  On OP_ENTERWHEN, there's no condition */
136                                 /*  On OP_BREAK, an implicit break */
137                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
138                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
139                                     reference to the new anon hash or array */
140                                 /*  On OP_ENTER, store caller context */
141                                 /*  On OP_HELEM and OP_HSLICE, localization will be followed
142                                     by assignment, so do not wipe the target if it is special
143                                     (e.g. a glob or a magic SV) */
144
145 /* old names; don't use in new code, but don't break them, either */
146 #define OPf_LIST        OPf_WANT_LIST
147 #define OPf_KNOW        OPf_WANT
148
149 #define GIMME \
150           (PL_op->op_flags & OPf_WANT                                   \
151            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
152               ? G_ARRAY                                                 \
153               : G_SCALAR)                                               \
154            : dowantarray())
155
156 /* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
157  * bits of PL_hints in op_private */
158
159 /* Private for lvalues */
160 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
161
162 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
163 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
164
165 /* Private for OP_AASSIGN */
166 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
167
168 /* Private for OP_SASSIGN */
169 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
170 #define OPpASSIGN_CV_TO_GV      128     /* Possible optimisation for constants. */
171
172 /* Private for OP_MATCH and OP_SUBST{,CONST} */
173 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
174
175 /* Private for OP_TRANS */
176 #define OPpTRANS_FROM_UTF       1
177 #define OPpTRANS_TO_UTF         2
178 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
179 #define OPpTRANS_SQUASH         8
180     /* 16 is used for OPpTARGET_MY */
181 #define OPpTRANS_COMPLEMENT     32
182 #define OPpTRANS_GROWS          64
183 #define OPpTRANS_DELETE         128
184 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
185
186 /* Private for OP_REPEAT */
187 #define OPpREPEAT_DOLIST        64      /* List replication. */
188
189 /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
190 #define OPpDEREF                (32|64) /* autovivify: Want ref to something: */
191 #define OPpDEREF_AV             32      /*   Want ref to AV. */
192 #define OPpDEREF_HV             64      /*   Want ref to HV. */
193 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
194   /* OP_ENTERSUB only */
195 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
196 #define OPpENTERSUB_HASTARG     32      /* Called from OP tree. */
197 #define OPpENTERSUB_NOMOD       64      /* Immune to mod() for :attrlist. */
198   /* OP_ENTERSUB and OP_RV2CV only */
199 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
200 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
201 #define OPpENTERSUB_INARGS      4       /* Lval used as arg to a sub. */
202   /* OP_GV only */
203 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
204   /* OP_?ELEM only */
205 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
206   /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
207 #define OPpOUR_INTRO            16      /* Variable was in an our() */
208   /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM */
209 #define OPpMAYBE_LVSUB          8       /* We might be an lvalue to return */
210   /* OP_PADSV only */
211 #define OPpPAD_STATE            16      /* is a "state" pad */
212   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
213
214   /* OP_RV2GV only */
215 #define OPpDONT_INIT_GV         4       /* Call gv_fetchpv with GV_NOINIT */
216 /* (Therefore will return whatever is currently in the symbol table, not
217    guaranteed to be a PVGV)  */
218
219   /* OP_RV2CV only */
220 #define OPpMAY_RETURN_CONSTANT  1       /* If a constant sub, return the constant */
221
222 /* Private for OPs with TARGLEX */
223   /* (lower bits may carry MAXARG) */
224 #define OPpTARGET_MY            16      /* Target is PADMY. */
225
226 /* Private for OP_ENTERITER and OP_ITER */
227 #define OPpITER_REVERSED        4       /* for (reverse ...) */
228 #define OPpITER_DEF             8       /* for $_ or for my $_ */
229
230 /* Private for OP_CONST */
231 #define OPpCONST_NOVER          2       /* no 6; */
232 #define OPpCONST_SHORTCIRCUIT   4       /* eg the constant 5 in (5 || foo) */
233 #define OPpCONST_STRICT         8       /* bearword subject to strict 'subs' */
234 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
235 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
236 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
237 #define OPpCONST_WARNING        128     /* Was a $^W translated to constant. */
238
239 /* Private for OP_FLIP/FLOP */
240 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
241
242 /* Private for OP_LIST */
243 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
244
245 /* Private for OP_DELETE */
246 #define OPpSLICE                64      /* Operating on a list of keys */
247 /* Also OPpLVAL_INTRO (128) */
248
249 /* Private for OP_EXISTS */
250 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
251
252 /* Private for OP_SORT */
253 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
254 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
255 #define OPpSORT_REVERSE         4       /* Reversed sort */
256 #define OPpSORT_INPLACE         8       /* sort in-place; eg @a = sort @a */
257 #define OPpSORT_DESCEND         16      /* Descending sort */
258 #define OPpSORT_QSORT           32      /* Use quicksort (not mergesort) */
259 #define OPpSORT_STABLE          64      /* Use a stable algorithm */
260
261 /* Private for OP_OPEN and OP_BACKTICK */
262 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
263 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
264 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
265 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
266
267 /* Private for OP_EXIT, HUSH also for OP_DIE */
268 #define OPpHUSH_VMSISH          64      /* hush DCL exit msg vmsish mode*/
269 #define OPpEXIT_VMSISH          128     /* exit(0) vs. exit(1) vmsish mode*/
270
271 /* Private for OP_FTXXX */
272 #define OPpFT_ACCESS            2       /* use filetest 'access' */
273 #define OPpFT_STACKED           4       /* stacked filetest, as in "-f -x $f" */
274
275 /* Private for OP_(MAP|GREP)(WHILE|START) */
276 #define OPpGREP_LEX             2       /* iterate over lexical $_ */
277     
278 /* Private for OP_ENTEREVAL */
279 #define OPpEVAL_HAS_HH          2       /* Does it have a copy of %^H */
280     
281 struct op {
282     BASEOP
283 };
284
285 struct unop {
286     BASEOP
287     OP *        op_first;
288 };
289
290 struct binop {
291     BASEOP
292     OP *        op_first;
293     OP *        op_last;
294 };
295
296 struct logop {
297     BASEOP
298     OP *        op_first;
299     OP *        op_other;
300 };
301
302 struct listop {
303     BASEOP
304     OP *        op_first;
305     OP *        op_last;
306 };
307
308 struct pmop {
309     BASEOP
310     OP *        op_first;
311     OP *        op_last;
312 #ifdef USE_ITHREADS
313     IV          op_pmoffset;
314 #else
315     REGEXP *    op_pmregexp;            /* compiled expression */
316 #endif
317     U32         op_pmflags;
318     union {
319         OP *    op_pmreplroot;          /* For OP_SUBST */
320 #ifdef USE_ITHREADS
321         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
322 #else
323         GV *    op_pmtargetgv;
324 #endif
325     }   op_pmreplrootu;
326     union {
327         OP *    op_pmreplstart; /* Only used in OP_SUBST */
328 #ifdef USE_ITHREADS
329         char *  op_pmstashpv;   /* Only used in OP_MATCH, with PMf_ONCE set */
330 #else
331         HV *    op_pmstash;
332 #endif
333     }           op_pmstashstartu;
334 };
335
336 #ifdef USE_ITHREADS
337 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
338                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
339 /* The assignment is just to enforce type safety (or at least get a warning).
340  */
341 /* With first class regexps not via a reference one needs to assign
342    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
343    is cheaper. I guess we could allow NULL, but the check above would get
344    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
345 /* BEWARE - something that calls this macro passes (r) which has a side
346    effect.  */
347 #define PM_SETRE(o,r)   STMT_START {                                    \
348                             REGEXP *const _pm_setre = (r);              \
349                             assert(_pm_setre);                          \
350                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
351                         } STMT_END
352 #else
353 #define PM_GETRE(o)     ((o)->op_pmregexp)
354 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
355 #endif
356
357
358 #define PMf_RETAINT     0x00000040      /* taint $1 etc. if target tainted */
359 #define PMf_ONCE        0x00000080      /* match successfully only once per
360                                            reset, with related flag RXf_USED
361                                            in re->extflags holding state.
362                                            This is used only for ?? matches,
363                                            and only on OP_MATCH and OP_QR */
364
365 #define PMf_UNUSED      0x00000100      /* free for use */
366 #define PMf_MAYBE_CONST 0x00000200      /* replacement contains variables */
367
368 #define PMf_USED        0x00000400      /* PMf_ONCE has matched successfully.
369                                            Not used under threading. */
370
371 #define PMf_CONST       0x00000800      /* subst replacement is constant */
372 #define PMf_KEEP        0x00001000      /* keep 1st runtime pattern forever */
373 #define PMf_GLOBAL      0x00002000      /* pattern had a g modifier */
374 #define PMf_CONTINUE    0x00004000      /* don't reset pos() if //g fails */
375 #define PMf_EVAL        0x00008000      /* evaluating replacement as expr */
376
377 /* The following flags have exact equivalents in regcomp.h with the prefix RXf_
378  * which are stored in the regexp->extflags member. If you change them here,
379  * you have to change them there, and vice versa.
380  */
381 #define PMf_MULTILINE   0x00000001      /* assume multiple lines */
382 #define PMf_SINGLELINE  0x00000002      /* assume single line */
383 #define PMf_FOLD        0x00000004      /* case insensitivity */
384 #define PMf_EXTENDED    0x00000008      /* chuck embedded whitespace */
385 #define PMf_KEEPCOPY    0x00000010      /* copy the string when matching */
386 #define PMf_LOCALE      0x00000020      /* use locale for character types */
387
388 /* mask of bits that need to be transfered to re->extflags */
389 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED|PMf_KEEPCOPY)
390
391 #ifdef USE_ITHREADS
392
393 #  define PmopSTASHPV(o)                                                \
394     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstashpv : NULL)
395 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
396 #    define PmopSTASHPV_set(o,pv)       ({                              \
397         assert((o)->op_pmflags & PMf_ONCE);                             \
398         ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv));        \
399     })
400 #  else
401 #    define PmopSTASHPV_set(o,pv)                                       \
402     ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv))
403 #  endif
404 #  define PmopSTASH(o)          (PmopSTASHPV(o) \
405                                  ? gv_stashpv((o)->op_pmstashstartu.op_pmstashpv,GV_ADD) : NULL)
406 #  define PmopSTASH_set(o,hv)   PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : NULL))
407 #  define PmopSTASH_free(o)     PerlMemShared_free(PmopSTASHPV(o))
408
409 #else
410 #  define PmopSTASH(o)                                                  \
411     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
412 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
413 #    define PmopSTASH_set(o,hv)         ({                              \
414         assert((o)->op_pmflags & PMf_ONCE);                             \
415         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
416     })
417 #  else
418 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
419 #  endif
420 #  define PmopSTASHPV(o)        (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
421    /* op_pmstashstartu.op_pmstash is not refcounted */
422 #  define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
423 /* Note that if this becomes non-empty, then S_forget_pmop in op.c will need
424    changing */
425 #  define PmopSTASH_free(o)    
426 #endif
427
428 struct svop {
429     BASEOP
430     SV *        op_sv;
431 };
432
433 struct padop {
434     BASEOP
435     PADOFFSET   op_padix;
436 };
437
438 struct pvop {
439     BASEOP
440     char *      op_pv;
441 };
442
443 struct loop {
444     BASEOP
445     OP *        op_first;
446     OP *        op_last;
447     OP *        op_redoop;
448     OP *        op_nextop;
449     OP *        op_lastop;
450 };
451
452 #define cUNOPx(o)       ((UNOP*)o)
453 #define cBINOPx(o)      ((BINOP*)o)
454 #define cLISTOPx(o)     ((LISTOP*)o)
455 #define cLOGOPx(o)      ((LOGOP*)o)
456 #define cPMOPx(o)       ((PMOP*)o)
457 #define cSVOPx(o)       ((SVOP*)o)
458 #define cPADOPx(o)      ((PADOP*)o)
459 #define cPVOPx(o)       ((PVOP*)o)
460 #define cCOPx(o)        ((COP*)o)
461 #define cLOOPx(o)       ((LOOP*)o)
462
463 #define cUNOP           cUNOPx(PL_op)
464 #define cBINOP          cBINOPx(PL_op)
465 #define cLISTOP         cLISTOPx(PL_op)
466 #define cLOGOP          cLOGOPx(PL_op)
467 #define cPMOP           cPMOPx(PL_op)
468 #define cSVOP           cSVOPx(PL_op)
469 #define cPADOP          cPADOPx(PL_op)
470 #define cPVOP           cPVOPx(PL_op)
471 #define cCOP            cCOPx(PL_op)
472 #define cLOOP           cLOOPx(PL_op)
473
474 #define cUNOPo          cUNOPx(o)
475 #define cBINOPo         cBINOPx(o)
476 #define cLISTOPo        cLISTOPx(o)
477 #define cLOGOPo         cLOGOPx(o)
478 #define cPMOPo          cPMOPx(o)
479 #define cSVOPo          cSVOPx(o)
480 #define cPADOPo         cPADOPx(o)
481 #define cPVOPo          cPVOPx(o)
482 #define cCOPo           cCOPx(o)
483 #define cLOOPo          cLOOPx(o)
484
485 #define kUNOP           cUNOPx(kid)
486 #define kBINOP          cBINOPx(kid)
487 #define kLISTOP         cLISTOPx(kid)
488 #define kLOGOP          cLOGOPx(kid)
489 #define kPMOP           cPMOPx(kid)
490 #define kSVOP           cSVOPx(kid)
491 #define kPADOP          cPADOPx(kid)
492 #define kPVOP           cPVOPx(kid)
493 #define kCOP            cCOPx(kid)
494 #define kLOOP           cLOOPx(kid)
495
496
497 #ifdef USE_ITHREADS
498 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
499 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
500                                  && GvIN_PAD(v))
501 #  define       IS_PADCONST(v)  (v && SvREADONLY(v))
502 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
503                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
504 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
505                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
506 #else
507 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
508 #  define       IS_PADGV(v)     FALSE
509 #  define       IS_PADCONST(v)  FALSE
510 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
511 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
512 #endif
513
514 #define cGVOP_gv                cGVOPx_gv(PL_op)
515 #define cGVOPo_gv               cGVOPx_gv(o)
516 #define kGVOP_gv                cGVOPx_gv(kid)
517 #define cSVOP_sv                cSVOPx_sv(PL_op)
518 #define cSVOPo_sv               cSVOPx_sv(o)
519 #define kSVOP_sv                cSVOPx_sv(kid)
520
521 #ifndef PERL_CORE
522 #  define Nullop ((OP*)NULL)
523 #endif
524
525 /* Lowest byte-and-a-bit of PL_opargs */
526 #define OA_MARK 1
527 #define OA_FOLDCONST 2
528 #define OA_RETSCALAR 4
529 #define OA_TARGET 8
530 #define OA_RETINTEGER 16
531 #define OA_OTHERINT 32
532 #define OA_DANGEROUS 64
533 #define OA_DEFGV 128
534 #define OA_TARGLEX 256
535
536 /* The next 4 bits encode op class information */
537 #define OCSHIFT 9
538
539 #define OA_CLASS_MASK (15 << OCSHIFT)
540
541 #define OA_BASEOP (0 << OCSHIFT)
542 #define OA_UNOP (1 << OCSHIFT)
543 #define OA_BINOP (2 << OCSHIFT)
544 #define OA_LOGOP (3 << OCSHIFT)
545 #define OA_LISTOP (4 << OCSHIFT)
546 #define OA_PMOP (5 << OCSHIFT)
547 #define OA_SVOP (6 << OCSHIFT)
548 #define OA_PADOP (7 << OCSHIFT)
549 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
550 #define OA_LOOP (9 << OCSHIFT)
551 #define OA_COP (10 << OCSHIFT)
552 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
553 #define OA_FILESTATOP (12 << OCSHIFT)
554 #define OA_LOOPEXOP (13 << OCSHIFT)
555
556 #define OASHIFT 13
557
558 /* Remaining nybbles of PL_opargs */
559 #define OA_SCALAR 1
560 #define OA_LIST 2
561 #define OA_AVREF 3
562 #define OA_HVREF 4
563 #define OA_CVREF 5
564 #define OA_FILEREF 6
565 #define OA_SCALARREF 7
566 #define OA_OPTIONAL 8
567
568 /* Op_REFCNT is a reference count at the head of each op tree: needed
569  * since the tree is shared between threads, and between cloned closure
570  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
571  * this count.
572  * The same mutex is used to protect the refcounts of the reg_trie_data
573  * and reg_ac_data structures, which are shared between duplicated
574  * regexes.
575  */
576
577 #ifdef USE_ITHREADS
578 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
579 #  ifdef PERL_CORE
580 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
581 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
582 #  else
583 #    define OP_REFCNT_LOCK              op_refcnt_lock()
584 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
585 #  endif
586 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
587 #else
588 #  define OP_REFCNT_INIT                NOOP
589 #  define OP_REFCNT_LOCK                NOOP
590 #  define OP_REFCNT_UNLOCK              NOOP
591 #  define OP_REFCNT_TERM                NOOP
592 #endif
593
594 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
595 #ifdef PERL_DEBUG_READONLY_OPS
596 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
597 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
598 #else
599 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
600 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
601 #endif
602
603 /* flags used by Perl_load_module() */
604 #define PERL_LOADMOD_DENY               0x1     /* no Module */
605 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
606 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* use Module (...) */
607
608 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
609 #define ref(o, type) doref(o, type, TRUE)
610 #endif
611
612 /* no longer used anywhere in core */
613 #ifndef PERL_CORE
614 #define cv_ckproto(cv, gv, p) \
615    cv_ckproto_len((cv), (gv), (p), (p) ? strlen(p) : 0)
616 #endif
617
618 #ifdef PERL_CORE
619 #  define my(o) my_attrs((o), NULL)
620 #endif
621
622 #ifdef USE_REENTRANT_API
623 #include "reentr.h"
624 #endif
625
626 #if defined(PL_OP_SLAB_ALLOC)
627 #define NewOp(m,var,c,type)     \
628         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
629 #define NewOpSz(m,var,size)     \
630         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
631 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
632 #else
633 #define NewOp(m, var, c, type)  \
634         (var = (MEM_WRAP_CHECK_(c,type) \
635          (type*)PerlMemShared_calloc(c, sizeof(type))))
636 #define NewOpSz(m, var, size)   \
637         (var = (OP*)PerlMemShared_calloc(1, size))
638 #define FreeOp(p) PerlMemShared_free(p)
639 #endif
640
641 #ifdef PERL_MAD
642 #  define MAD_NULL 1
643 #  define MAD_PV 2
644 #  define MAD_OP 3
645 #  define MAD_SV 4
646
647 struct madprop {
648     MADPROP* mad_next;
649     void *mad_val;
650     U32 mad_vlen;
651 /*    short mad_count; */
652     char mad_key;
653     char mad_type;
654 };
655
656 struct token {
657     I32 tk_type;
658     YYSTYPE tk_lval;
659     MADPROP* tk_mad;
660 };
661 #endif
662
663 /*
664  * Values that can be held by mad_key :
665  * ^       unfilled head spot
666  * ,       literal ,
667  * ;       literal ; (blank if implicit ; at end of block)
668  * :       literal : from ?: or attr list
669  * +       unary +
670  * ?       literal ? from ?:
671  * (       literal (
672  * )       literal )
673  * [       literal [
674  * ]       literal ]
675  * {       literal {
676  * }       literal }
677  * @       literal @ sigil
678  * $       literal $ sigil
679  * *       literal * sigil
680  * !       use is source filtered
681  * &       & or sub
682  * #       whitespace/comment following ; or }
683  * #       $# sigil
684  * 1       1st ; from for(;;)
685  * 1       retired protasis
686  * 2       2nd ; from for(;;)
687  * 2       retired apodosis
688  * 3       C-style for list
689  * a       sub or var attributes
690  * a       non-method arrow operator
691  * A       method arrow operator
692  * A       use import args
693  * b       format block
694  * B       retired stub block
695  * C       constant conditional op
696  * d       declarator
697  * D       do block
698  * e       unreached "else" (see C)
699  * e       expression producing E
700  * E       tr/E/R/, /E/
701  * f       folded constant op
702  * F       peg op for format
703  * g       op was forced to be a word
704  * i       if/unless modifier
705  * I       if/elsif/unless statement
706  * k       local declarator
707  * K       retired kid op
708  * l       last index of array ($#foo)
709  * L       label
710  * m       modifier on regex
711  * n       sub or format name
712  * o       current operator/declarator name
713  * o       else/continue
714  * O       generic optimized op
715  * p       peg to hold extra whitespace at statement level
716  * P       peg op for package declaration
717  * q       opening quote
718  * =       quoted material
719  * Q       closing quote
720  * Q       optimized qw//
721  * r       expression producing R
722  * R       tr/E/R/ s/E/R/
723  * s       sub signature
724  * S       use import stub (no import)
725  * S       retired sort block
726  * t       unreached "then" (see C)
727  * U       use import op
728  * v       private sv of for loop
729  * V       use version
730  * w       while/until modifier
731  * W       while/for statement
732  * x       optimized qw
733  * X       random thing
734  * _       whitespace/comments preceding anything else
735  * ~       =~ operator
736  */
737
738 /*
739  * Local variables:
740  * c-indentation-style: bsd
741  * c-basic-offset: 4
742  * indent-tabs-mode: t
743  * End:
744  *
745  * ex: set ts=8 sts=4 sw=4 noet:
746  */