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