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