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