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*,
103 /* TODO: the codegen function should take an output-type parameter
104 * indicating whether a variable, type, label etc. is expected, and
106 * Then later an ast_ident could have a codegen using this to figure
107 * out what to look for.
108 * eg. in code which uses a not-yet defined variable, the expression
109 * would take an ast_ident, and the codegen would be called with
110 * type `expression`, so the ast_ident's codegen would search for
111 * variables through the environment (or functions, constants...).
115 ast_node_common node;
116 ast_expression_codegen *codegen;
118 ast_expression *next;
119 MEM_VECTOR_MAKE(ast_value*, params);
121 /* The codegen functions should store their output values
122 * so we can call it multiple times without re-evaluating.
123 * Store lvalue and rvalue seperately though. So that
124 * ast_entfield for example can generate both if required.
128 } ast_expression_common;
129 MEM_VECTOR_PROTO(ast_expression_common, ast_value*, params);
133 * Types are also values, both have a type and a name.
134 * especially considering possible constructs like typedefs.
136 * is like creating a 'float foo', foo serving as the type's name.
140 ast_expression_common expression;
159 /* usecount for the parser */
165 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
166 ast_value* ast_value_copy(const ast_value *self);
167 /* This will NOT delete an underlying ast_function */
168 void ast_value_delete(ast_value*);
170 bool ast_value_set_name(ast_value*, const char *name);
172 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
173 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
174 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
176 bool GMQCC_WARN ast_value_params_add(ast_value*, ast_value*);
178 bool ast_compare_type(ast_expression *a, ast_expression *b);
179 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
180 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
181 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
182 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
186 * A value-returning binary expression.
190 ast_expression_common expression;
193 ast_expression *left;
194 ast_expression *right;
196 ast_binary* ast_binary_new(lex_ctx ctx,
198 ast_expression *left,
199 ast_expression *right);
200 void ast_binary_delete(ast_binary*);
202 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
206 * An assignment including a binary expression with the source as left operand.
207 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
209 struct ast_binstore_s
211 ast_expression_common expression;
215 ast_expression *dest;
216 ast_expression *source;
218 ast_binstore* ast_binstore_new(lex_ctx ctx,
221 ast_expression *left,
222 ast_expression *right);
223 void ast_binstore_delete(ast_binstore*);
225 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
229 * Regular unary expressions: not,neg
233 ast_expression_common expression;
236 ast_expression *operand;
238 ast_unary* ast_unary_new(lex_ctx ctx,
240 ast_expression *expr);
241 void ast_unary_delete(ast_unary*);
243 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
247 * Make sure 'return' only happens at the end of a block, otherwise the IR
248 * will refuse to create further instructions.
249 * This should be honored by the parser.
253 ast_expression_common expression;
254 ast_expression *operand;
256 ast_return* ast_return_new(lex_ctx ctx,
257 ast_expression *expr);
258 void ast_return_delete(ast_return*);
260 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
264 * This must do 2 things:
265 * -) Provide a way to fetch an entity field value. (Rvalue)
266 * -) Provide a pointer to an entity field. (Lvalue)
268 * In original QC, there's only a STORE via pointer, but
269 * no LOAD via pointer.
270 * So we must know beforehand if we are going to read or assign
272 * For this we will have to extend the codegen() functions with
273 * a flag saying whether or not we need an L or an R-value.
275 struct ast_entfield_s
277 ast_expression_common expression;
278 /* The entity can come from an expression of course. */
279 ast_expression *entity;
280 /* As can the field, it just must result in a value of TYPE_FIELD */
281 ast_expression *field;
283 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
284 void ast_entfield_delete(ast_entfield*);
286 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
290 * For now used for vectors. If we get structs or unions
291 * we can have them handled here as well.
295 ast_expression_common expression;
296 ast_expression *owner;
299 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field);
300 void ast_member_delete(ast_member*);
302 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
306 * Stores left<-right and returns left.
307 * Specialized binary expression node
311 ast_expression_common expression;
313 ast_expression *dest;
314 ast_expression *source;
316 ast_store* ast_store_new(lex_ctx ctx, int op,
317 ast_expression *d, ast_expression *s);
318 void ast_store_delete(ast_store*);
320 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
324 * A general 'if then else' statement, either side can be NULL and will
325 * thus be omitted. It is an error for *both* cases to be NULL at once.
327 * During its 'codegen' it'll be changing the ast_function's block.
329 * An if is also an "expression". Its codegen will put NULL into the
330 * output field though. For ternary expressions an ast_ternary will be
335 ast_expression_common expression;
336 ast_expression *cond;
337 /* It's all just 'expressions', since an ast_block is one too. */
338 ast_expression *on_true;
339 ast_expression *on_false;
341 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
342 void ast_ifthen_delete(ast_ifthen*);
344 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
346 /* Ternary expressions...
348 * Contrary to 'if-then-else' nodes, ternary expressions actually
349 * return a value, otherwise they behave the very same way.
350 * The difference in 'codegen' is that it'll return the value of
353 * The other difference is that in an ast_ternary, NEITHER side
354 * must be NULL, there's ALWAYS an else branch.
356 * This is the only ast_node beside ast_value which contains
357 * an ir_value. Theoretically we don't need to remember it though.
361 ast_expression_common expression;
362 ast_expression *cond;
363 /* It's all just 'expressions', since an ast_block is one too. */
364 ast_expression *on_true;
365 ast_expression *on_false;
366 /* After a ternary expression we find ourselves in a new IR block
367 * and start with a PHI node */
370 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
371 void ast_ternary_delete(ast_ternary*);
373 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
375 /* A general loop node
377 * For convenience it contains 4 parts:
378 * -) (ini) = initializing expression
379 * -) (pre) = pre-loop condition
380 * -) (pst) = post-loop condition
381 * -) (inc) = "increment" expression
382 * The following is a psudo-representation of this loop
383 * note that '=>' bears the logical meaning of "implies".
384 * (a => b) equals (!a || b)
387 while (has_pre => {pre})
391 continue: // a 'continue' will jump here
392 if (has_pst => {pst})
400 ast_expression_common expression;
401 ast_expression *initexpr;
402 ast_expression *precond;
403 ast_expression *postcond;
404 ast_expression *increment;
405 ast_expression *body;
407 ast_loop* ast_loop_new(lex_ctx ctx,
408 ast_expression *initexpr,
409 ast_expression *precond,
410 ast_expression *postcond,
411 ast_expression *increment,
412 ast_expression *body);
413 void ast_loop_delete(ast_loop*);
415 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
419 * Contains an ast_expression as target, rather than an ast_function/value.
420 * Since it's how QC works, every ast_function has an ast_value
421 * associated anyway - in other words, the VM contains function
422 * pointers for every function anyway. Thus, this node will call
424 * Additionally it contains a list of ast_expressions as parameters.
425 * Since calls can return values, an ast_call is also an ast_expression.
429 ast_expression_common expression;
430 ast_expression *func;
431 MEM_VECTOR_MAKE(ast_expression*, params);
433 ast_call* ast_call_new(lex_ctx ctx,
434 ast_expression *funcexpr);
435 void ast_call_delete(ast_call*);
436 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
437 bool ast_call_check_types(ast_call*);
439 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
446 ast_expression_common expression;
448 MEM_VECTOR_MAKE(ast_value*, locals);
449 MEM_VECTOR_MAKE(ast_expression*, exprs);
450 MEM_VECTOR_MAKE(ast_expression*, collect);
452 ast_block* ast_block_new(lex_ctx ctx);
453 void ast_block_delete(ast_block*);
454 bool ast_block_set_type(ast_block*, ast_expression *from);
456 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
457 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
458 MEM_VECTOR_PROTO(ast_block, ast_expression*, collect);
460 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
461 bool ast_block_collect(ast_block*, ast_expression*);
465 * Contains a list of blocks... at least in theory.
466 * Usually there's just the main block, other blocks are inside that.
468 * Technically, functions don't need to be an AST node, since we have
469 * neither functions inside functions, nor lambdas, and function
470 * pointers could just work with a name. However, this way could be
471 * more flexible, and adds no real complexity.
473 struct ast_function_s
475 ast_node_common node;
482 ir_function *ir_func;
484 ir_block *breakblock;
485 ir_block *continueblock;
488 /* in order for thread safety - for the optional
489 * channel abesed multithreading... keeping a buffer
490 * here to use in ast_function_label.
494 MEM_VECTOR_MAKE(ast_block*, blocks);
496 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
497 /* This will NOT delete the underlying ast_value */
498 void ast_function_delete(ast_function*);
499 /* For "optimized" builds this can just keep returning "foo"...
502 const char* ast_function_label(ast_function*, const char *prefix);
504 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
506 bool ast_function_codegen(ast_function *self, ir_builder *builder);
510 union ast_expression_u
512 ast_expression_common expression;
520 ast_entfield entfield;
527 ast_node_common node;
528 ast_expression expression;