3 * Copyright (c) 1991-1999, Larry Wall
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.
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).
26 typedef U32 PADOFFSET;
27 #define NOT_IN_PAD ((PADOFFSET) -1)
35 #ifdef BASEOP_DEFINITION
36 #define BASEOP BASEOP_DEFINITION
41 OP* (CPERLscope(*op_ppaddr))(pTHX); \
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 : \
55 #define GIMME_V OP_GIMME(PL_op, block_gimme())
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 " " */
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
89 (PL_op->op_flags & OPf_WANT \
90 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
95 /* Private for lvalues */
96 #define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
98 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
99 #define OPpREFCOUNTED 64 /* op_targ carries a refcount */
101 /* Private for OP_AASSIGN */
102 #define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
104 /* Private for OP_SASSIGN */
105 #define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
107 /* Private for OP_MATCH and OP_SUBST{,CONST} */
108 #define OPpRUNTIME 64 /* Pattern coming in on the stack */
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
121 /* Private for OP_REPEAT */
122 #define OPpREPEAT_DOLIST 64 /* List replication. */
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. */
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. */
137 #define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
139 #define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
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) */
144 /* Private for OPs with TARGLEX */
145 /* (lower bits may carry MAXARG) */
146 #define OPpTARGET_MY 16 /* Target is PADMY. */
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. */
155 /* Private for OP_FLIP/FLOP */
156 #define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
158 /* Private for OP_LIST */
159 #define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
161 /* Private for OP_DELETE */
162 #define OPpSLICE 64 /* Operating on a list of keys */
164 /* Private for OP_EXISTS */
165 #define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
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 */
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 */
213 PMOP * op_pmnext; /* list of all scanpats */
214 REGEXP * op_pmregexp; /* compiled expression */
220 #define PMdf_USED 0x01 /* pm has been used once already */
221 #define PMdf_TAINTED 0x02 /* pm compiled from tainted pattern */
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 */
240 /* mask of bits stored in regexp->reganch */
241 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
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)
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)
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)
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)
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])
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)
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)
336 #define Nullop Null(OP*)
338 /* Lowest byte of PL_opargs */
340 #define OA_FOLDCONST 2
341 #define OA_RETSCALAR 4
343 #define OA_RETINTEGER 16
344 #define OA_OTHERINT 32
345 #define OA_DANGEROUS 64
347 #define OA_TARGLEX 256
349 /* The next 4 bits encode op class information */
352 #define OA_CLASS_MASK (15 << OCSHIFT)
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)
371 /* Remaining nybbles of PL_opargs */
378 #define OA_SCALARREF 7
379 #define OA_OPTIONAL 8