perl 5.003_06: pod/perltrap.pod
[perl.git] / op.h
1 /*    op.h
2  *
3  *    Copyright (c) 1991-1994, 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  */
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
26 typedef U32 PADOFFSET;
27
28 #ifdef DEBUGGING_OPS
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;                 \
41     U8          op_flags;               \
42     U8          op_private;
43
44 #define GIMME (op->op_flags & OPf_KNOW ? op->op_flags & OPf_LIST : dowantarray())
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. */
51                                 /*  (Or block needs explicit scope entry.) */
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. */
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 OP_LEAVE, don't restore curpm. */
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_ENTERSUB || OP_NULL, saw a "do". */
66                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
67
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. */
76
77 /* Private for OP_TRANS */
78 #define OPpTRANS_SQUASH         16
79 #define OPpTRANS_DELETE         32
80 #define OPpTRANS_COMPLEMENT     64
81
82 /* Private for OP_REPEAT */
83 #define OPpREPEAT_DOLIST        64      /* List replication. */
84
85 /* Private for OP_ENTERSUB, OP_RV2?V, OP_?ELEM */
86   /* (lower bits carry hints) */
87 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
88 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
89 #define OPpDEREF_AV             32      /* Want ref to AV. */
90 #define OPpDEREF_HV             64      /* Want ref to HV. */
91
92 /* Private for OP_CONST */
93 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
94 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
95 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
96
97 /* Private for OP_FLIP/FLOP */
98 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
99
100 /* Private for OP_LIST */
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. */
105
106 struct op {
107     BASEOP
108 };
109
110 struct unop {
111     BASEOP
112     OP *        op_first;
113 };
114
115 struct binop {
116     BASEOP
117     OP *        op_first;
118     OP *        op_last;
119 };
120
121 struct logop {
122     BASEOP
123     OP *        op_first;
124     OP *        op_other;
125 };
126
127 struct condop {
128     BASEOP
129     OP *        op_first;
130     OP *        op_true;
131     OP *        op_false;
132 };
133
134 struct listop {
135     BASEOP
136     OP *        op_first;
137     OP *        op_last;
138     U32         op_children;
139 };
140
141 struct pmop {
142     BASEOP
143     OP *        op_first;
144     OP *        op_last;
145     U32         op_children;
146     OP *        op_pmreplroot;
147     OP *        op_pmreplstart;
148     PMOP *      op_pmnext;              /* list of all scanpats */
149     REGEXP *    op_pmregexp;            /* compiled expression */
150     SV *        op_pmshort;             /* for a fast bypass of execute() */
151     U16         op_pmflags;
152     U16         op_pmpermflags;
153     char        op_pmslen;
154 };
155
156 #define PMf_USED        0x0001          /* pm has been used once already */
157 #define PMf_ONCE        0x0002          /* use pattern only once per reset */
158 #define PMf_SCANFIRST   0x0004          /* initial constant not anchored */
159 #define PMf_ALL         0x0008          /* initial constant is whole pat */
160 #define PMf_SKIPWHITE   0x0010          /* skip leading whitespace for split */
161 #define PMf_FOLD        0x0020          /* case insensitivity */
162 #define PMf_CONST       0x0040          /* subst replacement is constant */
163 #define PMf_KEEP        0x0080          /* keep 1st runtime pattern forever */
164 #define PMf_GLOBAL      0x0100          /* pattern had a g modifier */
165 #define PMf_RUNTIME     0x0200          /* pattern coming in on the stack */
166 #define PMf_EVAL        0x0400          /* evaluating replacement as expr */
167 #define PMf_WHITE       0x0800          /* pattern is \s+ */
168 #define PMf_MULTILINE   0x1000          /* assume multiple lines */
169 #define PMf_SINGLELINE  0x2000          /* assume single line */
170 #define PMf_UNUSED      0x4000          /* (unused) */
171 #define PMf_EXTENDED    0x8000          /* chuck embedded whitespace */
172
173 struct svop {
174     BASEOP
175     SV *        op_sv;
176 };
177
178 struct gvop {
179     BASEOP
180     GV *        op_gv;
181 };
182
183 struct pvop {
184     BASEOP
185     char *      op_pv;
186 };
187
188 struct loop {
189     BASEOP
190     OP *        op_first;
191     OP *        op_last;
192     U32         op_children;
193     OP *        op_redoop;
194     OP *        op_nextop;
195     OP *        op_lastop;
196 };
197
198 #define cUNOP ((UNOP*)op)
199 #define cBINOP ((BINOP*)op)
200 #define cLISTOP ((LISTOP*)op)
201 #define cLOGOP ((LOGOP*)op)
202 #define cCONDOP ((CONDOP*)op)
203 #define cPMOP ((PMOP*)op)
204 #define cSVOP ((SVOP*)op)
205 #define cGVOP ((GVOP*)op)
206 #define cPVOP ((PVOP*)op)
207 #define cCOP ((COP*)op)
208 #define cLOOP ((LOOP*)op)
209
210 #define kUNOP ((UNOP*)kid)
211 #define kBINOP ((BINOP*)kid)
212 #define kLISTOP ((LISTOP*)kid)
213 #define kLOGOP ((LOGOP*)kid)
214 #define kCONDOP ((CONDOP*)kid)
215 #define kPMOP ((PMOP*)kid)
216 #define kSVOP ((SVOP*)kid)
217 #define kGVOP ((GVOP*)kid)
218 #define kPVOP ((PVOP*)kid)
219 #define kCOP ((COP*)kid)
220 #define kLOOP ((LOOP*)kid)
221
222 #define Nullop Null(OP*)
223
224 /* Lowest byte of opargs */
225 #define OA_MARK 1
226 #define OA_FOLDCONST 2
227 #define OA_RETSCALAR 4
228 #define OA_TARGET 8
229 #define OA_RETINTEGER 16
230 #define OA_OTHERINT 32
231 #define OA_DANGEROUS 64
232 #define OA_DEFGV 128
233
234 #define OASHIFT 8
235
236 /* Remaining nybbles of opargs */
237 #define OA_SCALAR 1
238 #define OA_LIST 2
239 #define OA_AVREF 3
240 #define OA_HVREF 4
241 #define OA_CVREF 5
242 #define OA_FILEREF 6
243 #define OA_SCALARREF 7
244 #define OA_OPTIONAL 8
245