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