op.h

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