op.h

   1 /*    op.h
   2  *
   3  *    Copyright (c) 1991-1994, 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
  28 #ifdef DEBUGGING_OPS
  29 #define OPCODE opcode
  30 #else
  31 #define OPCODE U16
  32 #endif
  33
  34 #define BASEOP                          \
  35     OP*         op_next;                \
  36     OP*         op_sibling;             \
  37     OP*         (*op_ppaddr)();         \
  38     PADOFFSET   op_targ;                \
  39     OPCODE      op_type;                \
  40     U16         op_seq;                 \
  41     U8          op_flags;               \
  42     U8          op_private;
  43
  44 #define GIMME (op->op_flags & OPf_KNOW ? op->op_flags & OPf_LIST : dowantarray())
  45
  46 /* Public flags */
  47 #define OPf_LIST        1       /* Do operator in list context. */
  48 #define OPf_KNOW        2       /* Context is known. */
  49 #define OPf_KIDS        4       /* There is a firstborn child. */
  50 #define OPf_PARENS      8       /* This operator was parenthesized. */
  51                                 /*  (Or block needs explicit scope entry.) */
  52 #define OPf_REF         16      /* Certified reference. */
  53                                 /*  (Return container, not containee). */
  54 #define OPf_MOD         32      /* Will modify (lvalue). */
  55 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
  56 #define OPf_SPECIAL     128     /* Do something weird for this op: */
  57                                 /*  On local LVAL, don't init local value. */
  58                                 /*  On OP_SORT, subroutine is inlined. */
  59                                 /*  On OP_NOT, inversion was implicit. */
  60                                 /*  On OP_LEAVE, don't restore curpm. */
  61                                 /*  On truncate, we truncate filehandle */
  62                                 /*  On control verbs, we saw no label */
  63                                 /*  On flipflop, we saw ... instead of .. */
  64                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
  65                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
  66                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
  67
  68 /* Private for lvalues */
  69 #define OPpLVAL_INTRO   128     /* Lvalue must be localized */
  70
  71 /* Private for OP_AASSIGN */
  72 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
  73
  74 /* Private for OP_SASSIGN */
  75 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
  76
  77 /* Private for OP_TRANS */
  78 #define OPpTRANS_SQUASH         16
  79 #define OPpTRANS_DELETE         32
  80 #define OPpTRANS_COMPLEMENT     64
  81
  82 /* Private for OP_REPEAT */
  83 #define OPpREPEAT_DOLIST        64      /* List replication. */
  84
  85 /* Private for OP_ENTERSUB, OP_RV2?V, OP_?ELEM */
  86   /* (lower bits carry hints) */
  87 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
  88 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
  89 #define OPpDEREF                (32|64) /* Want ref to something: */
  90 #define OPpDEREF_AV             32      /*   Want ref to AV. */
  91 #define OPpDEREF_HV             64      /*   Want ref to HV. */
  92 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
  93
  94 /* Private for OP_CONST */
  95 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
  96 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
  97 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
  98
  99 /* Private for OP_FLIP/FLOP */
 100 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
 101
 102 /* Private for OP_LIST */
 103 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
 104
 105 /* Private for OP_LEAVE, OP_DELETE, and friends(?) */
 106 #define OPpLEAVE_VOID           64      /* No need to copy out values. */
 107
 108 /* Private for OP_DELETE */
 109 #define OPpSLICE                32      /* Operating on a list of keys */
 110
 111 /* Private for OP_SORT, OP_PRTF, OP_SPRINTF, string cmp'n, and case changers */
 112 #define OPpLOCALE               64      /* Use locale */
 113
 114 struct op {
 115     BASEOP
 116 };
 117
 118 struct unop {
 119     BASEOP
 120     OP *        op_first;
 121 };
 122
 123 struct binop {
 124     BASEOP
 125     OP *        op_first;
 126     OP *        op_last;
 127 };
 128
 129 struct logop {
 130     BASEOP
 131     OP *        op_first;
 132     OP *        op_other;
 133 };
 134
 135 struct condop {
 136     BASEOP
 137     OP *        op_first;
 138     OP *        op_true;
 139     OP *        op_false;
 140 };
 141
 142 struct listop {
 143     BASEOP
 144     OP *        op_first;
 145     OP *        op_last;
 146     U32         op_children;
 147 };
 148
 149 struct pmop {
 150     BASEOP
 151     OP *        op_first;
 152     OP *        op_last;
 153     U32         op_children;
 154     OP *        op_pmreplroot;
 155     OP *        op_pmreplstart;
 156     PMOP *      op_pmnext;              /* list of all scanpats */
 157     REGEXP *    op_pmregexp;            /* compiled expression */
 158     SV *        op_pmshort;             /* for a fast bypass of execute() */
 159     U16         op_pmflags;
 160     U16         op_pmpermflags;
 161     char        op_pmslen;
 162 };
 163
 164 #define PMf_USED        0x0001          /* pm has been used once already */
 165 #define PMf_ONCE        0x0002          /* use pattern only once per reset */
 166 #define PMf_SCANFIRST   0x0004          /* initial constant not anchored */
 167 #define PMf_ALL         0x0008          /* initial constant is whole pat */
 168 #define PMf_SKIPWHITE   0x0010          /* skip leading whitespace for split */
 169 #define PMf_FOLD        0x0020          /* case insensitivity */
 170 #define PMf_CONST       0x0040          /* subst replacement is constant */
 171 #define PMf_KEEP        0x0080          /* keep 1st runtime pattern forever */
 172 #define PMf_GLOBAL      0x0100          /* pattern had a g modifier */
 173 #define PMf_RUNTIME     0x0200          /* pattern coming in on the stack */
 174 #define PMf_EVAL        0x0400          /* evaluating replacement as expr */
 175 #define PMf_WHITE       0x0800          /* pattern is \s+ */
 176 #define PMf_MULTILINE   0x1000          /* assume multiple lines */
 177 #define PMf_SINGLELINE  0x2000          /* assume single line */
 178 #define PMf_LOCALE      0x4000          /* use locale for character types */
 179 #define PMf_EXTENDED    0x8000          /* chuck embedded whitespace */
 180
 181 struct svop {
 182     BASEOP
 183     SV *        op_sv;
 184 };
 185
 186 struct gvop {
 187     BASEOP
 188     GV *        op_gv;
 189 };
 190
 191 struct pvop {
 192     BASEOP
 193     char *      op_pv;
 194 };
 195
 196 struct loop {
 197     BASEOP
 198     OP *        op_first;
 199     OP *        op_last;
 200     U32         op_children;
 201     OP *        op_redoop;
 202     OP *        op_nextop;
 203     OP *        op_lastop;
 204 };
 205
 206 #define cUNOP ((UNOP*)op)
 207 #define cBINOP ((BINOP*)op)
 208 #define cLISTOP ((LISTOP*)op)
 209 #define cLOGOP ((LOGOP*)op)
 210 #define cCONDOP ((CONDOP*)op)
 211 #define cPMOP ((PMOP*)op)
 212 #define cSVOP ((SVOP*)op)
 213 #define cGVOP ((GVOP*)op)
 214 #define cPVOP ((PVOP*)op)
 215 #define cCOP ((COP*)op)
 216 #define cLOOP ((LOOP*)op)
 217
 218 #define kUNOP ((UNOP*)kid)
 219 #define kBINOP ((BINOP*)kid)
 220 #define kLISTOP ((LISTOP*)kid)
 221 #define kLOGOP ((LOGOP*)kid)
 222 #define kCONDOP ((CONDOP*)kid)
 223 #define kPMOP ((PMOP*)kid)
 224 #define kSVOP ((SVOP*)kid)
 225 #define kGVOP ((GVOP*)kid)
 226 #define kPVOP ((PVOP*)kid)
 227 #define kCOP ((COP*)kid)
 228 #define kLOOP ((LOOP*)kid)
 229
 230 #define Nullop Null(OP*)
 231
 232 /* Lowest byte of opargs */
 233 #define OA_MARK 1
 234 #define OA_FOLDCONST 2
 235 #define OA_RETSCALAR 4
 236 #define OA_TARGET 8
 237 #define OA_RETINTEGER 16
 238 #define OA_OTHERINT 32
 239 #define OA_DANGEROUS 64
 240 #define OA_DEFGV 128
 241
 242 #define OASHIFT 8
 243
 244 /* Remaining nybbles of opargs */
 245 #define OA_SCALAR 1
 246 #define OA_LIST 2
 247 #define OA_AVREF 3
 248 #define OA_HVREF 4
 249 #define OA_CVREF 5
 250 #define OA_FILEREF 6
 251 #define OA_SCALARREF 7
 252 #define OA_OPTIONAL 8
 253