This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perl 5.0 alpha 5
[perl5.git] / op.h
CommitLineData
79072805
LW
1/* $RCSfile: arg.h,v $$Revision: 4.1 $$Date: 92/08/07 17:18:16 $
2 *
3 * Copyright (c) 1991, 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 * $Log: arg.h,v $
9 */
10
11/*
12 * The fields of BASEOP are:
13 * op_next Pointer to next ppcode to execute after this one.
14 * (Top level pre-grafted op points to first op,
15 * but this is replaced when op is grafted in, when
16 * this op will point to the real next op, and the new
17 * parent takes over role of remembering starting op.)
18 * op_ppaddr Pointer to current ppcode's function.
19 * op_type The type of the operation.
20 * op_flags Flags common to all operations. See OPf_* below.
21 * op_private Flags peculiar to a particular operation (BUT,
22 * by default, set to the number of children until
23 * the operation is privatized by a check routine,
24 * which may or may not check number of children).
25 */
26
27typedef U16 PADOFFSET;
28
29#ifdef DEBUGGING
30#define OPCODE opcode
31#else
32#define OPCODE U16
33#endif
34
35#define BASEOP \
36 OP* op_next; \
37 OP* op_sibling; \
38 OP* (*op_ppaddr)(); \
39 PADOFFSET op_targ; \
40 OPCODE op_type; \
41 U16 op_seq; \
42 char op_flags; \
43 char op_private;
44
45#define GIMME (op->op_flags & OPf_KNOW ? op->op_flags & OPf_LIST : getgimme(op))
46
47/* Public flags */
48#define OPf_LIST 1 /* Do operator in list context. */
49#define OPf_KNOW 2 /* Context is known. */
50#define OPf_KIDS 4 /* There is a firstborn child. */
51#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2 52 /* (Or block needs explicit scope entry.) */
79072805
LW
53#define OPf_STACKED 16 /* Some arg is arriving on the stack. */
54#define OPf_LVAL 32 /* Certified reference (lvalue). */
93a17b20 55#define OPf_INTRO 64 /* Lvalue must be localized */
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. */
60 /* On file tests, we fstat filehandle */
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(). */
65 /* On OP_ENTERSUBR || OP_NULL, saw a "do". */
66
67/* Private for OP_ASSIGN */
68#define OPpASSIGN_COMMON 1 /* Left & right have syms in common. */
69
70/* Private for OP_TRANS */
71#define OPpTRANS_SQUASH 1
72#define OPpTRANS_DELETE 2
73#define OPpTRANS_COMPLEMENT 4
74
75/* Private for OP_REPEAT */
76#define OPpREPEAT_DOLIST 1 /* List replication. */
77
78/* Private for OP_SUBR */
79#define OPpSUBR_DB 1 /* Debug subroutine. */
80
81/* Private for OP_CONST */
82#define OPpCONST_BARE 1 /* Was a bare word (filehandle?). */
83
84/* Private for OP_FLIP/FLOP */
85#define OPpFLIP_LINENUM 1 /* Range arg potentially a line num. */
86
ed6116ce
LW
87/* Private for OP_LIST */
88#define OPpLIST_GUESSED 1 /* Guessed that pushmark was needed. */
89
79072805
LW
90struct op {
91 BASEOP
92};
93
94struct unop {
95 BASEOP
96 OP * op_first;
97};
98
99struct binop {
100 BASEOP
101 OP * op_first;
102 OP * op_last;
103};
104
105struct logop {
106 BASEOP
107 OP * op_first;
108 OP * op_other;
109};
110
111struct condop {
112 BASEOP
113 OP * op_first;
114 OP * op_true;
115 OP * op_false;
116};
117
118struct listop {
119 BASEOP
120 OP * op_first;
121 OP * op_last;
122 U32 op_children;
123};
124
125struct pmop {
126 BASEOP
127 OP * op_first;
128 OP * op_last;
129 U32 op_children;
130 OP * op_pmreplroot;
131 OP * op_pmreplstart;
132 PMOP * op_pmnext; /* list of all scanpats */
133 REGEXP * op_pmregexp; /* compiled expression */
134 SV * op_pmshort; /* for a fast bypass of execute() */
135 short op_pmflags;
136 char op_pmslen;
137};
138#define PMf_USED 1 /* pm has been used once already */
139#define PMf_ONCE 2 /* use pattern only once per reset */
140#define PMf_SCANFIRST 4 /* initial constant not anchored */
141#define PMf_ALL 8 /* initial constant is whole pat */
142#define PMf_SKIPWHITE 16 /* skip leading whitespace for split */
143#define PMf_FOLD 32 /* case insensitivity */
144#define PMf_CONST 64 /* subst replacement is constant */
145#define PMf_KEEP 128 /* keep 1st runtime pattern forever */
146#define PMf_GLOBAL 256 /* pattern had a g modifier */
147#define PMf_RUNTIME 512 /* pattern coming in on the stack */
148#define PMf_EVAL 1024 /* evaluating replacement as expr */
149
150struct svop {
151 BASEOP
152 SV * op_sv;
153};
154
155struct gvop {
156 BASEOP
157 GV * op_gv;
158};
159
160struct pvop {
161 BASEOP
162 char * op_pv;
163};
164
165struct cvop {
166 BASEOP
167 CV * op_cv;
168 OP * op_cont;
169};
170
171struct loop {
172 BASEOP
173 OP * op_first;
174 OP * op_last;
175 U32 op_children;
176 OP * op_redoop;
177 OP * op_nextop;
178 OP * op_lastop;
179};
180
181#define cUNOP ((UNOP*)op)
182#define cBINOP ((BINOP*)op)
183#define cLISTOP ((LISTOP*)op)
184#define cLOGOP ((LOGOP*)op)
185#define cCONDOP ((CONDOP*)op)
186#define cPMOP ((PMOP*)op)
187#define cSVOP ((SVOP*)op)
188#define cGVOP ((GVOP*)op)
189#define cPVOP ((PVOP*)op)
190#define cCVOP ((CVOP*)op)
191#define cCOP ((COP*)op)
192#define cLOOP ((LOOP*)op)
193
194#define kUNOP ((UNOP*)kid)
195#define kBINOP ((BINOP*)kid)
196#define kLISTOP ((LISTOP*)kid)
197#define kLOGOP ((LOGOP*)kid)
198#define kCONDOP ((CONDOP*)kid)
199#define kPMOP ((PMOP*)kid)
200#define kSVOP ((SVOP*)kid)
201#define kGVOP ((GVOP*)kid)
202#define kPVOP ((PVOP*)kid)
203#define kCVOP ((CVOP*)kid)
204#define kCOP ((COP*)kid)
205#define kLOOP ((LOOP*)kid)
206
207#define Nullop Null(OP*)
208