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