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