This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re: PATCH _67 (Doc) perlop.pod
[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; \
76e3520e 38 OP* (CPERLscope(*op_ppaddr))_((ARGSproto)); \
79072805
LW
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 $@ */
54b9620d 77 /* On OP_ENTERITER, loop var is per-thread */
79072805 78
54310121
PP
79/* old names; don't use in new code, but don't break them, either */
80#define OPf_LIST 1
81#define OPf_KNOW 2
82#define GIMME \
83 (op->op_flags & OPf_KNOW ? op->op_flags & OPf_LIST : dowantarray())
84
a0d0e21e
LW
85/* Private for lvalues */
86#define OPpLVAL_INTRO 128 /* Lvalue must be localized */
87
88/* Private for OP_AASSIGN */
89#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
90
91/* Private for OP_SASSIGN */
92#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
79072805 93
c90c0ff4
PP
94/* Private for OP_MATCH and OP_SUBST{,CONST} */
95#define OPpRUNTIME 64 /* Pattern coming in on the stack */
96
79072805 97/* Private for OP_TRANS */
5d06d08e 98#define OPpTRANS_COUNTONLY 8
a0d0e21e
LW
99#define OPpTRANS_SQUASH 16
100#define OPpTRANS_DELETE 32
101#define OPpTRANS_COMPLEMENT 64
79072805
LW
102
103/* Private for OP_REPEAT */
a0d0e21e 104#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805 105
a0d0e21e 106/* Private for OP_ENTERSUB, OP_RV2?V, OP_?ELEM */
5f05dabc
PP
107#define OPpDEREF (32|64) /* Want ref to something: */
108#define OPpDEREF_AV 32 /* Want ref to AV. */
109#define OPpDEREF_HV 64 /* Want ref to HV. */
110#define OPpDEREF_SV (32|64) /* Want ref to SV. */
68dc0745
PP
111 /* OP_ENTERSUB only */
112#define OPpENTERSUB_DB 16 /* Debug subroutine. */
113#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
114 /* OP_?ELEM only */
115#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
116 /* for OP_RV2?V, lower bits carry hints */
79072805
LW
117
118/* Private for OP_CONST */
748a9306
LW
119#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
120#define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
a0d0e21e 121#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
79072805
LW
122
123/* Private for OP_FLIP/FLOP */
a0d0e21e 124#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805 125
ed6116ce 126/* Private for OP_LIST */
a0d0e21e
LW
127#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
128
5f05dabc 129/* Private for OP_DELETE */
54310121 130#define OPpSLICE 64 /* Operating on a list of keys */
5f05dabc 131
bbce6d69
PP
132/* Private for OP_SORT, OP_PRTF, OP_SPRINTF, string cmp'n, and case changers */
133#define OPpLOCALE 64 /* Use locale */
134
224a4551
MB
135/* Private for OP_THREADSV */
136#define OPpDONE_SVREF 64 /* Been through newSVREF once */
554b3eca 137
79072805
LW
138struct op {
139 BASEOP
140};
141
142struct unop {
143 BASEOP
144 OP * op_first;
145};
146
147struct binop {
148 BASEOP
149 OP * op_first;
150 OP * op_last;
151};
152
153struct logop {
154 BASEOP
155 OP * op_first;
156 OP * op_other;
157};
158
159struct condop {
160 BASEOP
161 OP * op_first;
162 OP * op_true;
163 OP * op_false;
164};
165
166struct listop {
167 BASEOP
168 OP * op_first;
169 OP * op_last;
170 U32 op_children;
171};
172
173struct pmop {
174 BASEOP
175 OP * op_first;
176 OP * op_last;
177 U32 op_children;
178 OP * op_pmreplroot;
179 OP * op_pmreplstart;
180 PMOP * op_pmnext; /* list of all scanpats */
181 REGEXP * op_pmregexp; /* compiled expression */
a0d0e21e 182 U16 op_pmflags;
4633a7c4 183 U16 op_pmpermflags;
48c036b1 184 U8 op_pmdynflags;
79072805 185};
a0d0e21e 186
48c036b1
GS
187#define PMdf_USED 0x01 /* pm has been used once already */
188
189#define PMf_TAINTMEM 0x0001 /* taint $1 etc. if target tainted */
a0d0e21e 190#define PMf_ONCE 0x0002 /* use pattern only once per reset */
c277df42 191#define PMf_REVERSED 0x0004 /* Should be matched right->left */
ce862d02 192#define PMf_MAYBE_CONST 0x0008 /* replacement contains variables */
a0d0e21e
LW
193#define PMf_SKIPWHITE 0x0010 /* skip leading whitespace for split */
194#define PMf_FOLD 0x0020 /* case insensitivity */
195#define PMf_CONST 0x0040 /* subst replacement is constant */
196#define PMf_KEEP 0x0080 /* keep 1st runtime pattern forever */
197#define PMf_GLOBAL 0x0100 /* pattern had a g modifier */
c90c0ff4 198#define PMf_CONTINUE 0x0200 /* don't reset pos() if //g fails */
a0d0e21e
LW
199#define PMf_EVAL 0x0400 /* evaluating replacement as expr */
200#define PMf_WHITE 0x0800 /* pattern is \s+ */
201#define PMf_MULTILINE 0x1000 /* assume multiple lines */
202#define PMf_SINGLELINE 0x2000 /* assume single line */
bbce6d69 203#define PMf_LOCALE 0x4000 /* use locale for character types */
a0d0e21e 204#define PMf_EXTENDED 0x8000 /* chuck embedded whitespace */
79072805
LW
205
206struct svop {
207 BASEOP
208 SV * op_sv;
209};
210
211struct gvop {
212 BASEOP
213 GV * op_gv;
214};
215
216struct pvop {
217 BASEOP
218 char * op_pv;
219};
220
79072805
LW
221struct loop {
222 BASEOP
223 OP * op_first;
224 OP * op_last;
225 U32 op_children;
226 OP * op_redoop;
227 OP * op_nextop;
228 OP * op_lastop;
229};
230
231#define cUNOP ((UNOP*)op)
232#define cBINOP ((BINOP*)op)
233#define cLISTOP ((LISTOP*)op)
234#define cLOGOP ((LOGOP*)op)
235#define cCONDOP ((CONDOP*)op)
236#define cPMOP ((PMOP*)op)
237#define cSVOP ((SVOP*)op)
238#define cGVOP ((GVOP*)op)
239#define cPVOP ((PVOP*)op)
79072805
LW
240#define cCOP ((COP*)op)
241#define cLOOP ((LOOP*)op)
242
11343788
MB
243#define cUNOPo ((UNOP*)o)
244#define cBINOPo ((BINOP*)o)
245#define cLISTOPo ((LISTOP*)o)
246#define cLOGOPo ((LOGOP*)o)
247#define cCONDOPo ((CONDOP*)o)
248#define cPMOPo ((PMOP*)o)
249#define cSVOPo ((SVOP*)o)
250#define cGVOPo ((GVOP*)o)
251#define cPVOPo ((PVOP*)o)
252#define cCVOPo ((CVOP*)o)
253#define cCOPo ((COP*)o)
254#define cLOOPo ((LOOP*)o)
255
79072805
LW
256#define kUNOP ((UNOP*)kid)
257#define kBINOP ((BINOP*)kid)
258#define kLISTOP ((LISTOP*)kid)
259#define kLOGOP ((LOGOP*)kid)
260#define kCONDOP ((CONDOP*)kid)
261#define kPMOP ((PMOP*)kid)
262#define kSVOP ((SVOP*)kid)
263#define kGVOP ((GVOP*)kid)
264#define kPVOP ((PVOP*)kid)
79072805
LW
265#define kCOP ((COP*)kid)
266#define kLOOP ((LOOP*)kid)
267
268#define Nullop Null(OP*)
269
a0d0e21e
LW
270/* Lowest byte of opargs */
271#define OA_MARK 1
272#define OA_FOLDCONST 2
273#define OA_RETSCALAR 4
274#define OA_TARGET 8
275#define OA_RETINTEGER 16
276#define OA_OTHERINT 32
277#define OA_DANGEROUS 64
278#define OA_DEFGV 128
279
db173bac 280/* The next 4 bits encode op class information */
7e0e7afe
MB
281#define OA_CLASS_MASK (15 << 8)
282
db173bac
MB
283#define OA_BASEOP (0 << 8)
284#define OA_UNOP (1 << 8)
285#define OA_BINOP (2 << 8)
286#define OA_LOGOP (3 << 8)
287#define OA_CONDOP (4 << 8)
288#define OA_LISTOP (5 << 8)
289#define OA_PMOP (6 << 8)
290#define OA_SVOP (7 << 8)
291#define OA_GVOP (8 << 8)
292#define OA_PVOP (9 << 8)
293#define OA_LOOP (10 << 8)
294#define OA_COP (11 << 8)
295#define OA_BASEOP_OR_UNOP (12 << 8)
296#define OA_FILESTATOP (13 << 8)
297#define OA_LOOPEXOP (14 << 8)
298
299#define OASHIFT 12
a0d0e21e
LW
300
301/* Remaining nybbles of opargs */
302#define OA_SCALAR 1
303#define OA_LIST 2
304#define OA_AVREF 3
305#define OA_HVREF 4
306#define OA_CVREF 5
307#define OA_FILEREF 6
308#define OA_SCALARREF 7
309#define OA_OPTIONAL 8
310