This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pod/perlipc.pod patch
[perl5.git] / op.h
CommitLineData
a0d0e21e 1/* op.h
79072805 2 *
a0d0e21e 3 * Copyright (c) 1991-1994, 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 */
85e6fe83 86 /* (lower bits carry hints) */
c07a80fd
PP
87#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
88#define OPpENTERSUB_DB 16 /* Debug subroutine. */
a0d0e21e
LW
89#define OPpDEREF_AV 32 /* Want ref to AV. */
90#define OPpDEREF_HV 64 /* Want ref to HV. */
79072805
LW
91
92/* Private for OP_CONST */
748a9306
LW
93#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
94#define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
a0d0e21e 95#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
79072805
LW
96
97/* Private for OP_FLIP/FLOP */
a0d0e21e 98#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805 99
ed6116ce 100/* Private for OP_LIST */
a0d0e21e
LW
101#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
102
103/* Private for OP_LEAVE and friends */
104#define OPpLEAVE_VOID 64 /* No need to copy out values. */
ed6116ce 105
bbce6d69
PP
106/* Private for OP_SORT, OP_PRTF, OP_SPRINTF, string cmp'n, and case changers */
107#define OPpLOCALE 64 /* Use locale */
108
79072805
LW
109struct op {
110 BASEOP
111};
112
113struct unop {
114 BASEOP
115 OP * op_first;
116};
117
118struct binop {
119 BASEOP
120 OP * op_first;
121 OP * op_last;
122};
123
124struct logop {
125 BASEOP
126 OP * op_first;
127 OP * op_other;
128};
129
130struct condop {
131 BASEOP
132 OP * op_first;
133 OP * op_true;
134 OP * op_false;
135};
136
137struct listop {
138 BASEOP
139 OP * op_first;
140 OP * op_last;
141 U32 op_children;
142};
143
144struct pmop {
145 BASEOP
146 OP * op_first;
147 OP * op_last;
148 U32 op_children;
149 OP * op_pmreplroot;
150 OP * op_pmreplstart;
151 PMOP * op_pmnext; /* list of all scanpats */
152 REGEXP * op_pmregexp; /* compiled expression */
153 SV * op_pmshort; /* for a fast bypass of execute() */
a0d0e21e 154 U16 op_pmflags;
4633a7c4 155 U16 op_pmpermflags;
79072805
LW
156 char op_pmslen;
157};
a0d0e21e
LW
158
159#define PMf_USED 0x0001 /* pm has been used once already */
160#define PMf_ONCE 0x0002 /* use pattern only once per reset */
161#define PMf_SCANFIRST 0x0004 /* initial constant not anchored */
162#define PMf_ALL 0x0008 /* initial constant is whole pat */
163#define PMf_SKIPWHITE 0x0010 /* skip leading whitespace for split */
164#define PMf_FOLD 0x0020 /* case insensitivity */
165#define PMf_CONST 0x0040 /* subst replacement is constant */
166#define PMf_KEEP 0x0080 /* keep 1st runtime pattern forever */
167#define PMf_GLOBAL 0x0100 /* pattern had a g modifier */
168#define PMf_RUNTIME 0x0200 /* pattern coming in on the stack */
169#define PMf_EVAL 0x0400 /* evaluating replacement as expr */
170#define PMf_WHITE 0x0800 /* pattern is \s+ */
171#define PMf_MULTILINE 0x1000 /* assume multiple lines */
172#define PMf_SINGLELINE 0x2000 /* assume single line */
bbce6d69 173#define PMf_LOCALE 0x4000 /* use locale for character types */
a0d0e21e 174#define PMf_EXTENDED 0x8000 /* chuck embedded whitespace */
79072805
LW
175
176struct svop {
177 BASEOP
178 SV * op_sv;
179};
180
181struct gvop {
182 BASEOP
183 GV * op_gv;
184};
185
186struct pvop {
187 BASEOP
188 char * op_pv;
189};
190
79072805
LW
191struct loop {
192 BASEOP
193 OP * op_first;
194 OP * op_last;
195 U32 op_children;
196 OP * op_redoop;
197 OP * op_nextop;
198 OP * op_lastop;
199};
200
201#define cUNOP ((UNOP*)op)
202#define cBINOP ((BINOP*)op)
203#define cLISTOP ((LISTOP*)op)
204#define cLOGOP ((LOGOP*)op)
205#define cCONDOP ((CONDOP*)op)
206#define cPMOP ((PMOP*)op)
207#define cSVOP ((SVOP*)op)
208#define cGVOP ((GVOP*)op)
209#define cPVOP ((PVOP*)op)
79072805
LW
210#define cCOP ((COP*)op)
211#define cLOOP ((LOOP*)op)
212
213#define kUNOP ((UNOP*)kid)
214#define kBINOP ((BINOP*)kid)
215#define kLISTOP ((LISTOP*)kid)
216#define kLOGOP ((LOGOP*)kid)
217#define kCONDOP ((CONDOP*)kid)
218#define kPMOP ((PMOP*)kid)
219#define kSVOP ((SVOP*)kid)
220#define kGVOP ((GVOP*)kid)
221#define kPVOP ((PVOP*)kid)
79072805
LW
222#define kCOP ((COP*)kid)
223#define kLOOP ((LOOP*)kid)
224
225#define Nullop Null(OP*)
226
a0d0e21e
LW
227/* Lowest byte of opargs */
228#define OA_MARK 1
229#define OA_FOLDCONST 2
230#define OA_RETSCALAR 4
231#define OA_TARGET 8
232#define OA_RETINTEGER 16
233#define OA_OTHERINT 32
234#define OA_DANGEROUS 64
235#define OA_DEFGV 128
236
237#define OASHIFT 8
238
239/* Remaining nybbles of opargs */
240#define OA_SCALAR 1
241#define OA_LIST 2
242#define OA_AVREF 3
243#define OA_HVREF 4
244#define OA_CVREF 5
245#define OA_FILEREF 6
246#define OA_SCALARREF 7
247#define OA_OPTIONAL 8
248