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