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