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