This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[dummy merge]
[perl5.git] / op.h
CommitLineData
a0d0e21e 1/* op.h
79072805 2 *
9607fc9c 3 * Copyright (c) 1991-1997, 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 26typedef U32 PADOFFSET;
79072805 27
4633a7c4 28#ifdef DEBUGGING_OPS
79072805
LW
29#define OPCODE opcode
30#else
31#define OPCODE U16
32#endif
33
34#define BASEOP \
35 OP* op_next; \
36 OP* op_sibling; \
37 OP* (*op_ppaddr)(); \
38 PADOFFSET op_targ; \
39 OPCODE op_type; \
40 U16 op_seq; \
a0d0e21e
LW
41 U8 op_flags; \
42 U8 op_private;
79072805 43
e50aee73 44#define GIMME (op->op_flags & OPf_KNOW ? op->op_flags & OPf_LIST : dowantarray())
79072805
LW
45
46/* Public flags */
47#define OPf_LIST 1 /* Do operator in list context. */
48#define OPf_KNOW 2 /* Context is known. */
49#define OPf_KIDS 4 /* There is a firstborn child. */
50#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2 51 /* (Or block needs explicit scope entry.) */
a0d0e21e
LW
52#define OPf_REF 16 /* Certified reference. */
53 /* (Return container, not containee). */
54#define OPf_MOD 32 /* Will modify (lvalue). */
55#define OPf_STACKED 64 /* Some arg is arriving on the stack. */
79072805
LW
56#define OPf_SPECIAL 128 /* Do something weird for this op: */
57 /* On local LVAL, don't init local value. */
58 /* On OP_SORT, subroutine is inlined. */
59 /* On OP_NOT, inversion was implicit. */
a0d0e21e 60 /* On OP_LEAVE, don't restore curpm. */
79072805
LW
61 /* On truncate, we truncate filehandle */
62 /* On control verbs, we saw no label */
63 /* On flipflop, we saw ... instead of .. */
64 /* On UNOPs, saw bare parens, e.g. eof(). */
a0d0e21e 65 /* On OP_ENTERSUB || OP_NULL, saw a "do". */
f2ec2afd 66 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
79072805 67
a0d0e21e
LW
68/* Private for lvalues */
69#define OPpLVAL_INTRO 128 /* Lvalue must be localized */
70
71/* Private for OP_AASSIGN */
72#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
73
74/* Private for OP_SASSIGN */
75#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
79072805
LW
76
77/* Private for OP_TRANS */
a0d0e21e
LW
78#define OPpTRANS_SQUASH 16
79#define OPpTRANS_DELETE 32
80#define OPpTRANS_COMPLEMENT 64
79072805
LW
81
82/* Private for OP_REPEAT */
a0d0e21e 83#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805 84
a0d0e21e 85/* Private for OP_ENTERSUB, OP_RV2?V, OP_?ELEM */
5f05dabc
PP
86#define OPpDEREF (32|64) /* Want ref to something: */
87#define OPpDEREF_AV 32 /* Want ref to AV. */
88#define OPpDEREF_HV 64 /* Want ref to HV. */
89#define OPpDEREF_SV (32|64) /* Want ref to SV. */
68dc0745
PP
90 /* OP_ENTERSUB only */
91#define OPpENTERSUB_DB 16 /* Debug subroutine. */
92#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
93 /* OP_?ELEM only */
94#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
95 /* for OP_RV2?V, lower bits carry hints */
79072805
LW
96
97/* Private for OP_CONST */
748a9306
LW
98#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
99#define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
a0d0e21e 100#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
79072805
LW
101
102/* Private for OP_FLIP/FLOP */
a0d0e21e 103#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805 104
ed6116ce 105/* Private for OP_LIST */
a0d0e21e
LW
106#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
107
5f05dabc 108/* Private for OP_LEAVE, OP_DELETE, and friends(?) */
a0d0e21e 109#define OPpLEAVE_VOID 64 /* No need to copy out values. */
ed6116ce 110
5f05dabc
PP
111/* Private for OP_DELETE */
112#define OPpSLICE 32 /* Operating on a list of keys */
113
bbce6d69
PP
114/* Private for OP_SORT, OP_PRTF, OP_SPRINTF, string cmp'n, and case changers */
115#define OPpLOCALE 64 /* Use locale */
116
79072805
LW
117struct op {
118 BASEOP
119};
120
121struct unop {
122 BASEOP
123 OP * op_first;
124};
125
126struct binop {
127 BASEOP
128 OP * op_first;
129 OP * op_last;
130};
131
132struct logop {
133 BASEOP
134 OP * op_first;
135 OP * op_other;
136};
137
138struct condop {
139 BASEOP
140 OP * op_first;
141 OP * op_true;
142 OP * op_false;
143};
144
145struct listop {
146 BASEOP
147 OP * op_first;
148 OP * op_last;
149 U32 op_children;
150};
151
152struct pmop {
153 BASEOP
154 OP * op_first;
155 OP * op_last;
156 U32 op_children;
157 OP * op_pmreplroot;
158 OP * op_pmreplstart;
159 PMOP * op_pmnext; /* list of all scanpats */
160 REGEXP * op_pmregexp; /* compiled expression */
161 SV * op_pmshort; /* for a fast bypass of execute() */
a0d0e21e 162 U16 op_pmflags;
4633a7c4 163 U16 op_pmpermflags;
79072805
LW
164 char op_pmslen;
165};
a0d0e21e
LW
166
167#define PMf_USED 0x0001 /* pm has been used once already */
168#define PMf_ONCE 0x0002 /* use pattern only once per reset */
169#define PMf_SCANFIRST 0x0004 /* initial constant not anchored */
170#define PMf_ALL 0x0008 /* initial constant is whole pat */
171#define PMf_SKIPWHITE 0x0010 /* skip leading whitespace for split */
172#define PMf_FOLD 0x0020 /* case insensitivity */
173#define PMf_CONST 0x0040 /* subst replacement is constant */
174#define PMf_KEEP 0x0080 /* keep 1st runtime pattern forever */
175#define PMf_GLOBAL 0x0100 /* pattern had a g modifier */
176#define PMf_RUNTIME 0x0200 /* pattern coming in on the stack */
177#define PMf_EVAL 0x0400 /* evaluating replacement as expr */
178#define PMf_WHITE 0x0800 /* pattern is \s+ */
179#define PMf_MULTILINE 0x1000 /* assume multiple lines */
180#define PMf_SINGLELINE 0x2000 /* assume single line */
bbce6d69 181#define PMf_LOCALE 0x4000 /* use locale for character types */
a0d0e21e 182#define PMf_EXTENDED 0x8000 /* chuck embedded whitespace */
79072805
LW
183
184struct svop {
185 BASEOP
186 SV * op_sv;
187};
188
189struct gvop {
190 BASEOP
191 GV * op_gv;
192};
193
194struct pvop {
195 BASEOP
196 char * op_pv;
197};
198
79072805
LW
199struct loop {
200 BASEOP
201 OP * op_first;
202 OP * op_last;
203 U32 op_children;
204 OP * op_redoop;
205 OP * op_nextop;
206 OP * op_lastop;
207};
208
209#define cUNOP ((UNOP*)op)
210#define cBINOP ((BINOP*)op)
211#define cLISTOP ((LISTOP*)op)
212#define cLOGOP ((LOGOP*)op)
213#define cCONDOP ((CONDOP*)op)
214#define cPMOP ((PMOP*)op)
215#define cSVOP ((SVOP*)op)
216#define cGVOP ((GVOP*)op)
217#define cPVOP ((PVOP*)op)
79072805
LW
218#define cCOP ((COP*)op)
219#define cLOOP ((LOOP*)op)
220
221#define kUNOP ((UNOP*)kid)
222#define kBINOP ((BINOP*)kid)
223#define kLISTOP ((LISTOP*)kid)
224#define kLOGOP ((LOGOP*)kid)
225#define kCONDOP ((CONDOP*)kid)
226#define kPMOP ((PMOP*)kid)
227#define kSVOP ((SVOP*)kid)
228#define kGVOP ((GVOP*)kid)
229#define kPVOP ((PVOP*)kid)
79072805
LW
230#define kCOP ((COP*)kid)
231#define kLOOP ((LOOP*)kid)
232
233#define Nullop Null(OP*)
234
a0d0e21e
LW
235/* Lowest byte of opargs */
236#define OA_MARK 1
237#define OA_FOLDCONST 2
238#define OA_RETSCALAR 4
239#define OA_TARGET 8
240#define OA_RETINTEGER 16
241#define OA_OTHERINT 32
242#define OA_DANGEROUS 64
243#define OA_DEFGV 128
244
245#define OASHIFT 8
246
247/* Remaining nybbles of opargs */
248#define OA_SCALAR 1
249#define OA_LIST 2
250#define OA_AVREF 3
251#define OA_HVREF 4
252#define OA_CVREF 5
253#define OA_FILEREF 6
254#define OA_SCALARREF 7
255#define OA_OPTIONAL 8
256