op.h

   1 /*    op.h
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 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
  40 #define OPCODE U16
  41
  42 #ifdef PERL_MAD
  43 #  define MADPROP_IN_BASEOP     MADPROP*        op_madprop;
  44 #else
  45 #  define MADPROP_IN_BASEOP
  46 #endif
  47
  48 #ifdef BASEOP_DEFINITION
  49 #define BASEOP BASEOP_DEFINITION
  50 #else
  51 #define BASEOP                          \
  52     OP*         op_next;                \
  53     OP*         op_sibling;             \
  54     OP*         (CPERLscope(*op_ppaddr))(pTHX);         \
  55     MADPROP_IN_BASEOP                   \
  56     PADOFFSET   op_targ;                \
  57     unsigned    op_type:9;              \
  58     unsigned    op_opt:1;               \
  59     unsigned    op_latefree:1;          \
  60     unsigned    op_latefreed:1;         \
  61     unsigned    op_attached:1;          \
  62     unsigned    op_spare:3;             \
  63     U8          op_flags;               \
  64     U8          op_private;
  65 #endif
  66
  67 #define OP_GIMME(op,dfl) \
  68         (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID   ? G_VOID   : \
  69          ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
  70          ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST   ? G_ARRAY   : \
  71          dfl)
  72
  73 /*
  74 =head1 "Gimme" Values
  75
  76 =for apidoc Amn|U32|GIMME_V
  77 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
  78 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
  79 respectively.
  80
  81 =for apidoc Amn|U32|GIMME
  82 A backward-compatible version of C<GIMME_V> which can only return
  83 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
  84 Deprecated.  Use C<GIMME_V> instead.
  85
  86 =cut
  87 */
  88
  89 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
  90
  91 /* Public flags */
  92
  93 #define OPf_WANT        3       /* Mask for "want" bits: */
  94 #define  OPf_WANT_VOID   1      /*   Want nothing */
  95 #define  OPf_WANT_SCALAR 2      /*   Want single value */
  96 #define  OPf_WANT_LIST   3      /*   Want list of any length */
  97 #define OPf_KIDS        4       /* There is a firstborn child. */
  98 #define OPf_PARENS      8       /* This operator was parenthesized. */
  99                                 /*  (Or block needs explicit scope entry.) */
 100 #define OPf_REF         16      /* Certified reference. */
 101                                 /*  (Return container, not containee). */
 102 #define OPf_MOD         32      /* Will modify (lvalue). */
 103 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
 104 #define OPf_SPECIAL     128     /* Do something weird for this op: */
 105                                 /*  On local LVAL, don't init local value. */
 106                                 /*  On OP_CONST, value is the hints hash for
 107                                     eval, so return a copy from pp_const() */
 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_ENTERITER, loop var is per-thread */
 119                                 /*  On pushre, rx is used as part of split, e.g. split " " */
 120                                 /*  On regcomp, "use re 'eval'" was in scope */
 121                                 /*  On OP_READLINE, was <$filehandle> */
 122                                 /*  On RV2[ACGHS]V, don't create GV--in
 123                                     defined()*/
 124                                 /*  On OP_DBSTATE, indicates breakpoint
 125                                  *    (runtime property) */
 126                                 /*  On OP_AELEMFAST, indiciates pad var */
 127                                 /*  On OP_REQUIRE, was seen as CORE::require */
 128                                 /*  On OP_ENTERWHEN, there's no condition */
 129                                 /*  On OP_BREAK, an implicit break */
 130                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
 131                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
 132                                     reference to the new anon hash or array */
 133
 134 /* old names; don't use in new code, but don't break them, either */
 135 #define OPf_LIST        OPf_WANT_LIST
 136 #define OPf_KNOW        OPf_WANT
 137
 138 #define GIMME \
 139           (PL_op->op_flags & OPf_WANT                                   \
 140            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
 141               ? G_ARRAY                                                 \
 142               : G_SCALAR)                                               \
 143            : dowantarray())
 144
 145 /* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
 146  * bits of PL_hints in op_private */
 147
 148 /* Private for lvalues */
 149 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
 150
 151 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
 152 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
 153
 154 /* Private for OP_AASSIGN */
 155 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
 156
 157 /* Private for OP_SASSIGN */
 158 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
 159 #define OPpASSIGN_CV_TO_GV      128     /* Possible optimisation for constants. */
 160
 161 /* Private for OP_MATCH and OP_SUBST{,CONST} */
 162 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
 163
 164 /* Private for OP_TRANS */
 165 #define OPpTRANS_FROM_UTF       1
 166 #define OPpTRANS_TO_UTF         2
 167 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
 168 #define OPpTRANS_SQUASH         8
 169     /* 16 is used for OPpTARGET_MY */
 170 #define OPpTRANS_COMPLEMENT     32
 171 #define OPpTRANS_GROWS          64
 172 #define OPpTRANS_DELETE         128
 173 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
 174
 175 /* Private for OP_REPEAT */
 176 #define OPpREPEAT_DOLIST        64      /* List replication. */
 177
 178 /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
 179 #define OPpDEREF                (32|64) /* autovivify: Want ref to something: */
 180 #define OPpDEREF_AV             32      /*   Want ref to AV. */
 181 #define OPpDEREF_HV             64      /*   Want ref to HV. */
 182 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
 183   /* OP_ENTERSUB only */
 184 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
 185 #define OPpENTERSUB_HASTARG     32      /* Called from OP tree. */
 186 #define OPpENTERSUB_NOMOD       64      /* Immune to mod() for :attrlist. */
 187   /* OP_RV2CV only */
 188 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
 189 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
 190 #define OPpENTERSUB_INARGS      4       /* Lval used as arg to a sub. */
 191   /* OP_GV only */
 192 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
 193   /* OP_?ELEM only */
 194 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
 195   /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
 196 #define OPpOUR_INTRO            16      /* Variable was in an our() */
 197   /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM */
 198 #define OPpMAYBE_LVSUB          8       /* We might be an lvalue to return */
 199   /* OP_PADSV only */
 200 #define OPpPAD_STATE            16      /* is a "state" pad */
 201   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
 202
 203   /* OP_RV2GV only */
 204 #define OPpDONT_INIT_GV         4       /* Call gv_fetchpv with GV_NOINIT */
 205 /* (Therefore will return whatever is currently in the symbol table, not
 206    guaranteed to be a PVGV)  */
 207
 208   /* OP_RV2CV only */
 209 #define OPpMAY_RETURN_CONSTANT  1       /* If a constant sub, return the constant */
 210
 211 /* Private for OPs with TARGLEX */
 212   /* (lower bits may carry MAXARG) */
 213 #define OPpTARGET_MY            16      /* Target is PADMY. */
 214
 215 /* Private for OP_ENTERITER and OP_ITER */
 216 #define OPpITER_REVERSED        4       /* for (reverse ...) */
 217 #define OPpITER_DEF             8       /* for $_ or for my $_ */
 218
 219 /* Private for OP_CONST */
 220 #define OPpCONST_NOVER          2       /* no 6; */
 221 #define OPpCONST_SHORTCIRCUIT   4       /* eg the constant 5 in (5 || foo) */
 222 #define OPpCONST_STRICT         8       /* bearword subject to strict 'subs' */
 223 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
 224 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
 225 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
 226 #define OPpCONST_WARNING        128     /* Was a $^W translated to constant. */
 227
 228 /* Private for OP_FLIP/FLOP */
 229 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
 230
 231 /* Private for OP_LIST */
 232 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
 233
 234 /* Private for OP_DELETE */
 235 #define OPpSLICE                64      /* Operating on a list of keys */
 236
 237 /* Private for OP_EXISTS */
 238 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
 239
 240 /* Private for OP_SORT */
 241 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
 242 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
 243 #define OPpSORT_REVERSE         4       /* Reversed sort */
 244 #define OPpSORT_INPLACE         8       /* sort in-place; eg @a = sort @a */
 245 #define OPpSORT_DESCEND         16      /* Descending sort */
 246 #define OPpSORT_QSORT           32      /* Use quicksort (not mergesort) */
 247 #define OPpSORT_STABLE          64      /* Use a stable algorithm */
 248
 249 /* Private for OP_OPEN and OP_BACKTICK */
 250 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
 251 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
 252 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
 253 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
 254
 255 /* Private for OP_EXIT, HUSH also for OP_DIE */
 256 #define OPpHUSH_VMSISH          64      /* hush DCL exit msg vmsish mode*/
 257 #define OPpEXIT_VMSISH          128     /* exit(0) vs. exit(1) vmsish mode*/
 258
 259 /* Private for OP_FTXXX */
 260 #define OPpFT_ACCESS            2       /* use filetest 'access' */
 261 #define OPpFT_STACKED           4       /* stacked filetest, as in "-f -x $f" */
 262 #define OP_IS_FILETEST_ACCESS(op)               \
 263         (((op)->op_type) == OP_FTRREAD  ||      \
 264          ((op)->op_type) == OP_FTRWRITE ||      \
 265          ((op)->op_type) == OP_FTREXEC  ||      \
 266          ((op)->op_type) == OP_FTEREAD  ||      \
 267          ((op)->op_type) == OP_FTEWRITE ||      \
 268          ((op)->op_type) == OP_FTEEXEC)
 269
 270 /* Private for OP_(MAP|GREP)(WHILE|START) */
 271 #define OPpGREP_LEX             2       /* iterate over lexical $_ */
 272
 273 /* Private for OP_ENTEREVAL */
 274 #define OPpEVAL_HAS_HH          2       /* Does it have a copy of %^H */
 275
 276 struct op {
 277     BASEOP
 278 };
 279
 280 struct unop {
 281     BASEOP
 282     OP *        op_first;
 283 };
 284
 285 struct binop {
 286     BASEOP
 287     OP *        op_first;
 288     OP *        op_last;
 289 };
 290
 291 struct logop {
 292     BASEOP
 293     OP *        op_first;
 294     OP *        op_other;
 295 };
 296
 297 struct listop {
 298     BASEOP
 299     OP *        op_first;
 300     OP *        op_last;
 301 };
 302
 303 struct pmop {
 304     BASEOP
 305     OP *        op_first;
 306     OP *        op_last;
 307 #ifdef USE_ITHREADS
 308     IV          op_pmoffset;
 309 #else
 310     REGEXP *    op_pmregexp;            /* compiled expression */
 311 #endif
 312     U32         op_pmflags;
 313     union {
 314         OP *    op_pmreplroot;          /* For OP_SUBST */
 315 #ifdef USE_ITHREADS
 316         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
 317 #else
 318         GV *    op_pmtargetgv;
 319 #endif
 320     }   op_pmreplrootu;
 321     union {
 322         OP *    op_pmreplstart; /* Only used in OP_SUBST */
 323 #ifdef USE_ITHREADS
 324         char *  op_pmstashpv;   /* Only used in OP_MATCH, with PMf_ONCE set */
 325 #else
 326         HV *    op_pmstash;
 327 #endif
 328     }           op_pmstashstartu;
 329 };
 330
 331 #ifdef USE_ITHREADS
 332 #define PM_GETRE(o)     (INT2PTR(REGEXP*,SvIVX(PL_regex_pad[(o)->op_pmoffset])))
 333 #define PM_SETRE(o,r)   STMT_START { \
 334                             SV* const sv = PL_regex_pad[(o)->op_pmoffset]; \
 335                             sv_setiv(sv, PTR2IV(r)); \
 336                         } STMT_END
 337 #  ifndef PERL_CORE
 338 /* No longer used anywhere in the core.  Migrate to Devel::PPPort?  */
 339 #define PM_GETRE_SAFE(o) (PL_regex_pad ? PM_GETRE(o) : (REGEXP*)0)
 340 #define PM_SETRE_SAFE(o,r) if (PL_regex_pad) PM_SETRE(o,r)
 341 #  endif
 342 #else
 343 #define PM_GETRE(o)     ((o)->op_pmregexp)
 344 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
 345 #  ifndef PERL_CORE
 346 #define PM_GETRE_SAFE PM_GETRE
 347 #define PM_SETRE_SAFE PM_SETRE
 348 #  endif
 349 #endif
 350
 351
 352 #define PMf_RETAINT     0x00000040      /* taint $1 etc. if target tainted */
 353 #define PMf_ONCE        0x00000080      /* match successfully only once per
 354                                            reset, with related flag RXf_USED
 355                                            in re->extflags holding state.
 356                                            This is used only for ?? matches,
 357                                            and only on OP_MATCH and OP_QR */
 358
 359 #define PMf_UNUSED      0x00000100      /* free for use */
 360 #define PMf_MAYBE_CONST 0x00000200      /* replacement contains variables */
 361
 362 #define PMf_USED        0x00000400      /* PMf_ONCE has matched successfully.
 363                                            Not used under threading. */
 364
 365 #define PMf_CONST       0x00000800      /* subst replacement is constant */
 366 #define PMf_KEEP        0x00001000      /* keep 1st runtime pattern forever */
 367 #define PMf_GLOBAL      0x00002000      /* pattern had a g modifier */
 368 #define PMf_CONTINUE    0x00004000      /* don't reset pos() if //g fails */
 369 #define PMf_EVAL        0x00008000      /* evaluating replacement as expr */
 370
 371 /* The following flags have exact equivalents in regcomp.h with the prefix RXf_
 372  * which are stored in the regexp->extflags member. If you change them here,
 373  * you have to change them there, and vice versa.
 374  */
 375 #define PMf_MULTILINE   0x00000001      /* assume multiple lines */
 376 #define PMf_SINGLELINE  0x00000002      /* assume single line */
 377 #define PMf_FOLD        0x00000004      /* case insensitivity */
 378 #define PMf_EXTENDED    0x00000008      /* chuck embedded whitespace */
 379 #define PMf_KEEPCOPY    0x00000010      /* copy the string when matching */
 380 #define PMf_LOCALE      0x00000020      /* use locale for character types */
 381
 382 /* mask of bits that need to be transfered to re->extflags */
 383 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED|PMf_KEEPCOPY)
 384
 385 #ifdef USE_ITHREADS
 386
 387 #  define PmopSTASHPV(o)                                                \
 388     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstashpv : NULL)
 389 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 390 #    define PmopSTASHPV_set(o,pv)       ({                              \
 391         assert((o)->op_pmflags & PMf_ONCE);                             \
 392         ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv));        \
 393     })
 394 #  else
 395 #    define PmopSTASHPV_set(o,pv)                                       \
 396     ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv))
 397 #  endif
 398 #  define PmopSTASH(o)          (PmopSTASHPV(o) \
 399                                  ? gv_stashpv((o)->op_pmstashstartu.op_pmstashpv,GV_ADD) : NULL)
 400 #  define PmopSTASH_set(o,hv)   PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : NULL))
 401 #  define PmopSTASH_free(o)     PerlMemShared_free(PmopSTASHPV(o))
 402
 403 #else
 404 #  define PmopSTASH(o)                                                  \
 405     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
 406 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 407 #    define PmopSTASH_set(o,hv)         ({                              \
 408         assert((o)->op_pmflags & PMf_ONCE);                             \
 409         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
 410     })
 411 #  else
 412 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
 413 #  endif
 414 #  define PmopSTASHPV(o)        (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
 415    /* op_pmstashstartu.op_pmstash is not refcounted */
 416 #  define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
 417 /* Note that if this becomes non-empty, then S_forget_pmop in op.c will need
 418    changing */
 419 #  define PmopSTASH_free(o)
 420 #endif
 421
 422 struct svop {
 423     BASEOP
 424     SV *        op_sv;
 425 };
 426
 427 struct padop {
 428     BASEOP
 429     PADOFFSET   op_padix;
 430 };
 431
 432 struct pvop {
 433     BASEOP
 434     char *      op_pv;
 435 };
 436
 437 struct loop {
 438     BASEOP
 439     OP *        op_first;
 440     OP *        op_last;
 441     OP *        op_redoop;
 442     OP *        op_nextop;
 443     OP *        op_lastop;
 444 };
 445
 446 #define cUNOPx(o)       ((UNOP*)o)
 447 #define cBINOPx(o)      ((BINOP*)o)
 448 #define cLISTOPx(o)     ((LISTOP*)o)
 449 #define cLOGOPx(o)      ((LOGOP*)o)
 450 #define cPMOPx(o)       ((PMOP*)o)
 451 #define cSVOPx(o)       ((SVOP*)o)
 452 #define cPADOPx(o)      ((PADOP*)o)
 453 #define cPVOPx(o)       ((PVOP*)o)
 454 #define cCOPx(o)        ((COP*)o)
 455 #define cLOOPx(o)       ((LOOP*)o)
 456
 457 #define cUNOP           cUNOPx(PL_op)
 458 #define cBINOP          cBINOPx(PL_op)
 459 #define cLISTOP         cLISTOPx(PL_op)
 460 #define cLOGOP          cLOGOPx(PL_op)
 461 #define cPMOP           cPMOPx(PL_op)
 462 #define cSVOP           cSVOPx(PL_op)
 463 #define cPADOP          cPADOPx(PL_op)
 464 #define cPVOP           cPVOPx(PL_op)
 465 #define cCOP            cCOPx(PL_op)
 466 #define cLOOP           cLOOPx(PL_op)
 467
 468 #define cUNOPo          cUNOPx(o)
 469 #define cBINOPo         cBINOPx(o)
 470 #define cLISTOPo        cLISTOPx(o)
 471 #define cLOGOPo         cLOGOPx(o)
 472 #define cPMOPo          cPMOPx(o)
 473 #define cSVOPo          cSVOPx(o)
 474 #define cPADOPo         cPADOPx(o)
 475 #define cPVOPo          cPVOPx(o)
 476 #define cCOPo           cCOPx(o)
 477 #define cLOOPo          cLOOPx(o)
 478
 479 #define kUNOP           cUNOPx(kid)
 480 #define kBINOP          cBINOPx(kid)
 481 #define kLISTOP         cLISTOPx(kid)
 482 #define kLOGOP          cLOGOPx(kid)
 483 #define kPMOP           cPMOPx(kid)
 484 #define kSVOP           cSVOPx(kid)
 485 #define kPADOP          cPADOPx(kid)
 486 #define kPVOP           cPVOPx(kid)
 487 #define kCOP            cCOPx(kid)
 488 #define kLOOP           cLOOPx(kid)
 489
 490
 491 #ifdef USE_ITHREADS
 492 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
 493 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
 494                                  && GvIN_PAD(v))
 495 #  define       IS_PADCONST(v)  (v && SvREADONLY(v))
 496 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
 497                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
 498 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
 499                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
 500 #else
 501 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
 502 #  define       IS_PADGV(v)     FALSE
 503 #  define       IS_PADCONST(v)  FALSE
 504 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
 505 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
 506 #endif
 507
 508 #define cGVOP_gv                cGVOPx_gv(PL_op)
 509 #define cGVOPo_gv               cGVOPx_gv(o)
 510 #define kGVOP_gv                cGVOPx_gv(kid)
 511 #define cSVOP_sv                cSVOPx_sv(PL_op)
 512 #define cSVOPo_sv               cSVOPx_sv(o)
 513 #define kSVOP_sv                cSVOPx_sv(kid)
 514
 515 #define Nullop ((OP*)NULL)
 516
 517 /* Lowest byte-and-a-bit of PL_opargs */
 518 #define OA_MARK 1
 519 #define OA_FOLDCONST 2
 520 #define OA_RETSCALAR 4
 521 #define OA_TARGET 8
 522 #define OA_RETINTEGER 16
 523 #define OA_OTHERINT 32
 524 #define OA_DANGEROUS 64
 525 #define OA_DEFGV 128
 526 #define OA_TARGLEX 256
 527
 528 /* The next 4 bits encode op class information */
 529 #define OCSHIFT 9
 530
 531 #define OA_CLASS_MASK (15 << OCSHIFT)
 532
 533 #define OA_BASEOP (0 << OCSHIFT)
 534 #define OA_UNOP (1 << OCSHIFT)
 535 #define OA_BINOP (2 << OCSHIFT)
 536 #define OA_LOGOP (3 << OCSHIFT)
 537 #define OA_LISTOP (4 << OCSHIFT)
 538 #define OA_PMOP (5 << OCSHIFT)
 539 #define OA_SVOP (6 << OCSHIFT)
 540 #define OA_PADOP (7 << OCSHIFT)
 541 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
 542 #define OA_LOOP (9 << OCSHIFT)
 543 #define OA_COP (10 << OCSHIFT)
 544 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
 545 #define OA_FILESTATOP (12 << OCSHIFT)
 546 #define OA_LOOPEXOP (13 << OCSHIFT)
 547
 548 #define OASHIFT 13
 549
 550 /* Remaining nybbles of PL_opargs */
 551 #define OA_SCALAR 1
 552 #define OA_LIST 2
 553 #define OA_AVREF 3
 554 #define OA_HVREF 4
 555 #define OA_CVREF 5
 556 #define OA_FILEREF 6
 557 #define OA_SCALARREF 7
 558 #define OA_OPTIONAL 8
 559
 560 /* Op_REFCNT is a reference count at the head of each op tree: needed
 561  * since the tree is shared between threads, and between cloned closure
 562  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
 563  * this count.
 564  * The same mutex is used to protect the refcounts of the reg_trie_data
 565  * and reg_ac_data structures, which are shared between duplicated
 566  * regexes.
 567  */
 568
 569 #ifdef USE_ITHREADS
 570 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
 571 #  ifdef PERL_CORE
 572 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
 573 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
 574 #  else
 575 #    define OP_REFCNT_LOCK              op_refcnt_lock()
 576 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
 577 #  endif
 578 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
 579 #else
 580 #  define OP_REFCNT_INIT                NOOP
 581 #  define OP_REFCNT_LOCK                NOOP
 582 #  define OP_REFCNT_UNLOCK              NOOP
 583 #  define OP_REFCNT_TERM                NOOP
 584 #endif
 585
 586 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
 587 #ifdef PERL_DEBUG_READONLY_OPS
 588 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
 589 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
 590 #else
 591 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
 592 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
 593 #endif
 594
 595 /* flags used by Perl_load_module() */
 596 #define PERL_LOADMOD_DENY               0x1
 597 #define PERL_LOADMOD_NOIMPORT           0x2
 598 #define PERL_LOADMOD_IMPORT_OPS         0x4
 599
 600 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
 601 #define ref(o, type) doref(o, type, TRUE)
 602 #endif
 603
 604 /* no longer used anywhere in core */
 605 #ifndef PERL_CORE
 606 #define cv_ckproto(cv, gv, p) \
 607    cv_ckproto_len((cv), (gv), (p), (p) ? strlen(p) : 0)
 608 #endif
 609
 610 #ifdef USE_REENTRANT_API
 611 #include "reentr.h"
 612 #endif
 613
 614 #if defined(PL_OP_SLAB_ALLOC)
 615 #define NewOp(m,var,c,type)     \
 616         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
 617 #define NewOpSz(m,var,size)     \
 618         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
 619 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
 620 #else
 621 #define NewOp(m, var, c, type)  \
 622         (var = (MEM_WRAP_CHECK_(c,type) \
 623          (type*)PerlMemShared_calloc(c, sizeof(type))))
 624 #define NewOpSz(m, var, size)   \
 625         (var = (OP*)PerlMemShared_calloc(1, size))
 626 #define FreeOp(p) PerlMemShared_free(p)
 627 #endif
 628
 629 #ifdef PERL_MAD
 630 #  define MAD_NULL 1
 631 #  define MAD_PV 2
 632 #  define MAD_OP 3
 633 #  define MAD_SV 4
 634
 635 struct madprop {
 636     MADPROP* mad_next;
 637     const void *mad_val;
 638     U32 mad_vlen;
 639 /*    short mad_count; */
 640     char mad_key;
 641     char mad_type;
 642 };
 643
 644 struct token {
 645     I32 tk_type;
 646     YYSTYPE tk_lval;
 647     MADPROP* tk_mad;
 648 };
 649 #endif
 650
 651 /*
 652  * Values that can be held by mad_key :
 653  * ^       unfilled head spot
 654  * ,       literal ,
 655  * ;       literal ; (blank if implicit ; at end of block)
 656  * :       literal : from ?: or attr list
 657  * +       unary +
 658  * ?       literal ? from ?:
 659  * (       literal (
 660  * )       literal )
 661  * [       literal [
 662  * ]       literal ]
 663  * {       literal {
 664  * }       literal }
 665  * @       literal @ sigil
 666  * $       literal $ sigil
 667  * *       literal * sigil
 668  * !       use is source filtered
 669  * &       & or sub
 670  * #       whitespace/comment following ; or }
 671  * #       $# sigil
 672  * 1       1st ; from for(;;)
 673  * 1       retired protasis
 674  * 2       2nd ; from for(;;)
 675  * 2       retired apodosis
 676  * 3       C-style for list
 677  * a       sub or var attributes
 678  * a       non-method arrow operator
 679  * A       method arrow operator
 680  * A       use import args
 681  * b       format block
 682  * B       retired stub block
 683  * C       constant conditional op
 684  * d       declarator
 685  * D       do block
 686  * e       unreached "else" (see C)
 687  * e       expression producing E
 688  * E       tr/E/R/, /E/
 689  * f       folded constant op
 690  * F       peg op for format
 691  * g       op was forced to be a word
 692  * i       if/unless modifier
 693  * I       if/elsif/unless statement
 694  * k       local declarator
 695  * K       retired kid op
 696  * l       last index of array ($#foo)
 697  * L       label
 698  * m       modifier on regex
 699  * n       sub or format name
 700  * o       current operator/declarator name
 701  * o       else/continue
 702  * O       generic optimized op
 703  * p       peg to hold extra whitespace at statement level
 704  * P       peg op for package declaration
 705  * q       opening quote
 706  * =       quoted material
 707  * Q       closing quote
 708  * Q       optimized qw//
 709  * r       expression producing R
 710  * R       tr/E/R/ s/E/R/
 711  * s       sub signature
 712  * S       use import stub (no import)
 713  * S       retired sort block
 714  * t       unreached "then" (see C)
 715  * U       use import op
 716  * v       private sv of for loop
 717  * V       use version
 718  * w       while/until modifier
 719  * W       while/for statement
 720  * x       optimized qw
 721  * X       random thing
 722  * _       whitespace/comments preceding anything else
 723  * ~       =~ operator
 724  */
 725
 726 /*
 727  * Local variables:
 728  * c-indentation-style: bsd
 729  * c-basic-offset: 4
 730  * indent-tabs-mode: t
 731  * End:
 732  *
 733  * ex: set ts=8 sts=4 sw=4 noet:
 734  */