This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
08d46f97c3612d857ffe15d007beffe8b1cf4784
[perl5.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  *      op_slabbed      allocated via opslab
23  *      op_static       tell op_free() to skip PerlMemShared_free(), when
24  *                      !op_slabbed.
25  *      op_savefree     on savestack via SAVEFREEOP
26  *      op_folded       Result/remainder of a constant fold operation.
27  *      op_spare        Two spare bits
28  *      op_flags        Flags common to all operations.  See OPf_* below.
29  *      op_private      Flags peculiar to a particular operation (BUT,
30  *                      by default, set to the number of children until
31  *                      the operation is privatized by a check routine,
32  *                      which may or may not check number of children).
33  */
34 #include "op_reg_common.h"
35
36 #define OPCODE U16
37
38 #ifdef PERL_MAD
39 #  define MADPROP_IN_BASEOP     MADPROP*        op_madprop;
40 #else
41 #  define MADPROP_IN_BASEOP
42 #endif
43
44 typedef PERL_BITFIELD16 Optype;
45
46 #ifdef BASEOP_DEFINITION
47 #define BASEOP BASEOP_DEFINITION
48 #else
49 #define BASEOP                          \
50     OP*         op_next;                \
51     OP*         op_sibling;             \
52     OP*         (*op_ppaddr)(pTHX);     \
53     MADPROP_IN_BASEOP                   \
54     PADOFFSET   op_targ;                \
55     PERL_BITFIELD16 op_type:9;          \
56     PERL_BITFIELD16 op_opt:1;           \
57     PERL_BITFIELD16 op_slabbed:1;       \
58     PERL_BITFIELD16 op_savefree:1;      \
59     PERL_BITFIELD16 op_static:1;        \
60     PERL_BITFIELD16 op_folded:1;        \
61     PERL_BITFIELD16 op_spare:2;         \
62     U8          op_flags;               \
63     U8          op_private;
64 #endif
65
66 /* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
67    Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
68    then all the other bit-fields before/after it should change their
69    types too to let VC pack them into the same 4 byte integer.*/
70
71 /* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
72 #define OP_GIMME(op,dfl) \
73         (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
74
75 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
76
77 /*
78 =head1 "Gimme" Values
79
80 =for apidoc Amn|U32|GIMME_V
81 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
82 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
83 respectively. See L<perlcall> for a usage example.
84
85 =for apidoc Amn|U32|GIMME
86 A backward-compatible version of C<GIMME_V> which can only return
87 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
88 Deprecated.  Use C<GIMME_V> instead.
89
90 =cut
91 */
92
93 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
94
95 /* Public flags */
96
97 #define OPf_WANT        3       /* Mask for "want" bits: */
98 #define  OPf_WANT_VOID   1      /*   Want nothing */
99 #define  OPf_WANT_SCALAR 2      /*   Want single value */
100 #define  OPf_WANT_LIST   3      /*   Want list of any length */
101 #define OPf_KIDS        4       /* There is a firstborn child. */
102 #define OPf_PARENS      8       /* This operator was parenthesized. */
103                                 /*  (Or block needs explicit scope entry.) */
104 #define OPf_REF         16      /* Certified reference. */
105                                 /*  (Return container, not containee). */
106 #define OPf_MOD         32      /* Will modify (lvalue). */
107 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
108 #define OPf_SPECIAL     128     /* Do something weird for this op: */
109                                 /*  On local LVAL, don't init local value. */
110                                 /*  On OP_SORT, subroutine is inlined. */
111                                 /*  On OP_NOT, inversion was implicit. */
112                                 /*  On OP_LEAVE, don't restore curpm. */
113                                 /*  On truncate, we truncate filehandle */
114                                 /*  On control verbs, we saw no label */
115                                 /*  On flipflop, we saw ... instead of .. */
116                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
117                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
118                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
119                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
120                                 /*  On pushre, rx is used as part of split, e.g. split " " */
121                                 /*  On regcomp, "use re 'eval'" was in scope */
122                                 /*  On OP_READLINE, was <$filehandle> */
123                                 /*  On RV2[ACGHS]V, don't create GV--in
124                                     defined()*/
125                                 /*  On OP_DBSTATE, indicates breakpoint
126                                  *    (runtime property) */
127                                 /*  On OP_REQUIRE, was seen as CORE::require */
128                                 /*  On OP_(ENTER|LEAVE)WHEN, there's
129                                     no condition */
130                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
131                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
132                                     reference to the new anon hash or array */
133                                 /*  On OP_HELEM and OP_HSLICE, localization will be followed
134                                     by assignment, so do not wipe the target if it is special
135                                     (e.g. a glob or a magic SV) */
136                                 /*  On OP_MATCH, OP_SUBST & OP_TRANS, the
137                                     operand of a logical or conditional
138                                     that was optimised away, so it should
139                                     not be bound via =~ */
140                                 /*  On OP_CONST, from a constant CV */
141                                 /*  On OP_GLOB, two meanings:
142                                     - Before ck_glob, called as CORE::glob
143                                     - After ck_glob, use Perl glob function
144                                  */
145                                 /*  On OP_PADRANGE, push @_ */
146                                 /*  On OP_DUMP, has no label */
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 NATIVE_HINTS
163  * 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{,CONT} */
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_REFS     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[SAH]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_RV2HV and OP_PADHV */
230 #define OPpTRUEBOOL             32      /* %hash in (%hash || $foo) in
231                                            void context */
232 #define OPpMAYBE_TRUEBOOL       64      /* %hash in (%hash || $foo) where
233                                            cx is not known till run time */
234
235   /* OP_SUBSTR only */
236 #define OPpSUBSTR_REPL_FIRST    16      /* 1st arg is replacement string */
237
238   /* OP_PADSV only */
239 #define OPpPAD_STATE            16      /* is a "state" pad */
240   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
241
242   /* OP_PADRANGE only */
243   /* bit 7 is OPpLVAL_INTRO */
244 #define OPpPADRANGE_COUNTMASK   127     /* bits 6..0 hold target range, */
245 #define OPpPADRANGE_COUNTSHIFT  7       /* 7 bits in total */
246
247   /* OP_RV2GV only */
248 #define OPpDONT_INIT_GV         4       /* Call gv_fetchpv with GV_NOINIT */
249 /* (Therefore will return whatever is currently in the symbol table, not
250    guaranteed to be a PVGV)  */
251 #define OPpALLOW_FAKE           16      /* OK to return fake glob */
252
253 /* Private for OP_ENTERITER and OP_ITER */
254 #define OPpITER_REVERSED        4       /* for (reverse ...) */
255 #define OPpITER_DEF             8       /* for $_ or for my $_ */
256
257 /* Private for OP_CONST */
258 #define OPpCONST_NOVER          2       /* no 6; */
259 #define OPpCONST_SHORTCIRCUIT   4       /* eg the constant 5 in (5 || foo) */
260 #define OPpCONST_STRICT         8       /* bareword subject to strict 'subs' */
261 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
262 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
263 /* Replaced by op_folded in perl itself, still used by B/B::Concise etc. */
264 #define OPpCONST_FOLDED         128     /* Result of constant folding */
265
266 /* Private for OP_FLIP/FLOP */
267 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
268
269 /* Private for OP_LIST */
270 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
271
272 /* Private for OP_DELETE */
273 #define OPpSLICE                64      /* Operating on a list of keys */
274 /* Also OPpLVAL_INTRO (128) */
275
276 /* Private for OP_EXISTS */
277 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
278
279 /* Private for OP_SORT */
280 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
281 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
282 #define OPpSORT_REVERSE         4       /* Reversed sort */
283 #define OPpSORT_INPLACE         8       /* sort in-place; eg @a = sort @a */
284 #define OPpSORT_DESCEND         16      /* Descending sort */
285 #define OPpSORT_QSORT           32      /* Use quicksort (not mergesort) */
286 #define OPpSORT_STABLE          64      /* Use a stable algorithm */
287
288 /* Private for OP_REVERSE */
289 #define OPpREVERSE_INPLACE      8       /* reverse in-place (@a = reverse @a) */
290
291 /* Private for OP_OPEN and OP_BACKTICK */
292 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
293 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
294 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
295 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
296
297 /* Private for OP_EXIT, HUSH also for OP_DIE */
298 #define OPpHUSH_VMSISH          64      /* hush DCL exit msg vmsish mode*/
299 #define OPpEXIT_VMSISH          128     /* exit(0) vs. exit(1) vmsish mode*/
300
301 /* Private for OP_FTXXX */
302 #define OPpFT_ACCESS            2       /* use filetest 'access' */
303 #define OPpFT_STACKED           4       /* stacked filetest, as "-f" in "-f -x $f" */
304 #define OPpFT_STACKING          8       /* stacking filetest, as "-x" in "-f -x $f" */
305 #define OPpFT_AFTER_t           16      /* previous op was -t */
306
307 /* Private for OP_(MAP|GREP)(WHILE|START) */
308 #define OPpGREP_LEX             2       /* iterate over lexical $_ */
309     
310 /* Private for OP_ENTEREVAL */
311 #define OPpEVAL_HAS_HH          2       /* Does it have a copy of %^H */
312 #define OPpEVAL_UNICODE         4
313 #define OPpEVAL_BYTES           8
314 #define OPpEVAL_COPHH           16      /* Construct %^H from cop hints */
315 #define OPpEVAL_RE_REPARSING    32      /* eval_sv(..., G_RE_REPARSING) */
316     
317 /* Private for OP_CALLER, OP_WANTARRAY and OP_RUNCV */
318 #define OPpOFFBYONE             128     /* Treat caller(1) as caller(2) */
319
320 /* Private for OP_COREARGS */
321 /* These must not conflict with OPpDONT_INIT_GV or OPpALLOW_FAKE.
322    See pp.c:S_rv2gv. */
323 #define OPpCOREARGS_DEREF1      1       /* Arg 1 is a handle constructor */
324 #define OPpCOREARGS_DEREF2      2       /* Arg 2 is a handle constructor */
325 #define OPpCOREARGS_SCALARMOD   64      /* \$ rather than \[$@%*] */
326 #define OPpCOREARGS_PUSHMARK    128     /* Call pp_pushmark */
327
328 /* Private for OP_(LAST|REDO|NEXT|GOTO|DUMP) */
329 #define OPpPV_IS_UTF8           128     /* label is in UTF8 */
330
331 /* Private for OP_SPLIT */
332 #define OPpSPLIT_IMPLIM         128     /* implicit limit */
333
334 struct op {
335     BASEOP
336 };
337
338 struct unop {
339     BASEOP
340     OP *        op_first;
341 };
342
343 struct binop {
344     BASEOP
345     OP *        op_first;
346     OP *        op_last;
347 };
348
349 struct logop {
350     BASEOP
351     OP *        op_first;
352     OP *        op_other;
353 };
354
355 struct listop {
356     BASEOP
357     OP *        op_first;
358     OP *        op_last;
359 };
360
361 struct pmop {
362     BASEOP
363     OP *        op_first;
364     OP *        op_last;
365 #ifdef USE_ITHREADS
366     PADOFFSET   op_pmoffset;
367 #else
368     REGEXP *    op_pmregexp;            /* compiled expression */
369 #endif
370     U32         op_pmflags;
371     union {
372         OP *    op_pmreplroot;          /* For OP_SUBST */
373 #ifdef USE_ITHREADS
374         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
375 #else
376         GV *    op_pmtargetgv;
377 #endif
378     }   op_pmreplrootu;
379     union {
380         OP *    op_pmreplstart; /* Only used in OP_SUBST */
381 #ifdef USE_ITHREADS
382         PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
383 #else
384         HV *    op_pmstash;
385 #endif
386     }           op_pmstashstartu;
387     OP *        op_code_list;   /* list of (?{}) code blocks */
388 };
389
390 #ifdef USE_ITHREADS
391 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
392                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
393 /* The assignment is just to enforce type safety (or at least get a warning).
394  */
395 /* With first class regexps not via a reference one needs to assign
396    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
397    is cheaper. I guess we could allow NULL, but the check above would get
398    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
399 /* BEWARE - something that calls this macro passes (r) which has a side
400    effect.  */
401 #define PM_SETRE(o,r)   STMT_START {                                    \
402                             REGEXP *const _pm_setre = (r);              \
403                             assert(_pm_setre);                          \
404                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
405                         } STMT_END
406 #else
407 #define PM_GETRE(o)     ((o)->op_pmregexp)
408 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
409 #endif
410
411 /* Leave some space, so future bit allocations can go either in the shared or
412  * unshared area without affecting binary compatibility */
413 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
414
415 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
416 #define PMf_RETAINT     (1<<(PMf_BASE_SHIFT+0))
417
418 /* match successfully only once per reset, with related flag RXf_USED in
419  * re->extflags holding state.  This is used only for ?? matches, and only on
420  * OP_MATCH and OP_QR */
421 #define PMf_ONCE        (1<<(PMf_BASE_SHIFT+1))
422
423 /* PMf_ONCE, i.e. ?pat?, has matched successfully.  Not used under threading. */
424 #define PMf_USED        (1<<(PMf_BASE_SHIFT+3))
425
426 /* subst replacement is constant */
427 #define PMf_CONST       (1<<(PMf_BASE_SHIFT+4))
428
429 /* keep 1st runtime pattern forever */
430 #define PMf_KEEP        (1<<(PMf_BASE_SHIFT+5))
431
432 #define PMf_GLOBAL      (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
433
434 /* don't reset pos() if //g fails */
435 #define PMf_CONTINUE    (1<<(PMf_BASE_SHIFT+7))
436
437 /* evaluating replacement as expr */
438 #define PMf_EVAL        (1<<(PMf_BASE_SHIFT+8))
439
440 /* Return substituted string instead of modifying it. */
441 #define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
442
443 /* the pattern has a CV attached (currently only under qr/...(?{}).../) */
444 #define PMf_HAS_CV      (1<<(PMf_BASE_SHIFT+10))
445
446 /* op_code_list is private; don't free it etc. It may well point to
447  * code within another sub, with different pad etc */
448 #define PMf_CODELIST_PRIVATE    (1<<(PMf_BASE_SHIFT+11))
449
450 /* the PMOP is a QR (we should be able to detect that from the op type,
451  * but the regex compilation API passes just the pm flags, not the op
452  * itself */
453 #define PMf_IS_QR       (1<<(PMf_BASE_SHIFT+12))
454 #define PMf_USE_RE_EVAL (1<<(PMf_BASE_SHIFT+13)) /* use re'eval' in scope */
455
456 #if PMf_BASE_SHIFT+13 > 31
457 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
458 #endif
459
460 #ifdef USE_ITHREADS
461
462 #  define PmopSTASH(o)         ((o)->op_pmflags & PMf_ONCE                         \
463                                 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff]   \
464                                 : NULL)
465 #  define PmopSTASH_set(o,hv)   \
466         (assert_((o)->op_pmflags & PMf_ONCE)                            \
467          (o)->op_pmstashstartu.op_pmstashoff =                          \
468             (hv) ? alloccopstash(hv) : 0)
469 #else
470 #  define PmopSTASH(o)                                                  \
471     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
472 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
473 #    define PmopSTASH_set(o,hv)         ({                              \
474         assert((o)->op_pmflags & PMf_ONCE);                             \
475         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
476     })
477 #  else
478 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
479 #  endif
480 #endif
481 #define PmopSTASHPV(o)  (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
482    /* op_pmstashstartu.op_pmstash is not refcounted */
483 #define PmopSTASHPV_set(o,pv)   PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
484
485 struct svop {
486     BASEOP
487     SV *        op_sv;
488 };
489
490 struct padop {
491     BASEOP
492     PADOFFSET   op_padix;
493 };
494
495 struct pvop {
496     BASEOP
497     char *      op_pv;
498 };
499
500 struct loop {
501     BASEOP
502     OP *        op_first;
503     OP *        op_last;
504     OP *        op_redoop;
505     OP *        op_nextop;
506     OP *        op_lastop;
507 };
508
509 #define cUNOPx(o)       ((UNOP*)o)
510 #define cBINOPx(o)      ((BINOP*)o)
511 #define cLISTOPx(o)     ((LISTOP*)o)
512 #define cLOGOPx(o)      ((LOGOP*)o)
513 #define cPMOPx(o)       ((PMOP*)o)
514 #define cSVOPx(o)       ((SVOP*)o)
515 #define cPADOPx(o)      ((PADOP*)o)
516 #define cPVOPx(o)       ((PVOP*)o)
517 #define cCOPx(o)        ((COP*)o)
518 #define cLOOPx(o)       ((LOOP*)o)
519
520 #define cUNOP           cUNOPx(PL_op)
521 #define cBINOP          cBINOPx(PL_op)
522 #define cLISTOP         cLISTOPx(PL_op)
523 #define cLOGOP          cLOGOPx(PL_op)
524 #define cPMOP           cPMOPx(PL_op)
525 #define cSVOP           cSVOPx(PL_op)
526 #define cPADOP          cPADOPx(PL_op)
527 #define cPVOP           cPVOPx(PL_op)
528 #define cCOP            cCOPx(PL_op)
529 #define cLOOP           cLOOPx(PL_op)
530
531 #define cUNOPo          cUNOPx(o)
532 #define cBINOPo         cBINOPx(o)
533 #define cLISTOPo        cLISTOPx(o)
534 #define cLOGOPo         cLOGOPx(o)
535 #define cPMOPo          cPMOPx(o)
536 #define cSVOPo          cSVOPx(o)
537 #define cPADOPo         cPADOPx(o)
538 #define cPVOPo          cPVOPx(o)
539 #define cCOPo           cCOPx(o)
540 #define cLOOPo          cLOOPx(o)
541
542 #define kUNOP           cUNOPx(kid)
543 #define kBINOP          cBINOPx(kid)
544 #define kLISTOP         cLISTOPx(kid)
545 #define kLOGOP          cLOGOPx(kid)
546 #define kPMOP           cPMOPx(kid)
547 #define kSVOP           cSVOPx(kid)
548 #define kPADOP          cPADOPx(kid)
549 #define kPVOP           cPVOPx(kid)
550 #define kCOP            cCOPx(kid)
551 #define kLOOP           cLOOPx(kid)
552
553
554 #ifdef USE_ITHREADS
555 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
556 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
557                                  && GvIN_PAD(v))
558 #  define       IS_PADCONST(v) \
559         (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
560 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
561                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
562 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
563                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
564 #else
565 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
566 #  define       IS_PADGV(v)     FALSE
567 #  define       IS_PADCONST(v)  FALSE
568 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
569 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
570 #endif
571
572 #define cGVOP_gv                cGVOPx_gv(PL_op)
573 #define cGVOPo_gv               cGVOPx_gv(o)
574 #define kGVOP_gv                cGVOPx_gv(kid)
575 #define cSVOP_sv                cSVOPx_sv(PL_op)
576 #define cSVOPo_sv               cSVOPx_sv(o)
577 #define kSVOP_sv                cSVOPx_sv(kid)
578
579 #ifndef PERL_CORE
580 #  define Nullop ((OP*)NULL)
581 #endif
582
583 /* Lowest byte of PL_opargs */
584 #define OA_MARK 1
585 #define OA_FOLDCONST 2
586 #define OA_RETSCALAR 4
587 #define OA_TARGET 8
588 #define OA_TARGLEX 16
589 #define OA_OTHERINT 32
590 #define OA_DANGEROUS 64
591 #define OA_DEFGV 128
592
593 /* The next 4 bits encode op class information */
594 #define OCSHIFT 8
595
596 #define OA_CLASS_MASK (15 << OCSHIFT)
597
598 #define OA_BASEOP (0 << OCSHIFT)
599 #define OA_UNOP (1 << OCSHIFT)
600 #define OA_BINOP (2 << OCSHIFT)
601 #define OA_LOGOP (3 << OCSHIFT)
602 #define OA_LISTOP (4 << OCSHIFT)
603 #define OA_PMOP (5 << OCSHIFT)
604 #define OA_SVOP (6 << OCSHIFT)
605 #define OA_PADOP (7 << OCSHIFT)
606 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
607 #define OA_LOOP (9 << OCSHIFT)
608 #define OA_COP (10 << OCSHIFT)
609 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
610 #define OA_FILESTATOP (12 << OCSHIFT)
611 #define OA_LOOPEXOP (13 << OCSHIFT)
612
613 #define OASHIFT 12
614
615 /* Remaining nybbles of PL_opargs */
616 #define OA_SCALAR 1
617 #define OA_LIST 2
618 #define OA_AVREF 3
619 #define OA_HVREF 4
620 #define OA_CVREF 5
621 #define OA_FILEREF 6
622 #define OA_SCALARREF 7
623 #define OA_OPTIONAL 8
624
625 /* Op_REFCNT is a reference count at the head of each op tree: needed
626  * since the tree is shared between threads, and between cloned closure
627  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
628  * this count.
629  * The same mutex is used to protect the refcounts of the reg_trie_data
630  * and reg_ac_data structures, which are shared between duplicated
631  * regexes.
632  */
633
634 #ifdef USE_ITHREADS
635 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
636 #  ifdef PERL_CORE
637 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
638 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
639 #  else
640 #    define OP_REFCNT_LOCK              op_refcnt_lock()
641 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
642 #  endif
643 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
644 #else
645 #  define OP_REFCNT_INIT                NOOP
646 #  define OP_REFCNT_LOCK                NOOP
647 #  define OP_REFCNT_UNLOCK              NOOP
648 #  define OP_REFCNT_TERM                NOOP
649 #endif
650
651 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
652 #ifdef PERL_DEBUG_READONLY_OPS
653 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
654 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
655 #else
656 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
657 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
658 #endif
659
660 /* flags used by Perl_load_module() */
661 #define PERL_LOADMOD_DENY               0x1     /* no Module */
662 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
663 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* use Module (...) */
664
665 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
666 #define ref(o, type) doref(o, type, TRUE)
667 #endif
668
669 /*
670 =head1 Optree Manipulation Functions
671
672 =for apidoc Am|OP*|LINKLIST|OP *o
673 Given the root of an optree, link the tree in execution order using the
674 C<op_next> pointers and return the first op executed. If this has
675 already been done, it will not be redone, and C<< o->op_next >> will be
676 returned. If C<< o->op_next >> is not already set, I<o> should be at
677 least an C<UNOP>.
678
679 =cut
680 */
681
682 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
683
684 /* no longer used anywhere in core */
685 #ifndef PERL_CORE
686 #define cv_ckproto(cv, gv, p) \
687    cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
688 #endif
689
690 #ifdef PERL_CORE
691 #  define my(o) my_attrs((o), NULL)
692 #endif
693
694 #ifdef USE_REENTRANT_API
695 #include "reentr.h"
696 #endif
697
698 #define NewOp(m,var,c,type)     \
699         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
700 #define NewOpSz(m,var,size)     \
701         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
702 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
703
704 /*
705  * The per-CV op slabs consist of a header (the opslab struct) and a bunch
706  * of space for allocating op slots, each of which consists of two pointers
707  * followed by an op.  The first pointer points to the next op slot.  The
708  * second points to the slab.  At the end of the slab is a null pointer,
709  * so that slot->opslot_next - slot can be used to determine the size
710  * of the op.
711  *
712  * Each CV can have multiple slabs; opslab_next points to the next slab, to
713  * form a chain.  All bookkeeping is done on the first slab, which is where
714  * all the op slots point.
715  *
716  * Freed ops are marked as freed and attached to the freed chain
717  * via op_next pointers.
718  *
719  * When there is more than one slab, the second slab in the slab chain is
720  * assumed to be the one with free space available.  It is used when allo-
721  * cating an op if there are no freed ops available or big enough.
722  */
723
724 #ifdef PERL_CORE
725 struct opslot {
726     /* keep opslot_next first */
727     OPSLOT *    opslot_next;            /* next slot */
728     OPSLAB *    opslot_slab;            /* owner */
729     OP          opslot_op;              /* the op itself */
730 };
731
732 struct opslab {
733     OPSLOT *    opslab_first;           /* first op in this slab */
734     OPSLAB *    opslab_next;            /* next slab */
735     OP *        opslab_freed;           /* chain of freed ops */
736     size_t      opslab_refcnt;          /* number of ops */
737 # ifdef PERL_DEBUG_READONLY_OPS
738     U16         opslab_size;            /* size of slab in pointers */
739     bool        opslab_readonly;
740 # endif
741     OPSLOT      opslab_slots;           /* slots begin here */
742 };
743
744 # define OPSLOT_HEADER          STRUCT_OFFSET(OPSLOT, opslot_op)
745 # define OPSLOT_HEADER_P        (OPSLOT_HEADER/sizeof(I32 *))
746 # define OpSLOT(o)              (assert_(o->op_slabbed) \
747                                  (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
748 # define OpSLAB(o)              OpSLOT(o)->opslot_slab
749 # define OpslabREFCNT_dec(slab)      \
750         (((slab)->opslab_refcnt == 1) \
751          ? opslab_free_nopad(slab)     \
752          : (void)--(slab)->opslab_refcnt)
753   /* Variant that does not null out the pads */
754 # define OpslabREFCNT_dec_padok(slab) \
755         (((slab)->opslab_refcnt == 1)  \
756          ? opslab_free(slab)            \
757          : (void)--(slab)->opslab_refcnt)
758 #endif
759
760 struct block_hooks {
761     U32     bhk_flags;
762     void    (*bhk_start)        (pTHX_ int full);
763     void    (*bhk_pre_end)      (pTHX_ OP **seq);
764     void    (*bhk_post_end)     (pTHX_ OP **seq);
765     void    (*bhk_eval)         (pTHX_ OP *const saveop);
766 };
767
768 /*
769 =head1 Compile-time scope hooks
770
771 =for apidoc mx|U32|BhkFLAGS|BHK *hk
772 Return the BHK's flags.
773
774 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
775 Return an entry from the BHK structure. I<which> is a preprocessor token
776 indicating which entry to return. If the appropriate flag is not set
777 this will return NULL. The type of the return value depends on which
778 entry you ask for.
779
780 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
781 Set an entry in the BHK structure, and set the flags to indicate it is
782 valid. I<which> is a preprocessing token indicating which entry to set.
783 The type of I<ptr> depends on the entry.
784
785 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
786 Temporarily disable an entry in this BHK structure, by clearing the
787 appropriate flag. I<which> is a preprocessor token indicating which
788 entry to disable.
789
790 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
791 Re-enable an entry in this BHK structure, by setting the appropriate
792 flag. I<which> is a preprocessor token indicating which entry to enable.
793 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
794 pointer.
795
796 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
797 Call all the registered block hooks for type I<which>. I<which> is a
798 preprocessing token; the type of I<arg> depends on I<which>.
799
800 =cut
801 */
802
803 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
804
805 #define BHKf_bhk_start      0x01
806 #define BHKf_bhk_pre_end    0x02
807 #define BHKf_bhk_post_end   0x04
808 #define BHKf_bhk_eval       0x08
809
810 #define BhkENTRY(hk, which) \
811     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
812
813 #define BhkENABLE(hk, which) \
814     STMT_START { \
815         BhkFLAGS(hk) |= BHKf_ ## which; \
816         assert(BhkENTRY(hk, which)); \
817     } STMT_END
818
819 #define BhkDISABLE(hk, which) \
820     STMT_START { \
821         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
822     } STMT_END
823
824 #define BhkENTRY_set(hk, which, ptr) \
825     STMT_START { \
826         (hk)->which = ptr; \
827         BhkENABLE(hk, which); \
828     } STMT_END
829
830 #define CALL_BLOCK_HOOKS(which, arg) \
831     STMT_START { \
832         if (PL_blockhooks) { \
833             SSize_t i; \
834             for (i = av_len(PL_blockhooks); i >= 0; i--) { \
835                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
836                 BHK *hk; \
837                 \
838                 assert(SvIOK(sv)); \
839                 if (SvUOK(sv)) \
840                     hk = INT2PTR(BHK *, SvUVX(sv)); \
841                 else \
842                     hk = INT2PTR(BHK *, SvIVX(sv)); \
843                 \
844                 if (BhkENTRY(hk, which)) \
845                     BhkENTRY(hk, which)(aTHX_ arg); \
846             } \
847         } \
848     } STMT_END
849
850 /* flags for rv2cv_op_cv */
851
852 #define RV2CVOPCV_MARK_EARLY     0x00000001
853 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
854
855 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
856
857 /* flags for op_lvalue_flags */
858
859 #define OP_LVALUE_NO_CROAK 1
860
861 /*
862 =head1 Custom Operators
863
864 =for apidoc Am|U32|XopFLAGS|XOP *xop
865 Return the XOP's flags.
866
867 =for apidoc Am||XopENTRY|XOP *xop|which
868 Return a member of the XOP structure. I<which> is a cpp token indicating
869 which entry to return. If the member is not set this will return a
870 default value. The return type depends on I<which>.
871
872 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
873 Set a member of the XOP structure. I<which> is a cpp token indicating
874 which entry to set. See L<perlguts/"Custom Operators"> for details about
875 the available members and how they are used.
876
877 =for apidoc Am|void|XopDISABLE|XOP *xop|which
878 Temporarily disable a member of the XOP, by clearing the appropriate flag.
879
880 =for apidoc Am|void|XopENABLE|XOP *xop|which
881 Reenable a member of the XOP which has been disabled.
882
883 =cut
884 */
885
886 struct custom_op {
887     U32             xop_flags;    
888     const char     *xop_name;
889     const char     *xop_desc;
890     U32             xop_class;
891     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
892 };
893
894 #define XopFLAGS(xop) ((xop)->xop_flags)
895
896 #define XOPf_xop_name   0x01
897 #define XOPf_xop_desc   0x02
898 #define XOPf_xop_class  0x04
899 #define XOPf_xop_peep   0x08
900
901 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
902 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
903 #define XOPd_xop_class  OA_BASEOP
904 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
905
906 #define XopENTRY_set(xop, which, to) \
907     STMT_START { \
908         (xop)->which = (to); \
909         (xop)->xop_flags |= XOPf_ ## which; \
910     } STMT_END
911
912 #define XopENTRY(xop, which) \
913     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
914
915 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
916 #define XopENABLE(xop, which) \
917     STMT_START { \
918         (xop)->xop_flags |= XOPf_ ## which; \
919         assert(XopENTRY(xop, which)); \
920     } STMT_END
921
922 /*
923 =head1 Optree Manipulation Functions
924
925 =for apidoc Am|const char *|OP_NAME|OP *o
926 Return the name of the provided OP. For core ops this looks up the name
927 from the op_type; for custom ops from the op_ppaddr.
928
929 =for apidoc Am|const char *|OP_DESC|OP *o
930 Return a short description of the provided OP.
931
932 =for apidoc Am|U32|OP_CLASS|OP *o
933 Return the class of the provided OP: that is, which of the *OP
934 structures it uses. For core ops this currently gets the information out
935 of PL_opargs, which does not always accurately reflect the type used.
936 For custom ops the type is returned from the registration, and it is up
937 to the registree to ensure it is accurate. The value returned will be
938 one of the OA_* constants from op.h.
939
940 =cut
941 */
942
943 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
944                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_name) \
945                     : PL_op_name[(o)->op_type])
946 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
947                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_desc) \
948                     : PL_op_desc[(o)->op_type])
949 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
950                      ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_class) \
951                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
952
953 #define newSUB(f, o, p, b)      Perl_newATTRSUB(aTHX_ (f), (o), (p), NULL, (b))
954
955 #ifdef PERL_MAD
956 #  define MAD_NULL 1
957 #  define MAD_PV 2
958 #  define MAD_OP 3
959 #  define MAD_SV 4
960
961 struct madprop {
962     MADPROP* mad_next;
963     void *mad_val;
964     U32 mad_vlen;
965 /*    short mad_count; */
966     char mad_key;
967     char mad_type;
968 };
969
970 struct token {
971     I32 tk_type;
972     YYSTYPE tk_lval;
973     MADPROP* tk_mad;
974 };
975 #endif
976
977 /*
978  * Values that can be held by mad_key :
979  * ^       unfilled head spot
980  * ,       literal ,
981  * ;       literal ; (blank if implicit ; at end of block)
982  * :       literal : from ?: or attr list
983  * +       unary +
984  * ?       literal ? from ?:
985  * (       literal (
986  * )       literal )
987  * [       literal [
988  * ]       literal ]
989  * {       literal {
990  * }       literal }
991  * @       literal @ sigil
992  * $       literal $ sigil
993  * *       literal * sigil
994  * !       use is source filtered
995  * &       & or sub
996  * #       whitespace/comment following ; or }
997  * #       $# sigil
998  * 1       1st ; from for(;;)
999  * 1       retired protasis
1000  * 2       2nd ; from for(;;)
1001  * 2       retired apodosis
1002  * 3       C-style for list
1003  * a       sub or var attributes
1004  * a       non-method arrow operator
1005  * A       method arrow operator
1006  * A       use import args
1007  * b       format block
1008  * B       retired stub block
1009  * C       constant conditional op
1010  * d       declarator
1011  * D       do block
1012  * e       unreached "else" (see C)
1013  * e       expression producing E
1014  * E       tr/E/R/, /E/
1015  * f       folded constant op
1016  * F       peg op for format
1017  * g       op was forced to be a word
1018  * i       if/unless modifier
1019  * I       if/elsif/unless statement
1020  * k       local declarator
1021  * K       retired kid op
1022  * l       last index of array ($#foo)
1023  * L       label
1024  * m       modifier on regex
1025  * n       sub or format name
1026  * o       current operator/declarator name
1027  * o       else/continue
1028  * O       generic optimized op
1029  * p       peg to hold extra whitespace at statement level
1030  * P       peg op for package declaration
1031  * q       opening quote
1032  * =       quoted material
1033  * Q       closing quote
1034  * Q       optimized qw//
1035  * r       expression producing R
1036  * R       tr/E/R/ s/E/R/
1037  * s       sub signature
1038  * S       use import stub (no import)
1039  * S       retired sort block
1040  * t       unreached "then" (see C)
1041  * U       use import op
1042  * v       private sv of for loop
1043  * V       use version
1044  * w       while/until modifier
1045  * W       while/for statement
1046  * x       optimized qw
1047  * X       random thing
1048  * _       whitespace/comments preceding anything else
1049  * ~       =~ operator
1050  */
1051
1052 /*
1053 =head1 Hook manipulation
1054 */
1055
1056 #ifdef USE_ITHREADS
1057 #  define OP_CHECK_MUTEX_INIT           MUTEX_INIT(&PL_check_mutex)
1058 #  define OP_CHECK_MUTEX_LOCK           MUTEX_LOCK(&PL_check_mutex)
1059 #  define OP_CHECK_MUTEX_UNLOCK         MUTEX_UNLOCK(&PL_check_mutex)
1060 #  define OP_CHECK_MUTEX_TERM           MUTEX_DESTROY(&PL_check_mutex)
1061 #else
1062 #  define OP_CHECK_MUTEX_INIT           NOOP
1063 #  define OP_CHECK_MUTEX_LOCK           NOOP
1064 #  define OP_CHECK_MUTEX_UNLOCK         NOOP
1065 #  define OP_CHECK_MUTEX_TERM           NOOP
1066 #endif
1067
1068 /*
1069  * Local variables:
1070  * c-indentation-style: bsd
1071  * c-basic-offset: 4
1072  * indent-tabs-mode: nil
1073  * End:
1074  *
1075  * ex: set ts=8 sts=4 sw=4 et:
1076  */