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