1 /*
2 +----------------------------------------------------------------------+
3 | Zend Engine |
4 +----------------------------------------------------------------------+
5 | Copyright (c) Zend Technologies Ltd. (http://www.zend.com) |
6 +----------------------------------------------------------------------+
7 | This source file is subject to version 2.00 of the Zend license, |
8 | that is bundled with this package in the file LICENSE, and is |
9 | available through the world-wide-web at the following url: |
10 | http://www.zend.com/license/2_00.txt. |
11 | If you did not receive a copy of the Zend license and are unable to |
12 | obtain it through the world-wide-web, please send a note to |
13 | license@zend.com so we can mail you a copy immediately. |
14 +----------------------------------------------------------------------+
15 | Authors: Bob Weinand <bwoebi@php.net> |
16 | Dmitry Stogov <dmitry@php.net> |
17 | Nikita Popov <nikic@php.net> |
18 +----------------------------------------------------------------------+
19 */
20
21 #ifndef ZEND_AST_H
22 #define ZEND_AST_H
23
24 #include "zend.h"
25
26 #ifndef ZEND_AST_SPEC
27 # define ZEND_AST_SPEC 1
28 #endif
29
30 #define ZEND_AST_SPECIAL_SHIFT 6
31 #define ZEND_AST_IS_LIST_SHIFT 7
32 #define ZEND_AST_NUM_CHILDREN_SHIFT 8
33
34 enum _zend_ast_kind {
35 /* special nodes */
36 ZEND_AST_ZVAL = 1 << ZEND_AST_SPECIAL_SHIFT,
37 ZEND_AST_CONSTANT,
38 ZEND_AST_ZNODE,
39
40 /* declaration nodes */
41 ZEND_AST_FUNC_DECL,
42 ZEND_AST_CLOSURE,
43 ZEND_AST_METHOD,
44 ZEND_AST_CLASS,
45 ZEND_AST_ARROW_FUNC,
46
47 /* list nodes */
48 ZEND_AST_ARG_LIST = 1 << ZEND_AST_IS_LIST_SHIFT,
49 ZEND_AST_ARRAY,
50 ZEND_AST_ENCAPS_LIST,
51 ZEND_AST_EXPR_LIST,
52 ZEND_AST_STMT_LIST,
53 ZEND_AST_IF,
54 ZEND_AST_SWITCH_LIST,
55 ZEND_AST_CATCH_LIST,
56 ZEND_AST_PARAM_LIST,
57 ZEND_AST_CLOSURE_USES,
58 ZEND_AST_PROP_DECL,
59 ZEND_AST_CONST_DECL,
60 ZEND_AST_CLASS_CONST_DECL,
61 ZEND_AST_NAME_LIST,
62 ZEND_AST_TRAIT_ADAPTATIONS,
63 ZEND_AST_USE,
64 ZEND_AST_TYPE_UNION,
65 ZEND_AST_ATTRIBUTE_LIST,
66 ZEND_AST_ATTRIBUTE_GROUP,
67 ZEND_AST_MATCH_ARM_LIST,
68
69 /* 0 child nodes */
70 ZEND_AST_MAGIC_CONST = 0 << ZEND_AST_NUM_CHILDREN_SHIFT,
71 ZEND_AST_TYPE,
72 ZEND_AST_CONSTANT_CLASS,
73
74 /* 1 child node */
75 ZEND_AST_VAR = 1 << ZEND_AST_NUM_CHILDREN_SHIFT,
76 ZEND_AST_CONST,
77 ZEND_AST_UNPACK,
78 ZEND_AST_UNARY_PLUS,
79 ZEND_AST_UNARY_MINUS,
80 ZEND_AST_CAST,
81 ZEND_AST_EMPTY,
82 ZEND_AST_ISSET,
83 ZEND_AST_SILENCE,
84 ZEND_AST_SHELL_EXEC,
85 ZEND_AST_CLONE,
86 ZEND_AST_EXIT,
87 ZEND_AST_PRINT,
88 ZEND_AST_INCLUDE_OR_EVAL,
89 ZEND_AST_UNARY_OP,
90 ZEND_AST_PRE_INC,
91 ZEND_AST_PRE_DEC,
92 ZEND_AST_POST_INC,
93 ZEND_AST_POST_DEC,
94 ZEND_AST_YIELD_FROM,
95 ZEND_AST_CLASS_NAME,
96
97 ZEND_AST_GLOBAL,
98 ZEND_AST_UNSET,
99 ZEND_AST_RETURN,
100 ZEND_AST_LABEL,
101 ZEND_AST_REF,
102 ZEND_AST_HALT_COMPILER,
103 ZEND_AST_ECHO,
104 ZEND_AST_THROW,
105 ZEND_AST_GOTO,
106 ZEND_AST_BREAK,
107 ZEND_AST_CONTINUE,
108
109 /* 2 child nodes */
110 ZEND_AST_DIM = 2 << ZEND_AST_NUM_CHILDREN_SHIFT,
111 ZEND_AST_PROP,
112 ZEND_AST_NULLSAFE_PROP,
113 ZEND_AST_STATIC_PROP,
114 ZEND_AST_CALL,
115 ZEND_AST_CLASS_CONST,
116 ZEND_AST_ASSIGN,
117 ZEND_AST_ASSIGN_REF,
118 ZEND_AST_ASSIGN_OP,
119 ZEND_AST_BINARY_OP,
120 ZEND_AST_GREATER,
121 ZEND_AST_GREATER_EQUAL,
122 ZEND_AST_AND,
123 ZEND_AST_OR,
124 ZEND_AST_ARRAY_ELEM,
125 ZEND_AST_NEW,
126 ZEND_AST_INSTANCEOF,
127 ZEND_AST_YIELD,
128 ZEND_AST_COALESCE,
129 ZEND_AST_ASSIGN_COALESCE,
130
131 ZEND_AST_STATIC,
132 ZEND_AST_WHILE,
133 ZEND_AST_DO_WHILE,
134 ZEND_AST_IF_ELEM,
135 ZEND_AST_SWITCH,
136 ZEND_AST_SWITCH_CASE,
137 ZEND_AST_DECLARE,
138 ZEND_AST_USE_TRAIT,
139 ZEND_AST_TRAIT_PRECEDENCE,
140 ZEND_AST_METHOD_REFERENCE,
141 ZEND_AST_NAMESPACE,
142 ZEND_AST_USE_ELEM,
143 ZEND_AST_TRAIT_ALIAS,
144 ZEND_AST_GROUP_USE,
145 ZEND_AST_CLASS_CONST_GROUP,
146 ZEND_AST_ATTRIBUTE,
147 ZEND_AST_MATCH,
148 ZEND_AST_MATCH_ARM,
149 ZEND_AST_NAMED_ARG,
150
151 /* 3 child nodes */
152 ZEND_AST_METHOD_CALL = 3 << ZEND_AST_NUM_CHILDREN_SHIFT,
153 ZEND_AST_NULLSAFE_METHOD_CALL,
154 ZEND_AST_STATIC_CALL,
155 ZEND_AST_CONDITIONAL,
156
157 ZEND_AST_TRY,
158 ZEND_AST_CATCH,
159 ZEND_AST_PROP_GROUP,
160 ZEND_AST_PROP_ELEM,
161 ZEND_AST_CONST_ELEM,
162
163 /* 4 child nodes */
164 ZEND_AST_FOR = 4 << ZEND_AST_NUM_CHILDREN_SHIFT,
165 ZEND_AST_FOREACH,
166
167 /* 5 child nodes */
168 ZEND_AST_PARAM = 5 << ZEND_AST_NUM_CHILDREN_SHIFT,
169 };
170
171 typedef uint16_t zend_ast_kind;
172 typedef uint16_t zend_ast_attr;
173
174 struct _zend_ast {
175 zend_ast_kind kind; /* Type of the node (ZEND_AST_* enum constant) */
176 zend_ast_attr attr; /* Additional attribute, use depending on node type */
177 uint32_t lineno; /* Line number */
178 zend_ast *child[1]; /* Array of children (using struct hack) */
179 };
180
181 /* Same as zend_ast, but with children count, which is updated dynamically */
182 typedef struct _zend_ast_list {
183 zend_ast_kind kind;
184 zend_ast_attr attr;
185 uint32_t lineno;
186 uint32_t children;
187 zend_ast *child[1];
188 } zend_ast_list;
189
190 /* Lineno is stored in val.u2.lineno */
191 typedef struct _zend_ast_zval {
192 zend_ast_kind kind;
193 zend_ast_attr attr;
194 zval val;
195 } zend_ast_zval;
196
197 /* Separate structure for function and class declaration, as they need extra information. */
198 typedef struct _zend_ast_decl {
199 zend_ast_kind kind;
200 zend_ast_attr attr; /* Unused - for structure compatibility */
201 uint32_t start_lineno;
202 uint32_t end_lineno;
203 uint32_t flags;
204 unsigned char *lex_pos;
205 zend_string *doc_comment;
206 zend_string *name;
207 zend_ast *child[5];
208 } zend_ast_decl;
209
210 typedef void (*zend_ast_process_t)(zend_ast *ast);
211 extern ZEND_API zend_ast_process_t zend_ast_process;
212
213 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval_with_lineno(zval *zv, uint32_t lineno);
214 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval_ex(zval *zv, zend_ast_attr attr);
215 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval(zval *zv);
216 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval_from_str(zend_string *str);
217 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_zval_from_long(zend_long lval);
218
219 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_constant(zend_string *name, zend_ast_attr attr);
220 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_class_const_or_name(zend_ast *class_name, zend_ast *name);
221
222 #if ZEND_AST_SPEC
223 # define ZEND_AST_SPEC_CALL(name, ...) \
224 ZEND_EXPAND_VA(ZEND_AST_SPEC_CALL_(name, __VA_ARGS__, _5, _4, _3, _2, _1, _0)(__VA_ARGS__))
225 # define ZEND_AST_SPEC_CALL_(name, _, _5, _4, _3, _2, _1, suffix, ...) \
226 name ## suffix
227 # define ZEND_AST_SPEC_CALL_EX(name, ...) \
228 ZEND_EXPAND_VA(ZEND_AST_SPEC_CALL_EX_(name, __VA_ARGS__, _5, _4, _3, _2, _1, _0)(__VA_ARGS__))
229 # define ZEND_AST_SPEC_CALL_EX_(name, _, _6, _5, _4, _3, _2, _1, suffix, ...) \
230 name ## suffix
231
232 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_0(zend_ast_kind kind);
233 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_1(zend_ast_kind kind, zend_ast *child);
234 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_2(zend_ast_kind kind, zend_ast *child1, zend_ast *child2);
235 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_3(zend_ast_kind kind, zend_ast *child1, zend_ast *child2, zend_ast *child3);
236 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_4(zend_ast_kind kind, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4);
237 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_5(zend_ast_kind kind, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4, zend_ast *child5);
238
zend_ast_create_ex_0(zend_ast_kind kind,zend_ast_attr attr)239 static zend_always_inline zend_ast * zend_ast_create_ex_0(zend_ast_kind kind, zend_ast_attr attr) {
240 zend_ast *ast = zend_ast_create_0(kind);
241 ast->attr = attr;
242 return ast;
243 }
zend_ast_create_ex_1(zend_ast_kind kind,zend_ast_attr attr,zend_ast * child)244 static zend_always_inline zend_ast * zend_ast_create_ex_1(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child) {
245 zend_ast *ast = zend_ast_create_1(kind, child);
246 ast->attr = attr;
247 return ast;
248 }
zend_ast_create_ex_2(zend_ast_kind kind,zend_ast_attr attr,zend_ast * child1,zend_ast * child2)249 static zend_always_inline zend_ast * zend_ast_create_ex_2(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child1, zend_ast *child2) {
250 zend_ast *ast = zend_ast_create_2(kind, child1, child2);
251 ast->attr = attr;
252 return ast;
253 }
zend_ast_create_ex_3(zend_ast_kind kind,zend_ast_attr attr,zend_ast * child1,zend_ast * child2,zend_ast * child3)254 static zend_always_inline zend_ast * zend_ast_create_ex_3(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child1, zend_ast *child2, zend_ast *child3) {
255 zend_ast *ast = zend_ast_create_3(kind, child1, child2, child3);
256 ast->attr = attr;
257 return ast;
258 }
zend_ast_create_ex_4(zend_ast_kind kind,zend_ast_attr attr,zend_ast * child1,zend_ast * child2,zend_ast * child3,zend_ast * child4)259 static zend_always_inline zend_ast * zend_ast_create_ex_4(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4) {
260 zend_ast *ast = zend_ast_create_4(kind, child1, child2, child3, child4);
261 ast->attr = attr;
262 return ast;
263 }
zend_ast_create_ex_5(zend_ast_kind kind,zend_ast_attr attr,zend_ast * child1,zend_ast * child2,zend_ast * child3,zend_ast * child4,zend_ast * child5)264 static zend_always_inline zend_ast * zend_ast_create_ex_5(zend_ast_kind kind, zend_ast_attr attr, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4, zend_ast *child5) {
265 zend_ast *ast = zend_ast_create_5(kind, child1, child2, child3, child4, child5);
266 ast->attr = attr;
267 return ast;
268 }
269
270 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_list_0(zend_ast_kind kind);
271 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_list_1(zend_ast_kind kind, zend_ast *child);
272 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_create_list_2(zend_ast_kind kind, zend_ast *child1, zend_ast *child2);
273
274 # define zend_ast_create(...) \
275 ZEND_AST_SPEC_CALL(zend_ast_create, __VA_ARGS__)
276 # define zend_ast_create_ex(...) \
277 ZEND_AST_SPEC_CALL_EX(zend_ast_create_ex, __VA_ARGS__)
278 # define zend_ast_create_list(init_children, ...) \
279 ZEND_AST_SPEC_CALL(zend_ast_create_list, __VA_ARGS__)
280
281 #else
282 ZEND_API zend_ast *zend_ast_create(zend_ast_kind kind, ...);
283 ZEND_API zend_ast *zend_ast_create_ex(zend_ast_kind kind, zend_ast_attr attr, ...);
284 ZEND_API zend_ast *zend_ast_create_list(uint32_t init_children, zend_ast_kind kind, ...);
285 #endif
286
287 ZEND_API zend_ast * ZEND_FASTCALL zend_ast_list_add(zend_ast *list, zend_ast *op);
288
289 ZEND_API zend_ast *zend_ast_create_decl(
290 zend_ast_kind kind, uint32_t flags, uint32_t start_lineno, zend_string *doc_comment,
291 zend_string *name, zend_ast *child0, zend_ast *child1, zend_ast *child2, zend_ast *child3, zend_ast *child4
292 );
293
294 ZEND_API zend_result ZEND_FASTCALL zend_ast_evaluate(zval *result, zend_ast *ast, zend_class_entry *scope);
295 ZEND_API zend_string *zend_ast_export(const char *prefix, zend_ast *ast, const char *suffix);
296
297 ZEND_API zend_ast_ref * ZEND_FASTCALL zend_ast_copy(zend_ast *ast);
298 ZEND_API void ZEND_FASTCALL zend_ast_destroy(zend_ast *ast);
299 ZEND_API void ZEND_FASTCALL zend_ast_ref_destroy(zend_ast_ref *ast);
300
301 typedef void (*zend_ast_apply_func)(zend_ast **ast_ptr);
302 ZEND_API void zend_ast_apply(zend_ast *ast, zend_ast_apply_func fn);
303
zend_ast_is_special(zend_ast * ast)304 static zend_always_inline zend_bool zend_ast_is_special(zend_ast *ast) {
305 return (ast->kind >> ZEND_AST_SPECIAL_SHIFT) & 1;
306 }
307
zend_ast_is_list(zend_ast * ast)308 static zend_always_inline zend_bool zend_ast_is_list(zend_ast *ast) {
309 return (ast->kind >> ZEND_AST_IS_LIST_SHIFT) & 1;
310 }
zend_ast_get_list(zend_ast * ast)311 static zend_always_inline zend_ast_list *zend_ast_get_list(zend_ast *ast) {
312 ZEND_ASSERT(zend_ast_is_list(ast));
313 return (zend_ast_list *) ast;
314 }
315
zend_ast_get_zval(zend_ast * ast)316 static zend_always_inline zval *zend_ast_get_zval(zend_ast *ast) {
317 ZEND_ASSERT(ast->kind == ZEND_AST_ZVAL);
318 return &((zend_ast_zval *) ast)->val;
319 }
zend_ast_get_str(zend_ast * ast)320 static zend_always_inline zend_string *zend_ast_get_str(zend_ast *ast) {
321 zval *zv = zend_ast_get_zval(ast);
322 ZEND_ASSERT(Z_TYPE_P(zv) == IS_STRING);
323 return Z_STR_P(zv);
324 }
325
zend_ast_get_constant_name(zend_ast * ast)326 static zend_always_inline zend_string *zend_ast_get_constant_name(zend_ast *ast) {
327 ZEND_ASSERT(ast->kind == ZEND_AST_CONSTANT);
328 ZEND_ASSERT(Z_TYPE(((zend_ast_zval *) ast)->val) == IS_STRING);
329 return Z_STR(((zend_ast_zval *) ast)->val);
330 }
331
zend_ast_get_num_children(zend_ast * ast)332 static zend_always_inline uint32_t zend_ast_get_num_children(zend_ast *ast) {
333 ZEND_ASSERT(!zend_ast_is_list(ast));
334 return ast->kind >> ZEND_AST_NUM_CHILDREN_SHIFT;
335 }
zend_ast_get_lineno(zend_ast * ast)336 static zend_always_inline uint32_t zend_ast_get_lineno(zend_ast *ast) {
337 if (ast->kind == ZEND_AST_ZVAL) {
338 zval *zv = zend_ast_get_zval(ast);
339 return Z_LINENO_P(zv);
340 } else {
341 return ast->lineno;
342 }
343 }
344
zend_ast_create_binary_op(uint32_t opcode,zend_ast * op0,zend_ast * op1)345 static zend_always_inline zend_ast *zend_ast_create_binary_op(uint32_t opcode, zend_ast *op0, zend_ast *op1) {
346 return zend_ast_create_ex(ZEND_AST_BINARY_OP, opcode, op0, op1);
347 }
zend_ast_create_assign_op(uint32_t opcode,zend_ast * op0,zend_ast * op1)348 static zend_always_inline zend_ast *zend_ast_create_assign_op(uint32_t opcode, zend_ast *op0, zend_ast *op1) {
349 return zend_ast_create_ex(ZEND_AST_ASSIGN_OP, opcode, op0, op1);
350 }
zend_ast_create_cast(uint32_t type,zend_ast * op0)351 static zend_always_inline zend_ast *zend_ast_create_cast(uint32_t type, zend_ast *op0) {
352 return zend_ast_create_ex(ZEND_AST_CAST, type, op0);
353 }
zend_ast_list_rtrim(zend_ast * ast)354 static zend_always_inline zend_ast *zend_ast_list_rtrim(zend_ast *ast) {
355 zend_ast_list *list = zend_ast_get_list(ast);
356 if (list->children && list->child[list->children - 1] == NULL) {
357 list->children--;
358 }
359 return ast;
360 }
361
362 zend_ast * ZEND_FASTCALL zend_ast_with_attributes(zend_ast *ast, zend_ast *attr);
363
364 #endif
365
