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 : \
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,
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.
69 #define GIMME_V OP_GIMME(PL_op, block_gimme())
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 " " */
99 /* old names; don't use in new code, but don't break them, either */
100 #define OPf_LIST OPf_WANT_LIST
101 #define OPf_KNOW OPf_WANT
104 (PL_op->op_flags & OPf_WANT \
105 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
110 /* Private for lvalues */
111 #define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
113 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
114 #define OPpREFCOUNTED 64 /* op_targ carries a refcount */
116 /* Private for OP_AASSIGN */
117 #define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
119 /* Private for OP_SASSIGN */
120 #define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
122 /* Private for OP_MATCH and OP_SUBST{,CONST} */
123 #define OPpRUNTIME 64 /* Pattern coming in on the stack */
125 /* Private for OP_TRANS */
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
136 /* Private for OP_REPEAT */
137 #define OPpREPEAT_DOLIST 64 /* List replication. */
139 /* Private for OP_RV2?V, OP_?ELEM */
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. */
144 /* OP_ENTERSUB only */
145 #define OPpENTERSUB_DB 16 /* Debug subroutine. */
146 #define OPpENTERSUB_HASTARG 32 /* Called from OP tree. */
148 #define OPpENTERSUB_AMPER 8 /* Used & form to call. */
149 #define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
150 #define OPpENTERSUB_INARGS 4 /* Lval used as arg to a sub. */
152 #define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
154 #define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
155 /* OP_RV2?V, OP_GVSV only */
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) */
159 /* Private for OPs with TARGLEX */
160 /* (lower bits may carry MAXARG) */
161 #define OPpTARGET_MY 16 /* Target is PADMY. */
163 /* Private for OP_CONST */
164 #define OPpCONST_STRICT 8 /* bearword subject to strict 'subs' */
165 #define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
166 #define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
167 #define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
168 #define OPpCONST_WARNING 128 /* Was a $^W translated to constant. */
170 /* Private for OP_FLIP/FLOP */
171 #define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
173 /* Private for OP_LIST */
174 #define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
176 /* Private for OP_DELETE */
177 #define OPpSLICE 64 /* Operating on a list of keys */
179 /* Private for OP_EXISTS */
180 #define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
182 /* Private for OP_SORT, OP_PRTF, OP_SPRINTF, OP_FTTEXT, OP_FTBINARY, */
183 /* string comparisons, and case changers. */
184 #define OPpLOCALE 64 /* Use locale */
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 */
190 /* Private for OP_THREADSV */
191 #define OPpDONE_SVREF 64 /* Been through newSVREF once */
228 PMOP * op_pmnext; /* list of all scanpats */
229 REGEXP * op_pmregexp; /* compiled expression */
235 #define PMdf_USED 0x01 /* pm has been used once already */
236 #define PMdf_TAINTED 0x02 /* pm compiled from tainted pattern */
238 #define PMf_RETAINT 0x0001 /* taint $1 etc. if target tainted */
239 #define PMf_ONCE 0x0002 /* use pattern only once per reset */
240 #define PMf_REVERSED 0x0004 /* Should be matched right->left */
241 #define PMf_MAYBE_CONST 0x0008 /* replacement contains variables */
242 #define PMf_SKIPWHITE 0x0010 /* skip leading whitespace for split */
243 #define PMf_WHITE 0x0020 /* pattern is \s+ */
244 #define PMf_CONST 0x0040 /* subst replacement is constant */
245 #define PMf_KEEP 0x0080 /* keep 1st runtime pattern forever */
246 #define PMf_GLOBAL 0x0100 /* pattern had a g modifier */
247 #define PMf_CONTINUE 0x0200 /* don't reset pos() if //g fails */
248 #define PMf_EVAL 0x0400 /* evaluating replacement as expr */
249 #define PMf_LOCALE 0x0800 /* use locale for character types */
250 #define PMf_MULTILINE 0x1000 /* assume multiple lines */
251 #define PMf_SINGLELINE 0x2000 /* assume single line */
252 #define PMf_FOLD 0x4000 /* case insensitivity */
253 #define PMf_EXTENDED 0x8000 /* chuck embedded whitespace */
255 /* mask of bits stored in regexp->reganch */
256 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
283 #define cUNOPx(o) ((UNOP*)o)
284 #define cBINOPx(o) ((BINOP*)o)
285 #define cLISTOPx(o) ((LISTOP*)o)
286 #define cLOGOPx(o) ((LOGOP*)o)
287 #define cPMOPx(o) ((PMOP*)o)
288 #define cSVOPx(o) ((SVOP*)o)
289 #define cPADOPx(o) ((PADOP*)o)
290 #define cPVOPx(o) ((PVOP*)o)
291 #define cCOPx(o) ((COP*)o)
292 #define cLOOPx(o) ((LOOP*)o)
294 #define cUNOP cUNOPx(PL_op)
295 #define cBINOP cBINOPx(PL_op)
296 #define cLISTOP cLISTOPx(PL_op)
297 #define cLOGOP cLOGOPx(PL_op)
298 #define cPMOP cPMOPx(PL_op)
299 #define cSVOP cSVOPx(PL_op)
300 #define cPADOP cPADOPx(PL_op)
301 #define cPVOP cPVOPx(PL_op)
302 #define cCOP cCOPx(PL_op)
303 #define cLOOP cLOOPx(PL_op)
305 #define cUNOPo cUNOPx(o)
306 #define cBINOPo cBINOPx(o)
307 #define cLISTOPo cLISTOPx(o)
308 #define cLOGOPo cLOGOPx(o)
309 #define cPMOPo cPMOPx(o)
310 #define cSVOPo cSVOPx(o)
311 #define cPADOPo cPADOPx(o)
312 #define cPVOPo cPVOPx(o)
313 #define cCOPo cCOPx(o)
314 #define cLOOPo cLOOPx(o)
316 #define kUNOP cUNOPx(kid)
317 #define kBINOP cBINOPx(kid)
318 #define kLISTOP cLISTOPx(kid)
319 #define kLOGOP cLOGOPx(kid)
320 #define kPMOP cPMOPx(kid)
321 #define kSVOP cSVOPx(kid)
322 #define kPADOP cPADOPx(kid)
323 #define kPVOP cPVOPx(kid)
324 #define kCOP cCOPx(kid)
325 #define kLOOP cLOOPx(kid)
329 # define cGVOPx_gv(o) ((GV*)PL_curpad[cPADOPx(o)->op_padix])
330 # define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && GvIN_PAD(v))
331 # define IS_PADCONST(v) (v && SvREADONLY(v))
332 # define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
333 ? cSVOPx(v)->op_sv : PL_curpad[(v)->op_targ])
334 # define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
335 ? &cSVOPx(v)->op_sv : &PL_curpad[(v)->op_targ])
337 # define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
338 # define IS_PADGV(v) FALSE
339 # define IS_PADCONST(v) FALSE
340 # define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
341 # define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
344 #define cGVOP_gv cGVOPx_gv(PL_op)
345 #define cGVOPo_gv cGVOPx_gv(o)
346 #define kGVOP_gv cGVOPx_gv(kid)
347 #define cSVOP_sv cSVOPx_sv(PL_op)
348 #define cSVOPo_sv cSVOPx_sv(o)
349 #define kSVOP_sv cSVOPx_sv(kid)
351 #define Nullop Null(OP*)
353 /* Lowest byte of PL_opargs */
355 #define OA_FOLDCONST 2
356 #define OA_RETSCALAR 4
358 #define OA_RETINTEGER 16
359 #define OA_OTHERINT 32
360 #define OA_DANGEROUS 64
362 #define OA_TARGLEX 256
364 /* The next 4 bits encode op class information */
367 #define OA_CLASS_MASK (15 << OCSHIFT)
369 #define OA_BASEOP (0 << OCSHIFT)
370 #define OA_UNOP (1 << OCSHIFT)
371 #define OA_BINOP (2 << OCSHIFT)
372 #define OA_LOGOP (3 << OCSHIFT)
373 #define OA_LISTOP (4 << OCSHIFT)
374 #define OA_PMOP (5 << OCSHIFT)
375 #define OA_SVOP (6 << OCSHIFT)
376 #define OA_PADOP (7 << OCSHIFT)
377 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
378 #define OA_LOOP (9 << OCSHIFT)
379 #define OA_COP (10 << OCSHIFT)
380 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
381 #define OA_FILESTATOP (12 << OCSHIFT)
382 #define OA_LOOPEXOP (13 << OCSHIFT)
386 /* Remaining nybbles of PL_opargs */
393 #define OA_SCALARREF 7
394 #define OA_OPTIONAL 8