op.h

   1 /*    op.h
   2  *
   3  *    Copyright (c) 1991-2000, Larry Wall
   4  *
   5  *    You may distribute under the terms of either the GNU General Public
   6  *    License or the Artistic License, as specified in the README file.
   7  *
   8  */
   9
  10 /*
  11  * The fields of BASEOP are:
  12  *      op_next         Pointer to next ppcode to execute after this one.
  13  *                      (Top level pre-grafted op points to first op,
  14  *                      but this is replaced when op is grafted in, when
  15  *                      this op will point to the real next op, and the new
  16  *                      parent takes over role of remembering starting op.)
  17  *      op_ppaddr       Pointer to current ppcode's function.
  18  *      op_type         The type of the operation.
  19  *      op_flags        Flags common to all operations.  See OPf_* below.
  20  *      op_private      Flags peculiar to a particular operation (BUT,
  21  *                      by default, set to the number of children until
  22  *                      the operation is privatized by a check routine,
  23  *                      which may or may not check number of children).
  24  */
  25
  26 typedef U32 PADOFFSET;
  27 #define NOT_IN_PAD ((PADOFFSET) -1)
  28
  29 #ifdef DEBUGGING_OPS
  30 #define OPCODE opcode
  31 #else
  32 #define OPCODE U16
  33 #endif
  34
  35 #ifdef BASEOP_DEFINITION
  36 #define BASEOP BASEOP_DEFINITION
  37 #else
  38 #define BASEOP                          \
  39     OP*         op_next;                \
  40     OP*         op_sibling;             \
  41     OP*         (CPERLscope(*op_ppaddr))(pTHX);         \
  42     PADOFFSET   op_targ;                \
  43     OPCODE      op_type;                \
  44     U16         op_seq;                 \
  45     U8          op_flags;               \
  46     U8          op_private;
  47 #endif
  48
  49 #define OP_GIMME(op,dfl) \
  50         (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID   ? G_VOID   : \
  51          ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
  52          ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST   ? G_ARRAY   : \
  53          dfl)
  54
  55 /*
  56 =for apidoc Amn|U32|GIMME_V
  57 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
  58 C<G_SCALAR> or C<G_ARRAY> for void, scalar or array context,
  59 respectively.
  60
  61 =for apidoc Amn|U32|GIMME
  62 A backward-compatible version of C<GIMME_V> which can only return
  63 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
  64 Deprecated.  Use C<GIMME_V> instead.
  65
  66 =cut
  67 */
  68
  69 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
  70
  71 /* Public flags */
  72
  73 #define OPf_WANT        3       /* Mask for "want" bits: */
  74 #define  OPf_WANT_VOID   1      /*   Want nothing */
  75 #define  OPf_WANT_SCALAR 2      /*   Want single value */
  76 #define  OPf_WANT_LIST   3      /*   Want list of any length */
  77 #define OPf_KIDS        4       /* There is a firstborn child. */
  78 #define OPf_PARENS      8       /* This operator was parenthesized. */
  79                                 /*  (Or block needs explicit scope entry.) */
  80 #define OPf_REF         16      /* Certified reference. */
  81                                 /*  (Return container, not containee). */
  82 #define OPf_MOD         32      /* Will modify (lvalue). */
  83 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
  84 #define OPf_SPECIAL     128     /* Do something weird for this op: */
  85                                 /*  On local LVAL, don't init local value. */
  86                                 /*  On OP_SORT, subroutine is inlined. */
  87                                 /*  On OP_NOT, inversion was implicit. */
  88                                 /*  On OP_LEAVE, don't restore curpm. */
  89                                 /*  On truncate, we truncate filehandle */
  90                                 /*  On control verbs, we saw no label */
  91                                 /*  On flipflop, we saw ... instead of .. */
  92                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
  93                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
  94                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
  95                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
  96                                 /*  On OP_ENTERITER, loop var is per-thread */
  97                                 /*  On pushre, re is /\s+/ imp. by split " " */
  98
  99 /* old names; don't use in new code, but don't break them, either */
 100 #define OPf_LIST        OPf_WANT_LIST
 101 #define OPf_KNOW        OPf_WANT
 102
 103 #define GIMME \
 104           (PL_op->op_flags & OPf_WANT                                   \
 105            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
 106               ? G_ARRAY                                                 \
 107               : G_SCALAR)                                               \
 108            : dowantarray())
 109
 110 /* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
 111  * bits of PL_hints in op_private */
 112
 113 /* Private for lvalues */
 114 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
 115
 116 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
 117 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
 118
 119 /* Private for OP_AASSIGN */
 120 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
 121
 122 /* Private for OP_SASSIGN */
 123 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
 124
 125 /* Private for OP_MATCH and OP_SUBST{,CONST} */
 126 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
 127
 128 /* Private for OP_TRANS */
 129 #define OPpTRANS_FROM_UTF       1
 130 #define OPpTRANS_TO_UTF         2
 131 #define OPpTRANS_IDENTICAL      4
 132         /* When CU or UC, means straight latin-1 to utf-8 or vice versa */
 133         /* Otherwise, IDENTICAL means the right side is the same as the left */
 134 #define OPpTRANS_SQUASH         8
 135 #define OPpTRANS_DELETE         16
 136 #define OPpTRANS_COMPLEMENT     32
 137 #define OPpTRANS_GROWS          64
 138
 139 /* Private for OP_REPEAT */
 140 #define OPpREPEAT_DOLIST        64      /* List replication. */
 141
 142 /* Private for OP_LEAVELOOP */
 143 #define OPpLOOP_CONTINUE        64      /* a continue block is present */
 144
 145 /* Private for OP_RV2?V, OP_?ELEM */
 146 #define OPpDEREF                (32|64) /* Want ref to something: */
 147 #define OPpDEREF_AV             32      /*   Want ref to AV. */
 148 #define OPpDEREF_HV             64      /*   Want ref to HV. */
 149 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
 150   /* OP_ENTERSUB only */
 151 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
 152 #define OPpENTERSUB_HASTARG     32      /* Called from OP tree. */
 153   /* OP_RV2CV only */
 154 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
 155 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
 156 #define OPpENTERSUB_INARGS      4       /* Lval used as arg to a sub. */
 157   /* OP_GV only */
 158 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
 159   /* OP_?ELEM only */
 160 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
 161   /* OP_RV2?V, OP_GVSV only */
 162 #define OPpOUR_INTRO            16      /* Defer creation of array/hash elem */
 163   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
 164
 165 /* Private for OPs with TARGLEX */
 166   /* (lower bits may carry MAXARG) */
 167 #define OPpTARGET_MY            16      /* Target is PADMY. */
 168
 169 /* Private for OP_CONST */
 170 #define OPpCONST_STRICT         8       /* bearword subject to strict 'subs' */
 171 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
 172 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
 173 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
 174 #define OPpCONST_WARNING        128     /* Was a $^W translated to constant. */
 175
 176 /* Private for OP_FLIP/FLOP */
 177 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
 178
 179 /* Private for OP_LIST */
 180 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
 181
 182 /* Private for OP_DELETE */
 183 #define OPpSLICE                64      /* Operating on a list of keys */
 184
 185 /* Private for OP_EXISTS */
 186 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
 187
 188 /* Private for OP_SORT, OP_PRTF, OP_SPRINTF, OP_FTTEXT, OP_FTBINARY, */
 189 /*             string comparisons, and case changers. */
 190 #define OPpLOCALE               64      /* Use locale */
 191
 192 /* Private for OP_SORT */
 193 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
 194 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
 195 #define OPpSORT_REVERSE         4       /* Descending sort */
 196 /* Private for OP_THREADSV */
 197 #define OPpDONE_SVREF           64      /* Been through newSVREF once */
 198
 199 struct op {
 200     BASEOP
 201 };
 202
 203 struct unop {
 204     BASEOP
 205     OP *        op_first;
 206 };
 207
 208 struct binop {
 209     BASEOP
 210     OP *        op_first;
 211     OP *        op_last;
 212 };
 213
 214 struct logop {
 215     BASEOP
 216     OP *        op_first;
 217     OP *        op_other;
 218 };
 219
 220 struct listop {
 221     BASEOP
 222     OP *        op_first;
 223     OP *        op_last;
 224     U32         op_children;
 225 };
 226
 227 struct pmop {
 228     BASEOP
 229     OP *        op_first;
 230     OP *        op_last;
 231     U32         op_children;
 232     OP *        op_pmreplroot;
 233     OP *        op_pmreplstart;
 234     PMOP *      op_pmnext;              /* list of all scanpats */
 235     REGEXP *    op_pmregexp;            /* compiled expression */
 236     U16         op_pmflags;
 237     U16         op_pmpermflags;
 238     U8          op_pmdynflags;
 239 };
 240
 241 #define PMdf_USED       0x01            /* pm has been used once already */
 242 #define PMdf_TAINTED    0x02            /* pm compiled from tainted pattern */
 243 #define PMdf_UTF8       0x04            /* pm compiled from utf8 data */
 244
 245 #define PMf_RETAINT     0x0001          /* taint $1 etc. if target tainted */
 246 #define PMf_ONCE        0x0002          /* use pattern only once per reset */
 247 #define PMf_REVERSED    0x0004          /* Should be matched right->left */
 248 #define PMf_MAYBE_CONST 0x0008          /* replacement contains variables */
 249 #define PMf_SKIPWHITE   0x0010          /* skip leading whitespace for split */
 250 #define PMf_WHITE       0x0020          /* pattern is \s+ */
 251 #define PMf_CONST       0x0040          /* subst replacement is constant */
 252 #define PMf_KEEP        0x0080          /* keep 1st runtime pattern forever */
 253 #define PMf_GLOBAL      0x0100          /* pattern had a g modifier */
 254 #define PMf_CONTINUE    0x0200          /* don't reset pos() if //g fails */
 255 #define PMf_EVAL        0x0400          /* evaluating replacement as expr */
 256 #define PMf_LOCALE      0x0800          /* use locale for character types */
 257 #define PMf_MULTILINE   0x1000          /* assume multiple lines */
 258 #define PMf_SINGLELINE  0x2000          /* assume single line */
 259 #define PMf_FOLD        0x4000          /* case insensitivity */
 260 #define PMf_EXTENDED    0x8000          /* chuck embedded whitespace */
 261
 262 /* mask of bits stored in regexp->reganch */
 263 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
 264
 265 struct svop {
 266     BASEOP
 267     SV *        op_sv;
 268 };
 269
 270 struct padop {
 271     BASEOP
 272     PADOFFSET   op_padix;
 273 };
 274
 275 struct pvop {
 276     BASEOP
 277     char *      op_pv;
 278 };
 279
 280 struct loop {
 281     BASEOP
 282     OP *        op_first;
 283     OP *        op_last;
 284     U32         op_children;
 285     OP *        op_redoop;
 286     OP *        op_nextop;
 287     OP *        op_lastop;
 288 };
 289
 290 #define cUNOPx(o)       ((UNOP*)o)
 291 #define cBINOPx(o)      ((BINOP*)o)
 292 #define cLISTOPx(o)     ((LISTOP*)o)
 293 #define cLOGOPx(o)      ((LOGOP*)o)
 294 #define cPMOPx(o)       ((PMOP*)o)
 295 #define cSVOPx(o)       ((SVOP*)o)
 296 #define cPADOPx(o)      ((PADOP*)o)
 297 #define cPVOPx(o)       ((PVOP*)o)
 298 #define cCOPx(o)        ((COP*)o)
 299 #define cLOOPx(o)       ((LOOP*)o)
 300
 301 #define cUNOP           cUNOPx(PL_op)
 302 #define cBINOP          cBINOPx(PL_op)
 303 #define cLISTOP         cLISTOPx(PL_op)
 304 #define cLOGOP          cLOGOPx(PL_op)
 305 #define cPMOP           cPMOPx(PL_op)
 306 #define cSVOP           cSVOPx(PL_op)
 307 #define cPADOP          cPADOPx(PL_op)
 308 #define cPVOP           cPVOPx(PL_op)
 309 #define cCOP            cCOPx(PL_op)
 310 #define cLOOP           cLOOPx(PL_op)
 311
 312 #define cUNOPo          cUNOPx(o)
 313 #define cBINOPo         cBINOPx(o)
 314 #define cLISTOPo        cLISTOPx(o)
 315 #define cLOGOPo         cLOGOPx(o)
 316 #define cPMOPo          cPMOPx(o)
 317 #define cSVOPo          cSVOPx(o)
 318 #define cPADOPo         cPADOPx(o)
 319 #define cPVOPo          cPVOPx(o)
 320 #define cCOPo           cCOPx(o)
 321 #define cLOOPo          cLOOPx(o)
 322
 323 #define kUNOP           cUNOPx(kid)
 324 #define kBINOP          cBINOPx(kid)
 325 #define kLISTOP         cLISTOPx(kid)
 326 #define kLOGOP          cLOGOPx(kid)
 327 #define kPMOP           cPMOPx(kid)
 328 #define kSVOP           cSVOPx(kid)
 329 #define kPADOP          cPADOPx(kid)
 330 #define kPVOP           cPVOPx(kid)
 331 #define kCOP            cCOPx(kid)
 332 #define kLOOP           cLOOPx(kid)
 333
 334
 335 #ifdef USE_ITHREADS
 336 #  define       cGVOPx_gv(o)    ((GV*)PL_curpad[cPADOPx(o)->op_padix])
 337 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && GvIN_PAD(v))
 338 #  define       IS_PADCONST(v)  (v && SvREADONLY(v))
 339 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
 340                                  ? cSVOPx(v)->op_sv : PL_curpad[(v)->op_targ])
 341 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
 342                                  ? &cSVOPx(v)->op_sv : &PL_curpad[(v)->op_targ])
 343 #else
 344 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
 345 #  define       IS_PADGV(v)     FALSE
 346 #  define       IS_PADCONST(v)  FALSE
 347 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
 348 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
 349 #endif
 350
 351 #define cGVOP_gv                cGVOPx_gv(PL_op)
 352 #define cGVOPo_gv               cGVOPx_gv(o)
 353 #define kGVOP_gv                cGVOPx_gv(kid)
 354 #define cSVOP_sv                cSVOPx_sv(PL_op)
 355 #define cSVOPo_sv               cSVOPx_sv(o)
 356 #define kSVOP_sv                cSVOPx_sv(kid)
 357
 358 #define Nullop Null(OP*)
 359
 360 /* Lowest byte of PL_opargs */
 361 #define OA_MARK 1
 362 #define OA_FOLDCONST 2
 363 #define OA_RETSCALAR 4
 364 #define OA_TARGET 8
 365 #define OA_RETINTEGER 16
 366 #define OA_OTHERINT 32
 367 #define OA_DANGEROUS 64
 368 #define OA_DEFGV 128
 369 #define OA_TARGLEX 256
 370
 371 /* The next 4 bits encode op class information */
 372 #define OCSHIFT 9
 373
 374 #define OA_CLASS_MASK (15 << OCSHIFT)
 375
 376 #define OA_BASEOP (0 << OCSHIFT)
 377 #define OA_UNOP (1 << OCSHIFT)
 378 #define OA_BINOP (2 << OCSHIFT)
 379 #define OA_LOGOP (3 << OCSHIFT)
 380 #define OA_LISTOP (4 << OCSHIFT)
 381 #define OA_PMOP (5 << OCSHIFT)
 382 #define OA_SVOP (6 << OCSHIFT)
 383 #define OA_PADOP (7 << OCSHIFT)
 384 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
 385 #define OA_LOOP (9 << OCSHIFT)
 386 #define OA_COP (10 << OCSHIFT)
 387 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
 388 #define OA_FILESTATOP (12 << OCSHIFT)
 389 #define OA_LOOPEXOP (13 << OCSHIFT)
 390
 391 #define OASHIFT 13
 392
 393 /* Remaining nybbles of PL_opargs */
 394 #define OA_SCALAR 1
 395 #define OA_LIST 2
 396 #define OA_AVREF 3
 397 #define OA_HVREF 4
 398 #define OA_CVREF 5
 399 #define OA_FILEREF 6
 400 #define OA_SCALARREF 7
 401 #define OA_OPTIONAL 8
 402