Commit | Line | Data |
a0d0e21e |
1 | /* op.h |
79072805 |
2 | * |
9607fc9c |
3 | * Copyright (c) 1991-1997, Larry Wall |
79072805 |
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 | * |
79072805 |
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 | |
4633a7c4 |
26 | typedef U32 PADOFFSET; |
11343788 |
27 | #define NOT_IN_PAD ((PADOFFSET) -1) |
79072805 |
28 | |
4633a7c4 |
29 | #ifdef DEBUGGING_OPS |
79072805 |
30 | #define OPCODE opcode |
31 | #else |
32 | #define OPCODE U16 |
33 | #endif |
34 | |
0f4eea8f |
35 | #ifdef BASEOP_DEFINITION |
36 | #define BASEOP BASEOP_DEFINITION |
37 | #else |
79072805 |
38 | #define BASEOP \ |
39 | OP* op_next; \ |
40 | OP* op_sibling; \ |
76e3520e |
41 | OP* (CPERLscope(*op_ppaddr))_((ARGSproto)); \ |
79072805 |
42 | PADOFFSET op_targ; \ |
43 | OPCODE op_type; \ |
44 | U16 op_seq; \ |
a0d0e21e |
45 | U8 op_flags; \ |
46 | U8 op_private; |
0f4eea8f |
47 | #endif |
79072805 |
48 | |
54310121 |
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(op, block_gimme()) |
79072805 |
56 | |
57 | /* Public flags */ |
54310121 |
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 */ |
79072805 |
63 | #define OPf_KIDS 4 /* There is a firstborn child. */ |
64 | #define OPf_PARENS 8 /* This operator was parenthesized. */ |
463ee0b2 |
65 | /* (Or block needs explicit scope entry.) */ |
a0d0e21e |
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. */ |
79072805 |
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. */ |
a0d0e21e |
74 | /* On OP_LEAVE, don't restore curpm. */ |
79072805 |
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(). */ |
a0d0e21e |
79 | /* On OP_ENTERSUB || OP_NULL, saw a "do". */ |
f2ec2afd |
80 | /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */ |
54b9620d |
81 | /* On OP_ENTERITER, loop var is per-thread */ |
79072805 |
82 | |
54310121 |
83 | /* old names; don't use in new code, but don't break them, either */ |
84 | #define OPf_LIST 1 |
85 | #define OPf_KNOW 2 |
86 | #define GIMME \ |
87 | (op->op_flags & OPf_KNOW ? op->op_flags & OPf_LIST : dowantarray()) |
88 | |
a0d0e21e |
89 | /* Private for lvalues */ |
90 | #define OPpLVAL_INTRO 128 /* Lvalue must be localized */ |
91 | |
92 | /* Private for OP_AASSIGN */ |
93 | #define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */ |
94 | |
95 | /* Private for OP_SASSIGN */ |
96 | #define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */ |
79072805 |
97 | |
c90c0ff4 |
98 | /* Private for OP_MATCH and OP_SUBST{,CONST} */ |
99 | #define OPpRUNTIME 64 /* Pattern coming in on the stack */ |
100 | |
79072805 |
101 | /* Private for OP_TRANS */ |
5d06d08e |
102 | #define OPpTRANS_COUNTONLY 8 |
a0d0e21e |
103 | #define OPpTRANS_SQUASH 16 |
104 | #define OPpTRANS_DELETE 32 |
105 | #define OPpTRANS_COMPLEMENT 64 |
79072805 |
106 | |
107 | /* Private for OP_REPEAT */ |
a0d0e21e |
108 | #define OPpREPEAT_DOLIST 64 /* List replication. */ |
79072805 |
109 | |
a0d0e21e |
110 | /* Private for OP_ENTERSUB, OP_RV2?V, OP_?ELEM */ |
5f05dabc |
111 | #define OPpDEREF (32|64) /* Want ref to something: */ |
112 | #define OPpDEREF_AV 32 /* Want ref to AV. */ |
113 | #define OPpDEREF_HV 64 /* Want ref to HV. */ |
114 | #define OPpDEREF_SV (32|64) /* Want ref to SV. */ |
68dc0745 |
115 | /* OP_ENTERSUB only */ |
116 | #define OPpENTERSUB_DB 16 /* Debug subroutine. */ |
117 | #define OPpENTERSUB_AMPER 8 /* Used & form to call. */ |
118 | /* OP_?ELEM only */ |
119 | #define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */ |
120 | /* for OP_RV2?V, lower bits carry hints */ |
79072805 |
121 | |
122 | /* Private for OP_CONST */ |
748a9306 |
123 | #define OPpCONST_ENTERED 16 /* Has been entered as symbol. */ |
124 | #define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */ |
a0d0e21e |
125 | #define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */ |
79072805 |
126 | |
127 | /* Private for OP_FLIP/FLOP */ |
a0d0e21e |
128 | #define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */ |
79072805 |
129 | |
ed6116ce |
130 | /* Private for OP_LIST */ |
a0d0e21e |
131 | #define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */ |
132 | |
5f05dabc |
133 | /* Private for OP_DELETE */ |
54310121 |
134 | #define OPpSLICE 64 /* Operating on a list of keys */ |
5f05dabc |
135 | |
bbce6d69 |
136 | /* Private for OP_SORT, OP_PRTF, OP_SPRINTF, string cmp'n, and case changers */ |
137 | #define OPpLOCALE 64 /* Use locale */ |
138 | |
224a4551 |
139 | /* Private for OP_THREADSV */ |
140 | #define OPpDONE_SVREF 64 /* Been through newSVREF once */ |
554b3eca |
141 | |
79072805 |
142 | struct op { |
143 | BASEOP |
144 | }; |
145 | |
146 | struct unop { |
147 | BASEOP |
148 | OP * op_first; |
149 | }; |
150 | |
151 | struct binop { |
152 | BASEOP |
153 | OP * op_first; |
154 | OP * op_last; |
155 | }; |
156 | |
157 | struct logop { |
158 | BASEOP |
159 | OP * op_first; |
160 | OP * op_other; |
161 | }; |
162 | |
163 | struct condop { |
164 | BASEOP |
165 | OP * op_first; |
166 | OP * op_true; |
167 | OP * op_false; |
168 | }; |
169 | |
170 | struct listop { |
171 | BASEOP |
172 | OP * op_first; |
173 | OP * op_last; |
174 | U32 op_children; |
175 | }; |
176 | |
177 | struct pmop { |
178 | BASEOP |
179 | OP * op_first; |
180 | OP * op_last; |
181 | U32 op_children; |
182 | OP * op_pmreplroot; |
183 | OP * op_pmreplstart; |
184 | PMOP * op_pmnext; /* list of all scanpats */ |
185 | REGEXP * op_pmregexp; /* compiled expression */ |
a0d0e21e |
186 | U16 op_pmflags; |
4633a7c4 |
187 | U16 op_pmpermflags; |
48c036b1 |
188 | U8 op_pmdynflags; |
79072805 |
189 | }; |
a0d0e21e |
190 | |
48c036b1 |
191 | #define PMdf_USED 0x01 /* pm has been used once already */ |
b3eb6a9b |
192 | #define PMdf_TAINTED 0x02 /* pm compiled from tainted pattern */ |
48c036b1 |
193 | |
b3eb6a9b |
194 | #define PMf_RETAINT 0x0001 /* taint $1 etc. if target tainted */ |
a0d0e21e |
195 | #define PMf_ONCE 0x0002 /* use pattern only once per reset */ |
c277df42 |
196 | #define PMf_REVERSED 0x0004 /* Should be matched right->left */ |
ce862d02 |
197 | #define PMf_MAYBE_CONST 0x0008 /* replacement contains variables */ |
a0d0e21e |
198 | #define PMf_SKIPWHITE 0x0010 /* skip leading whitespace for split */ |
8782bef2 |
199 | #define PMf_WHITE 0x0020 /* pattern is \s+ */ |
a0d0e21e |
200 | #define PMf_CONST 0x0040 /* subst replacement is constant */ |
201 | #define PMf_KEEP 0x0080 /* keep 1st runtime pattern forever */ |
202 | #define PMf_GLOBAL 0x0100 /* pattern had a g modifier */ |
c90c0ff4 |
203 | #define PMf_CONTINUE 0x0200 /* don't reset pos() if //g fails */ |
a0d0e21e |
204 | #define PMf_EVAL 0x0400 /* evaluating replacement as expr */ |
8782bef2 |
205 | #define PMf_LOCALE 0x0800 /* use locale for character types */ |
a0d0e21e |
206 | #define PMf_MULTILINE 0x1000 /* assume multiple lines */ |
207 | #define PMf_SINGLELINE 0x2000 /* assume single line */ |
8782bef2 |
208 | #define PMf_FOLD 0x4000 /* case insensitivity */ |
a0d0e21e |
209 | #define PMf_EXTENDED 0x8000 /* chuck embedded whitespace */ |
79072805 |
210 | |
8782bef2 |
211 | /* mask of bits stored in regexp->reganch */ |
212 | #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED) |
213 | |
79072805 |
214 | struct svop { |
215 | BASEOP |
216 | SV * op_sv; |
217 | }; |
218 | |
219 | struct gvop { |
220 | BASEOP |
221 | GV * op_gv; |
222 | }; |
223 | |
224 | struct pvop { |
225 | BASEOP |
226 | char * op_pv; |
227 | }; |
228 | |
79072805 |
229 | struct loop { |
230 | BASEOP |
231 | OP * op_first; |
232 | OP * op_last; |
233 | U32 op_children; |
234 | OP * op_redoop; |
235 | OP * op_nextop; |
236 | OP * op_lastop; |
237 | }; |
238 | |
239 | #define cUNOP ((UNOP*)op) |
240 | #define cBINOP ((BINOP*)op) |
241 | #define cLISTOP ((LISTOP*)op) |
242 | #define cLOGOP ((LOGOP*)op) |
243 | #define cCONDOP ((CONDOP*)op) |
244 | #define cPMOP ((PMOP*)op) |
245 | #define cSVOP ((SVOP*)op) |
246 | #define cGVOP ((GVOP*)op) |
247 | #define cPVOP ((PVOP*)op) |
79072805 |
248 | #define cCOP ((COP*)op) |
249 | #define cLOOP ((LOOP*)op) |
250 | |
11343788 |
251 | #define cUNOPo ((UNOP*)o) |
252 | #define cBINOPo ((BINOP*)o) |
253 | #define cLISTOPo ((LISTOP*)o) |
254 | #define cLOGOPo ((LOGOP*)o) |
255 | #define cCONDOPo ((CONDOP*)o) |
256 | #define cPMOPo ((PMOP*)o) |
257 | #define cSVOPo ((SVOP*)o) |
258 | #define cGVOPo ((GVOP*)o) |
259 | #define cPVOPo ((PVOP*)o) |
260 | #define cCVOPo ((CVOP*)o) |
261 | #define cCOPo ((COP*)o) |
262 | #define cLOOPo ((LOOP*)o) |
263 | |
79072805 |
264 | #define kUNOP ((UNOP*)kid) |
265 | #define kBINOP ((BINOP*)kid) |
266 | #define kLISTOP ((LISTOP*)kid) |
267 | #define kLOGOP ((LOGOP*)kid) |
268 | #define kCONDOP ((CONDOP*)kid) |
269 | #define kPMOP ((PMOP*)kid) |
270 | #define kSVOP ((SVOP*)kid) |
271 | #define kGVOP ((GVOP*)kid) |
272 | #define kPVOP ((PVOP*)kid) |
79072805 |
273 | #define kCOP ((COP*)kid) |
274 | #define kLOOP ((LOOP*)kid) |
275 | |
276 | #define Nullop Null(OP*) |
277 | |
a0d0e21e |
278 | /* Lowest byte of opargs */ |
279 | #define OA_MARK 1 |
280 | #define OA_FOLDCONST 2 |
281 | #define OA_RETSCALAR 4 |
282 | #define OA_TARGET 8 |
283 | #define OA_RETINTEGER 16 |
284 | #define OA_OTHERINT 32 |
285 | #define OA_DANGEROUS 64 |
286 | #define OA_DEFGV 128 |
287 | |
db173bac |
288 | /* The next 4 bits encode op class information */ |
7e0e7afe |
289 | #define OA_CLASS_MASK (15 << 8) |
290 | |
db173bac |
291 | #define OA_BASEOP (0 << 8) |
292 | #define OA_UNOP (1 << 8) |
293 | #define OA_BINOP (2 << 8) |
294 | #define OA_LOGOP (3 << 8) |
295 | #define OA_CONDOP (4 << 8) |
296 | #define OA_LISTOP (5 << 8) |
297 | #define OA_PMOP (6 << 8) |
298 | #define OA_SVOP (7 << 8) |
299 | #define OA_GVOP (8 << 8) |
300 | #define OA_PVOP (9 << 8) |
301 | #define OA_LOOP (10 << 8) |
302 | #define OA_COP (11 << 8) |
303 | #define OA_BASEOP_OR_UNOP (12 << 8) |
304 | #define OA_FILESTATOP (13 << 8) |
305 | #define OA_LOOPEXOP (14 << 8) |
306 | |
307 | #define OASHIFT 12 |
a0d0e21e |
308 | |
309 | /* Remaining nybbles of opargs */ |
310 | #define OA_SCALAR 1 |
311 | #define OA_LIST 2 |
312 | #define OA_AVREF 3 |
313 | #define OA_HVREF 4 |
314 | #define OA_CVREF 5 |
315 | #define OA_FILEREF 6 |
316 | #define OA_SCALARREF 7 |
317 | #define OA_OPTIONAL 8 |
318 | |