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