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