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