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