This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
usurp GVOP slot for new PADOP (one small step to making optree
[perl5.git] / op.h
1 /*    op.h
2  *
3  *    Copyright (c) 1991-1999, Larry Wall
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  *
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
26 typedef U32 PADOFFSET;
27 #define NOT_IN_PAD ((PADOFFSET) -1)
28
29 #ifdef DEBUGGING_OPS
30 #define OPCODE opcode
31 #else
32 #define OPCODE U16
33 #endif
34
35 #ifdef BASEOP_DEFINITION
36 #define BASEOP BASEOP_DEFINITION
37 #else
38 #define BASEOP                          \
39     OP*         op_next;                \
40     OP*         op_sibling;             \
41     OP*         (CPERLscope(*op_ppaddr))(pTHX);         \
42     PADOFFSET   op_targ;                \
43     OPCODE      op_type;                \
44     U16         op_seq;                 \
45     U8          op_flags;               \
46     U8          op_private;
47 #endif
48
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(PL_op, block_gimme())
56
57 /* Public flags */
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 */
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_(ENTER|LEAVE)EVAL, don't clear $@ */
81                                 /*  On OP_ENTERITER, loop var is per-thread */
82                                 /*  On pushre, re is /\s+/ imp. by split " " */
83
84 /* old names; don't use in new code, but don't break them, either */
85 #define OPf_LIST        OPf_WANT_LIST
86 #define OPf_KNOW        OPf_WANT
87 #define GIMME \
88           (PL_op->op_flags & OPf_WANT                                   \
89            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
90               ? G_ARRAY                                                 \
91               : G_SCALAR)                                               \
92            : dowantarray())
93
94 /* Private for lvalues */
95 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
96
97 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
98 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
99
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. */
105
106 /* Private for OP_MATCH and OP_SUBST{,CONST} */
107 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
108
109 /* Private for OP_TRANS */
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
119
120 /* Private for OP_REPEAT */
121 #define OPpREPEAT_DOLIST        64      /* List replication. */
122
123 /* Private for OP_RV2?V, OP_?ELEM */
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. */
128   /* OP_ENTERSUB only */
129 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
130 #define OPpENTERSUB_HASTARG     32      /* Called from OP tree. */
131   /* OP_RV2CV only */
132 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
133 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
134 #define OPpENTERSUB_INARGS      4       /* Lval used as arg to a sub. */
135   /* OP_GV only */
136 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
137   /* OP_?ELEM only */
138 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
139   /* for OP_RV2?V, lower bits carry hints */
140
141 /* Private for OPs with TARGLEX */
142   /* (lower bits may carry MAXARG) */
143 #define OPpTARGET_MY            16      /* Target is PADMY. */
144
145 /* Private for OP_CONST */
146 #define OPpCONST_STRICT         8       /* bearword subject to strict 'subs' */
147 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
148 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
149 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
150 #define OPpCONST_WARNING        128     /* Was a $^W translated to constant. */
151
152 /* Private for OP_FLIP/FLOP */
153 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
154
155 /* Private for OP_LIST */
156 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
157
158 /* Private for OP_DELETE */
159 #define OPpSLICE                64      /* Operating on a list of keys */
160
161 /* Private for OP_SORT, OP_PRTF, OP_SPRINTF, string cmp'n, and case changers */
162 #define OPpLOCALE               64      /* Use locale */
163
164 /* Private for OP_SORT */
165 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
166 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
167 #define OPpSORT_REVERSE         4       /* Descending sort */
168 /* Private for OP_THREADSV */
169 #define OPpDONE_SVREF           64      /* Been through newSVREF once */
170
171 struct op {
172     BASEOP
173 };
174
175 struct unop {
176     BASEOP
177     OP *        op_first;
178 };
179
180 struct binop {
181     BASEOP
182     OP *        op_first;
183     OP *        op_last;
184 };
185
186 struct logop {
187     BASEOP
188     OP *        op_first;
189     OP *        op_other;
190 };
191
192 struct listop {
193     BASEOP
194     OP *        op_first;
195     OP *        op_last;
196     U32         op_children;
197 };
198
199 struct pmop {
200     BASEOP
201     OP *        op_first;
202     OP *        op_last;
203     U32         op_children;
204     OP *        op_pmreplroot;
205     OP *        op_pmreplstart;
206     PMOP *      op_pmnext;              /* list of all scanpats */
207     REGEXP *    op_pmregexp;            /* compiled expression */
208     U16         op_pmflags;
209     U16         op_pmpermflags;
210     U8          op_pmdynflags;
211 };
212
213 #define PMdf_USED       0x01            /* pm has been used once already */
214 #define PMdf_TAINTED    0x02            /* pm compiled from tainted pattern */
215
216 #define PMf_RETAINT     0x0001          /* taint $1 etc. if target tainted */
217 #define PMf_ONCE        0x0002          /* use pattern only once per reset */
218 #define PMf_REVERSED    0x0004          /* Should be matched right->left */
219 #define PMf_MAYBE_CONST 0x0008          /* replacement contains variables */
220 #define PMf_SKIPWHITE   0x0010          /* skip leading whitespace for split */
221 #define PMf_WHITE       0x0020          /* pattern is \s+ */
222 #define PMf_CONST       0x0040          /* subst replacement is constant */
223 #define PMf_KEEP        0x0080          /* keep 1st runtime pattern forever */
224 #define PMf_GLOBAL      0x0100          /* pattern had a g modifier */
225 #define PMf_CONTINUE    0x0200          /* don't reset pos() if //g fails */
226 #define PMf_EVAL        0x0400          /* evaluating replacement as expr */
227 #define PMf_LOCALE      0x0800          /* use locale for character types */
228 #define PMf_MULTILINE   0x1000          /* assume multiple lines */
229 #define PMf_SINGLELINE  0x2000          /* assume single line */
230 #define PMf_FOLD        0x4000          /* case insensitivity */
231 #define PMf_EXTENDED    0x8000          /* chuck embedded whitespace */
232
233 /* mask of bits stored in regexp->reganch */
234 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
235
236 struct svop {
237     BASEOP
238     SV *        op_sv;
239 };
240
241 struct padop {
242     BASEOP
243     PADOFFSET   op_padix;
244 };
245
246 struct pvop {
247     BASEOP
248     char *      op_pv;
249 };
250
251 struct loop {
252     BASEOP
253     OP *        op_first;
254     OP *        op_last;
255     U32         op_children;
256     OP *        op_redoop;
257     OP *        op_nextop;
258     OP *        op_lastop;
259 };
260
261 #define cUNOP ((UNOP*)PL_op)
262 #define cBINOP ((BINOP*)PL_op)
263 #define cLISTOP ((LISTOP*)PL_op)
264 #define cLOGOP ((LOGOP*)PL_op)
265 #define cPMOP ((PMOP*)PL_op)
266 #define cSVOP ((SVOP*)PL_op)
267 #define cPADOP ((PADOP*)PL_op)
268 #define cPVOP ((PVOP*)PL_op)
269 #define cCOP ((COP*)PL_op)
270 #define cLOOP ((LOOP*)PL_op)
271
272 #define cUNOPo ((UNOP*)o)
273 #define cBINOPo ((BINOP*)o)
274 #define cLISTOPo ((LISTOP*)o)
275 #define cLOGOPo ((LOGOP*)o)
276 #define cPMOPo ((PMOP*)o)
277 #define cSVOPo ((SVOP*)o)
278 #define cPADOPo ((PADOP*)o)
279 #define cPVOPo ((PVOP*)o)
280 #define cCVOPo ((CVOP*)o)
281 #define cCOPo ((COP*)o)
282 #define cLOOPo ((LOOP*)o)
283
284 #define kUNOP ((UNOP*)kid)
285 #define kBINOP ((BINOP*)kid)
286 #define kLISTOP ((LISTOP*)kid)
287 #define kLOGOP ((LOGOP*)kid)
288 #define kPMOP ((PMOP*)kid)
289 #define kSVOP ((SVOP*)kid)
290 #define kPADOP ((PADOP*)kid)
291 #define kPVOP ((PVOP*)kid)
292 #define kCOP ((COP*)kid)
293 #define kLOOP ((LOOP*)kid)
294
295 #define Nullop Null(OP*)
296
297 /* Lowest byte of PL_opargs */
298 #define OA_MARK 1
299 #define OA_FOLDCONST 2
300 #define OA_RETSCALAR 4
301 #define OA_TARGET 8
302 #define OA_RETINTEGER 16
303 #define OA_OTHERINT 32
304 #define OA_DANGEROUS 64
305 #define OA_DEFGV 128
306 #define OA_TARGLEX 256
307
308 /* The next 4 bits encode op class information */
309 #define OCSHIFT 9
310
311 #define OA_CLASS_MASK (15 << OCSHIFT)
312
313 #define OA_BASEOP (0 << OCSHIFT)
314 #define OA_UNOP (1 << OCSHIFT)
315 #define OA_BINOP (2 << OCSHIFT)
316 #define OA_LOGOP (3 << OCSHIFT)
317 #define OA_LISTOP (4 << OCSHIFT)
318 #define OA_PMOP (5 << OCSHIFT)
319 #define OA_SVOP (6 << OCSHIFT)
320 #define OA_PADOP (7 << OCSHIFT)
321 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
322 #define OA_LOOP (9 << OCSHIFT)
323 #define OA_COP (10 << OCSHIFT)
324 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
325 #define OA_FILESTATOP (12 << OCSHIFT)
326 #define OA_LOOPEXOP (13 << OCSHIFT)
327
328 #define OASHIFT 13
329
330 /* Remaining nybbles of PL_opargs */
331 #define OA_SCALAR 1
332 #define OA_LIST 2
333 #define OA_AVREF 3
334 #define OA_HVREF 4
335 #define OA_CVREF 5
336 #define OA_FILEREF 6
337 #define OA_SCALARREF 7
338 #define OA_OPTIONAL 8
339