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