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