5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is furnished to do
10 * so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 /* Note: I will not be using a _t suffix for the
28 * "main" ast node types for now.
31 typedef union ast_node_u ast_node;
32 typedef union ast_expression_u ast_expression;
34 typedef struct ast_value_s ast_value;
35 typedef struct ast_function_s ast_function;
36 typedef struct ast_block_s ast_block;
37 typedef struct ast_binary_s ast_binary;
38 typedef struct ast_store_s ast_store;
39 typedef struct ast_binstore_s ast_binstore;
40 typedef struct ast_entfield_s ast_entfield;
41 typedef struct ast_ifthen_s ast_ifthen;
42 typedef struct ast_ternary_s ast_ternary;
43 typedef struct ast_loop_s ast_loop;
44 typedef struct ast_call_s ast_call;
45 typedef struct ast_unary_s ast_unary;
46 typedef struct ast_return_s ast_return;
47 typedef struct ast_member_s ast_member;
68 #define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
69 #define ast_ctx(node) (((ast_node_common*)(node))->context)
71 /* Node interface with common components
73 typedef void ast_node_delete(ast_node*);
77 /* I don't feel comfortable using keywords like 'delete' as names... */
78 ast_node_delete *destroy;
80 /* keep: if a node contains this node, 'keep'
81 * prevents its dtor from destroying this node as well.
86 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
87 #define ast_unref(x) do \
89 if (! (((ast_node*)(x))->node.keep) ) { \
94 /* Expression interface
96 * Any expression or block returns an ir_value, and needs
97 * to know the current function.
99 typedef bool ast_expression_codegen(ast_expression*,
105 ast_node_common node;
106 ast_expression_codegen *codegen;
108 ast_expression *next;
109 MEM_VECTOR_MAKE(ast_value*, params);
111 /* The codegen functions should store their output values
112 * so we can call it multiple times without re-evaluating.
113 * Store lvalue and rvalue seperately though. So that
114 * ast_entfield for example can generate both if required.
118 } ast_expression_common;
119 MEM_VECTOR_PROTO(ast_expression_common, ast_value*, params);
123 * Types are also values, both have a type and a name.
124 * especially considering possible constructs like typedefs.
126 * is like creating a 'float foo', foo serving as the type's name.
130 ast_expression_common expression;
152 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
153 ast_value* ast_value_copy(const ast_value *self);
154 /* This will NOT delete an underlying ast_function */
155 void ast_value_delete(ast_value*);
157 bool ast_value_set_name(ast_value*, const char *name);
159 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
160 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
161 bool ast_global_codegen(ast_value *self, ir_builder *ir);
163 bool GMQCC_WARN ast_value_params_add(ast_value*, ast_value*);
165 bool ast_compare_type(ast_expression *a, ast_expression *b);
166 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
167 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
168 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
172 * A value-returning binary expression.
176 ast_expression_common expression;
179 ast_expression *left;
180 ast_expression *right;
182 ast_binary* ast_binary_new(lex_ctx ctx,
184 ast_expression *left,
185 ast_expression *right);
186 void ast_binary_delete(ast_binary*);
188 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
192 * An assignment including a binary expression with the source as left operand.
193 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
195 struct ast_binstore_s
197 ast_expression_common expression;
201 ast_expression *dest;
202 ast_expression *source;
204 ast_binstore* ast_binstore_new(lex_ctx ctx,
207 ast_expression *left,
208 ast_expression *right);
209 void ast_binstore_delete(ast_binstore*);
211 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
215 * Regular unary expressions: not,neg
219 ast_expression_common expression;
222 ast_expression *operand;
224 ast_unary* ast_unary_new(lex_ctx ctx,
226 ast_expression *expr);
227 void ast_unary_delete(ast_unary*);
229 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
233 * Make sure 'return' only happens at the end of a block, otherwise the IR
234 * will refuse to create further instructions.
235 * This should be honored by the parser.
239 ast_expression_common expression;
240 ast_expression *operand;
242 ast_return* ast_return_new(lex_ctx ctx,
243 ast_expression *expr);
244 void ast_return_delete(ast_return*);
246 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
250 * This must do 2 things:
251 * -) Provide a way to fetch an entity field value. (Rvalue)
252 * -) Provide a pointer to an entity field. (Lvalue)
254 * In original QC, there's only a STORE via pointer, but
255 * no LOAD via pointer.
256 * So we must know beforehand if we are going to read or assign
258 * For this we will have to extend the codegen() functions with
259 * a flag saying whether or not we need an L or an R-value.
261 struct ast_entfield_s
263 ast_expression_common expression;
264 /* The entity can come from an expression of course. */
265 ast_expression *entity;
266 /* As can the field, it just must result in a value of TYPE_FIELD */
267 ast_expression *field;
269 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
270 void ast_entfield_delete(ast_entfield*);
272 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
276 * For now used for vectors. If we get structs or unions
277 * we can have them handled here as well.
281 ast_expression_common expression;
282 ast_expression *owner;
285 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field);
286 void ast_member_delete(ast_member*);
288 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
292 * Stores left<-right and returns left.
293 * Specialized binary expression node
297 ast_expression_common expression;
299 ast_expression *dest;
300 ast_expression *source;
302 ast_store* ast_store_new(lex_ctx ctx, int op,
303 ast_expression *d, ast_expression *s);
304 void ast_store_delete(ast_store*);
306 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
310 * A general 'if then else' statement, either side can be NULL and will
311 * thus be omitted. It is an error for *both* cases to be NULL at once.
313 * During its 'codegen' it'll be changing the ast_function's block.
315 * An if is also an "expression". Its codegen will put NULL into the
316 * output field though. For ternary expressions an ast_ternary will be
321 ast_expression_common expression;
322 ast_expression *cond;
323 /* It's all just 'expressions', since an ast_block is one too. */
324 ast_expression *on_true;
325 ast_expression *on_false;
327 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
328 void ast_ifthen_delete(ast_ifthen*);
330 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
332 /* Ternary expressions...
334 * Contrary to 'if-then-else' nodes, ternary expressions actually
335 * return a value, otherwise they behave the very same way.
336 * The difference in 'codegen' is that it'll return the value of
339 * The other difference is that in an ast_ternary, NEITHER side
340 * must be NULL, there's ALWAYS an else branch.
342 * This is the only ast_node beside ast_value which contains
343 * an ir_value. Theoretically we don't need to remember it though.
347 ast_expression_common expression;
348 ast_expression *cond;
349 /* It's all just 'expressions', since an ast_block is one too. */
350 ast_expression *on_true;
351 ast_expression *on_false;
352 /* After a ternary expression we find ourselves in a new IR block
353 * and start with a PHI node */
356 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
357 void ast_ternary_delete(ast_ternary*);
359 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
361 /* A general loop node
363 * For convenience it contains 4 parts:
364 * -) (ini) = initializing expression
365 * -) (pre) = pre-loop condition
366 * -) (pst) = post-loop condition
367 * -) (inc) = "increment" expression
368 * The following is a psudo-representation of this loop
369 * note that '=>' bears the logical meaning of "implies".
370 * (a => b) equals (!a || b)
373 while (has_pre => {pre})
377 continue: // a 'continue' will jump here
378 if (has_pst => {pst})
386 ast_expression_common expression;
387 ast_expression *initexpr;
388 ast_expression *precond;
389 ast_expression *postcond;
390 ast_expression *increment;
391 ast_expression *body;
393 ast_loop* ast_loop_new(lex_ctx ctx,
394 ast_expression *initexpr,
395 ast_expression *precond,
396 ast_expression *postcond,
397 ast_expression *increment,
398 ast_expression *body);
399 void ast_loop_delete(ast_loop*);
401 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
405 * Contains an ast_expression as target, rather than an ast_function/value.
406 * Since it's how QC works, every ast_function has an ast_value
407 * associated anyway - in other words, the VM contains function
408 * pointers for every function anyway. Thus, this node will call
410 * Additionally it contains a list of ast_expressions as parameters.
411 * Since calls can return values, an ast_call is also an ast_expression.
415 ast_expression_common expression;
416 ast_expression *func;
417 MEM_VECTOR_MAKE(ast_expression*, params);
419 ast_call* ast_call_new(lex_ctx ctx,
420 ast_expression *funcexpr);
421 void ast_call_delete(ast_call*);
422 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
424 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
431 ast_expression_common expression;
433 MEM_VECTOR_MAKE(ast_value*, locals);
434 MEM_VECTOR_MAKE(ast_expression*, exprs);
435 MEM_VECTOR_MAKE(ast_expression*, collect);
437 ast_block* ast_block_new(lex_ctx ctx);
438 void ast_block_delete(ast_block*);
439 bool ast_block_set_type(ast_block*, ast_expression *from);
441 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
442 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
443 MEM_VECTOR_PROTO(ast_block, ast_expression*, collect);
445 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
446 bool ast_block_collect(ast_block*, ast_expression*);
450 * Contains a list of blocks... at least in theory.
451 * Usually there's just the main block, other blocks are inside that.
453 * Technically, functions don't need to be an AST node, since we have
454 * neither functions inside functions, nor lambdas, and function
455 * pointers could just work with a name. However, this way could be
456 * more flexible, and adds no real complexity.
458 struct ast_function_s
460 ast_node_common node;
467 ir_function *ir_func;
469 ir_block *breakblock;
470 ir_block *continueblock;
473 /* in order for thread safety - for the optional
474 * channel abesed multithreading... keeping a buffer
475 * here to use in ast_function_label.
479 MEM_VECTOR_MAKE(ast_block*, blocks);
481 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
482 /* This will NOT delete the underlying ast_value */
483 void ast_function_delete(ast_function*);
484 /* For "optimized" builds this can just keep returning "foo"...
487 const char* ast_function_label(ast_function*, const char *prefix);
489 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
491 bool ast_function_codegen(ast_function *self, ir_builder *builder);
495 union ast_expression_u
497 ast_expression_common expression;
505 ast_entfield entfield;
512 ast_node_common node;
513 ast_expression expression;