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