This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
c6938c9a2365f93208e74f15efbccee6a0beebd5
[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_AASSIGN */
98 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
99
100 /* Private for OP_SASSIGN */
101 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
102
103 /* Private for OP_MATCH and OP_SUBST{,CONST} */
104 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
105
106 /* Private for OP_TRANS */
107 #define OPpTRANS_FROM_UTF       1
108 #define OPpTRANS_TO_UTF         2
109 #define OPpTRANS_IDENTICAL      4
110         /* When CU or UC, means straight latin-1 to utf-8 or vice versa */
111         /* Otherwise, IDENTICAL means the right side is the same as the left */
112 #define OPpTRANS_SQUASH         8
113 #define OPpTRANS_DELETE         16
114 #define OPpTRANS_COMPLEMENT     32
115 #define OPpTRANS_GROWS          64
116
117 /* Private for OP_REPEAT */
118 #define OPpREPEAT_DOLIST        64      /* List replication. */
119
120 /* Private for OP_RV2?V, OP_?ELEM */
121 #define OPpDEREF                (32|64) /* Want ref to something: */
122 #define OPpDEREF_AV             32      /*   Want ref to AV. */
123 #define OPpDEREF_HV             64      /*   Want ref to HV. */
124 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
125   /* OP_ENTERSUB only */
126 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
127 #define OPpENTERSUB_HASTARG     32      /* Called from OP tree. */
128   /* OP_RV2CV only */
129 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
130 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
131 #define OPpENTERSUB_INARGS      4       /* Lval used as arg to a sub. */
132   /* OP_GV only */
133 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
134   /* OP_?ELEM only */
135 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
136   /* for OP_RV2?V, lower bits carry hints */
137
138 /* Private for OPs with TARGLEX */
139   /* (lower bits may carry MAXARG) */
140 #define OPpTARGET_MY            16      /* Target is PADMY. */
141
142 /* Private for OP_CONST */
143 #define OPpCONST_STRICT         8       /* bearword subject to strict 'subs' */
144 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
145 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
146 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
147 #define OPpCONST_WARNING        128     /* Was a $^W translated to constant. */
148
149 /* Private for OP_FLIP/FLOP */
150 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
151
152 /* Private for OP_LIST */
153 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
154
155 /* Private for OP_DELETE */
156 #define OPpSLICE                64      /* Operating on a list of keys */
157
158 /* Private for OP_SORT, OP_PRTF, OP_SPRINTF, string cmp'n, and case changers */
159 #define OPpLOCALE               64      /* Use locale */
160
161 /* Private for OP_SORT */
162 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
163 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
164 #define OPpSORT_REVERSE         4       /* Descending sort */
165 /* Private for OP_THREADSV */
166 #define OPpDONE_SVREF           64      /* Been through newSVREF once */
167
168 struct op {
169     BASEOP
170 };
171
172 struct unop {
173     BASEOP
174     OP *        op_first;
175 };
176
177 struct binop {
178     BASEOP
179     OP *        op_first;
180     OP *        op_last;
181 };
182
183 struct logop {
184     BASEOP
185     OP *        op_first;
186     OP *        op_other;
187 };
188
189 struct listop {
190     BASEOP
191     OP *        op_first;
192     OP *        op_last;
193     U32         op_children;
194 };
195
196 struct pmop {
197     BASEOP
198     OP *        op_first;
199     OP *        op_last;
200     U32         op_children;
201     OP *        op_pmreplroot;
202     OP *        op_pmreplstart;
203     PMOP *      op_pmnext;              /* list of all scanpats */
204     REGEXP *    op_pmregexp;            /* compiled expression */
205     U16         op_pmflags;
206     U16         op_pmpermflags;
207     U8          op_pmdynflags;
208 };
209
210 #define PMdf_USED       0x01            /* pm has been used once already */
211 #define PMdf_TAINTED    0x02            /* pm compiled from tainted pattern */
212
213 #define PMf_RETAINT     0x0001          /* taint $1 etc. if target tainted */
214 #define PMf_ONCE        0x0002          /* use pattern only once per reset */
215 #define PMf_REVERSED    0x0004          /* Should be matched right->left */
216 #define PMf_MAYBE_CONST 0x0008          /* replacement contains variables */
217 #define PMf_SKIPWHITE   0x0010          /* skip leading whitespace for split */
218 #define PMf_WHITE       0x0020          /* pattern is \s+ */
219 #define PMf_CONST       0x0040          /* subst replacement is constant */
220 #define PMf_KEEP        0x0080          /* keep 1st runtime pattern forever */
221 #define PMf_GLOBAL      0x0100          /* pattern had a g modifier */
222 #define PMf_CONTINUE    0x0200          /* don't reset pos() if //g fails */
223 #define PMf_EVAL        0x0400          /* evaluating replacement as expr */
224 #define PMf_LOCALE      0x0800          /* use locale for character types */
225 #define PMf_MULTILINE   0x1000          /* assume multiple lines */
226 #define PMf_SINGLELINE  0x2000          /* assume single line */
227 #define PMf_FOLD        0x4000          /* case insensitivity */
228 #define PMf_EXTENDED    0x8000          /* chuck embedded whitespace */
229
230 /* mask of bits stored in regexp->reganch */
231 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
232
233 struct svop {
234     BASEOP
235     SV *        op_sv;
236 };
237
238 struct gvop {
239     BASEOP
240     GV *        op_gv;
241 };
242
243 struct pvop {
244     BASEOP
245     char *      op_pv;
246 };
247
248 struct loop {
249     BASEOP
250     OP *        op_first;
251     OP *        op_last;
252     U32         op_children;
253     OP *        op_redoop;
254     OP *        op_nextop;
255     OP *        op_lastop;
256 };
257
258 #define cUNOP ((UNOP*)PL_op)
259 #define cBINOP ((BINOP*)PL_op)
260 #define cLISTOP ((LISTOP*)PL_op)
261 #define cLOGOP ((LOGOP*)PL_op)
262 #define cPMOP ((PMOP*)PL_op)
263 #define cSVOP ((SVOP*)PL_op)
264 #define cGVOP ((GVOP*)PL_op)
265 #define cPVOP ((PVOP*)PL_op)
266 #define cCOP ((COP*)PL_op)
267 #define cLOOP ((LOOP*)PL_op)
268
269 #define cUNOPo ((UNOP*)o)
270 #define cBINOPo ((BINOP*)o)
271 #define cLISTOPo ((LISTOP*)o)
272 #define cLOGOPo ((LOGOP*)o)
273 #define cPMOPo ((PMOP*)o)
274 #define cSVOPo ((SVOP*)o)
275 #define cGVOPo ((GVOP*)o)
276 #define cPVOPo ((PVOP*)o)
277 #define cCVOPo ((CVOP*)o)
278 #define cCOPo ((COP*)o)
279 #define cLOOPo ((LOOP*)o)
280
281 #define kUNOP ((UNOP*)kid)
282 #define kBINOP ((BINOP*)kid)
283 #define kLISTOP ((LISTOP*)kid)
284 #define kLOGOP ((LOGOP*)kid)
285 #define kPMOP ((PMOP*)kid)
286 #define kSVOP ((SVOP*)kid)
287 #define kGVOP ((GVOP*)kid)
288 #define kPVOP ((PVOP*)kid)
289 #define kCOP ((COP*)kid)
290 #define kLOOP ((LOOP*)kid)
291
292 #define Nullop Null(OP*)
293
294 /* Lowest byte of PL_opargs */
295 #define OA_MARK 1
296 #define OA_FOLDCONST 2
297 #define OA_RETSCALAR 4
298 #define OA_TARGET 8
299 #define OA_RETINTEGER 16
300 #define OA_OTHERINT 32
301 #define OA_DANGEROUS 64
302 #define OA_DEFGV 128
303 #define OA_TARGLEX 256
304
305 /* The next 4 bits encode op class information */
306 #define OCSHIFT 9
307
308 #define OA_CLASS_MASK (15 << OCSHIFT)
309
310 #define OA_BASEOP (0 << OCSHIFT)
311 #define OA_UNOP (1 << OCSHIFT)
312 #define OA_BINOP (2 << OCSHIFT)
313 #define OA_LOGOP (3 << OCSHIFT)
314 #define OA_LISTOP (4 << OCSHIFT)
315 #define OA_PMOP (5 << OCSHIFT)
316 #define OA_SVOP (6 << OCSHIFT)
317 #define OA_GVOP (7 << OCSHIFT)
318 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
319 #define OA_LOOP (9 << OCSHIFT)
320 #define OA_COP (10 << OCSHIFT)
321 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
322 #define OA_FILESTATOP (12 << OCSHIFT)
323 #define OA_LOOPEXOP (13 << OCSHIFT)
324
325 #define OASHIFT 13
326
327 /* Remaining nybbles of PL_opargs */
328 #define OA_SCALAR 1
329 #define OA_LIST 2
330 #define OA_AVREF 3
331 #define OA_HVREF 4
332 #define OA_CVREF 5
333 #define OA_FILEREF 6
334 #define OA_SCALARREF 7
335 #define OA_OPTIONAL 8
336