| 1 | /* op.h
|
|---|
| 2 | *
|
|---|
| 3 | * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
|
|---|
| 4 | * 2000, 2001, 2002, 2003, 2004, 2005 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_flags Flags common to all operations. See OPf_* below.
|
|---|
| 21 | * op_private Flags peculiar to a particular operation (BUT,
|
|---|
| 22 | * by default, set to the number of children until
|
|---|
| 23 | * the operation is privatized by a check routine,
|
|---|
| 24 | * which may or may not check number of children).
|
|---|
| 25 | */
|
|---|
| 26 |
|
|---|
| 27 | #ifdef DEBUGGING_OPS
|
|---|
| 28 | #define OPCODE opcode
|
|---|
| 29 | #else
|
|---|
| 30 | #define OPCODE U16
|
|---|
| 31 | #endif
|
|---|
| 32 |
|
|---|
| 33 | #ifdef BASEOP_DEFINITION
|
|---|
| 34 | #define BASEOP BASEOP_DEFINITION
|
|---|
| 35 | #else
|
|---|
| 36 | #define BASEOP \
|
|---|
| 37 | OP* op_next; \
|
|---|
| 38 | OP* op_sibling; \
|
|---|
| 39 | OP* (CPERLscope(*op_ppaddr))(pTHX); \
|
|---|
| 40 | PADOFFSET op_targ; \
|
|---|
| 41 | OPCODE op_type; \
|
|---|
| 42 | U16 op_seq; \
|
|---|
| 43 | U8 op_flags; \
|
|---|
| 44 | U8 op_private;
|
|---|
| 45 | #endif
|
|---|
| 46 |
|
|---|
| 47 | #define OP_GIMME(op,dfl) \
|
|---|
| 48 | (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID ? G_VOID : \
|
|---|
| 49 | ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
|
|---|
| 50 | ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST ? G_ARRAY : \
|
|---|
| 51 | dfl)
|
|---|
| 52 |
|
|---|
| 53 | /*
|
|---|
| 54 | =head1 "Gimme" Values
|
|---|
| 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 list 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 | /* On regcomp, "use re 'eval'" was in scope */
|
|---|
| 99 | /* On OP_READLINE, was <$filehandle> */
|
|---|
| 100 | /* On RV2[ACGHS]V, don't create GV--in
|
|---|
| 101 | defined()*/
|
|---|
| 102 | /* On OP_DBSTATE, indicates breakpoint
|
|---|
| 103 | * (runtime property) */
|
|---|
| 104 | /* On OP_AELEMFAST, indiciates pad var */
|
|---|
| 105 |
|
|---|
| 106 | /* old names; don't use in new code, but don't break them, either */
|
|---|
| 107 | #define OPf_LIST OPf_WANT_LIST
|
|---|
| 108 | #define OPf_KNOW OPf_WANT
|
|---|
| 109 |
|
|---|
| 110 | #define GIMME \
|
|---|
| 111 | (PL_op->op_flags & OPf_WANT \
|
|---|
| 112 | ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
|
|---|
| 113 | ? G_ARRAY \
|
|---|
| 114 | : G_SCALAR) \
|
|---|
| 115 | : dowantarray())
|
|---|
| 116 |
|
|---|
| 117 | /* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
|
|---|
| 118 | * bits of PL_hints in op_private */
|
|---|
| 119 |
|
|---|
| 120 | /* Private for lvalues */
|
|---|
| 121 | #define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
|
|---|
| 122 |
|
|---|
| 123 | /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
|
|---|
| 124 | #define OPpREFCOUNTED 64 /* op_targ carries a refcount */
|
|---|
| 125 |
|
|---|
| 126 | /* Private for OP_AASSIGN */
|
|---|
| 127 | #define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
|
|---|
| 128 | #define OPpASSIGN_HASH 32 /* Assigning to possible pseudohash. */
|
|---|
| 129 |
|
|---|
| 130 | /* Private for OP_SASSIGN */
|
|---|
| 131 | #define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
|
|---|
| 132 |
|
|---|
| 133 | /* Private for OP_MATCH and OP_SUBST{,CONST} */
|
|---|
| 134 | #define OPpRUNTIME 64 /* Pattern coming in on the stack */
|
|---|
| 135 |
|
|---|
| 136 | /* Private for OP_TRANS */
|
|---|
| 137 | #define OPpTRANS_FROM_UTF 1
|
|---|
| 138 | #define OPpTRANS_TO_UTF 2
|
|---|
| 139 | #define OPpTRANS_IDENTICAL 4 /* right side is same as left */
|
|---|
| 140 | #define OPpTRANS_SQUASH 8
|
|---|
| 141 | #define OPpTRANS_DELETE 16
|
|---|
| 142 | #define OPpTRANS_COMPLEMENT 32
|
|---|
| 143 | #define OPpTRANS_GROWS 64
|
|---|
| 144 |
|
|---|
| 145 | /* Private for OP_REPEAT */
|
|---|
| 146 | #define OPpREPEAT_DOLIST 64 /* List replication. */
|
|---|
| 147 |
|
|---|
| 148 | /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
|
|---|
| 149 | #define OPpDEREF (32|64) /* autovivify: Want ref to something: */
|
|---|
| 150 | #define OPpDEREF_AV 32 /* Want ref to AV. */
|
|---|
| 151 | #define OPpDEREF_HV 64 /* Want ref to HV. */
|
|---|
| 152 | #define OPpDEREF_SV (32|64) /* Want ref to SV. */
|
|---|
| 153 | /* OP_ENTERSUB only */
|
|---|
| 154 | #define OPpENTERSUB_DB 16 /* Debug subroutine. */
|
|---|
| 155 | #define OPpENTERSUB_HASTARG 32 /* Called from OP tree. */
|
|---|
| 156 | #define OPpENTERSUB_NOMOD 64 /* Immune to mod() for :attrlist. */
|
|---|
| 157 | /* OP_RV2CV only */
|
|---|
| 158 | #define OPpENTERSUB_AMPER 8 /* Used & form to call. */
|
|---|
| 159 | #define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
|
|---|
| 160 | #define OPpENTERSUB_INARGS 4 /* Lval used as arg to a sub. */
|
|---|
| 161 | /* OP_GV only */
|
|---|
| 162 | #define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
|
|---|
| 163 | /* OP_?ELEM only */
|
|---|
| 164 | #define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
|
|---|
| 165 | /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
|
|---|
| 166 | #define OPpOUR_INTRO 16 /* Variable was in an our() */
|
|---|
| 167 | /* OP_RV2[AH]V, OP_PAD[AH]V, OP_[AH]ELEM */
|
|---|
| 168 | #define OPpMAYBE_LVSUB 8 /* We might be an lvalue to return */
|
|---|
| 169 | /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
|
|---|
| 170 |
|
|---|
| 171 | /* Private for OPs with TARGLEX */
|
|---|
| 172 | /* (lower bits may carry MAXARG) */
|
|---|
| 173 | #define OPpTARGET_MY 16 /* Target is PADMY. */
|
|---|
| 174 |
|
|---|
| 175 | /* Private for OP_ENTERITER and OP_ITER */
|
|---|
| 176 | #define OPpITER_REVERSED 4 /* for (reverse ...) */
|
|---|
| 177 |
|
|---|
| 178 | /* Private for OP_CONST */
|
|---|
| 179 | #define OPpCONST_SHORTCIRCUIT 4 /* eg the constant 5 in (5 || foo) */
|
|---|
| 180 | #define OPpCONST_STRICT 8 /* bearword subject to strict 'subs' */
|
|---|
| 181 | #define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
|
|---|
| 182 | #define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
|
|---|
| 183 | #define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
|
|---|
| 184 | #define OPpCONST_WARNING 128 /* Was a $^W translated to constant. */
|
|---|
| 185 |
|
|---|
| 186 | /* Private for OP_FLIP/FLOP */
|
|---|
| 187 | #define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
|
|---|
| 188 |
|
|---|
| 189 | /* Private for OP_LIST */
|
|---|
| 190 | #define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
|
|---|
| 191 |
|
|---|
| 192 | /* Private for OP_DELETE */
|
|---|
| 193 | #define OPpSLICE 64 /* Operating on a list of keys */
|
|---|
| 194 |
|
|---|
| 195 | /* Private for OP_EXISTS */
|
|---|
| 196 | #define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
|
|---|
| 197 |
|
|---|
| 198 | /* Private for OP_SORT */
|
|---|
| 199 | #define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
|
|---|
| 200 | #define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
|
|---|
| 201 | #define OPpSORT_REVERSE 4 /* Reversed sort */
|
|---|
| 202 | #define OPpSORT_INPLACE 8 /* sort in-place; eg @a = sort @a */
|
|---|
| 203 | #define OPpSORT_DESCEND 16 /* Descending sort */
|
|---|
| 204 | /* Private for OP_THREADSV */
|
|---|
| 205 | #define OPpDONE_SVREF 64 /* Been through newSVREF once */
|
|---|
| 206 |
|
|---|
| 207 | /* Private for OP_OPEN and OP_BACKTICK */
|
|---|
| 208 | #define OPpOPEN_IN_RAW 16 /* binmode(F,":raw") on input fh */
|
|---|
| 209 | #define OPpOPEN_IN_CRLF 32 /* binmode(F,":crlf") on input fh */
|
|---|
| 210 | #define OPpOPEN_OUT_RAW 64 /* binmode(F,":raw") on output fh */
|
|---|
| 211 | #define OPpOPEN_OUT_CRLF 128 /* binmode(F,":crlf") on output fh */
|
|---|
| 212 |
|
|---|
| 213 | /* Private for OP_EXIT, HUSH also for OP_DIE */
|
|---|
| 214 | #define OPpHUSH_VMSISH 64 /* hush DCL exit msg vmsish mode*/
|
|---|
| 215 | #define OPpEXIT_VMSISH 128 /* exit(0) vs. exit(1) vmsish mode*/
|
|---|
| 216 |
|
|---|
| 217 | /* Private of OP_FTXXX */
|
|---|
| 218 | #define OPpFT_ACCESS 2 /* use filetest 'access' */
|
|---|
| 219 | #define OP_IS_FILETEST_ACCESS(op) \
|
|---|
| 220 | (((op)->op_type) == OP_FTRREAD || \
|
|---|
| 221 | ((op)->op_type) == OP_FTRWRITE || \
|
|---|
| 222 | ((op)->op_type) == OP_FTREXEC || \
|
|---|
| 223 | ((op)->op_type) == OP_FTEREAD || \
|
|---|
|
|---|
