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;
48 typedef struct ast_array_index_s ast_array_index;
70 #define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
71 #define ast_ctx(node) (((ast_node_common*)(node))->context)
73 /* Node interface with common components
75 typedef void ast_node_delete(ast_node*);
79 /* I don't feel comfortable using keywords like 'delete' as names... */
80 ast_node_delete *destroy;
82 /* keep: if a node contains this node, 'keep'
83 * prevents its dtor from destroying this node as well.
88 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
89 #define ast_unref(x) do \
91 if (! (((ast_node*)(x))->node.keep) ) { \
96 /* Expression interface
98 * Any expression or block returns an ir_value, and needs
99 * to know the current function.
101 typedef bool ast_expression_codegen(ast_expression*,
105 /* TODO: the codegen function should take an output-type parameter
106 * indicating whether a variable, type, label etc. is expected, and
108 * Then later an ast_ident could have a codegen using this to figure
109 * out what to look for.
110 * eg. in code which uses a not-yet defined variable, the expression
111 * would take an ast_ident, and the codegen would be called with
112 * type `expression`, so the ast_ident's codegen would search for
113 * variables through the environment (or functions, constants...).
117 ast_node_common node;
118 ast_expression_codegen *codegen;
120 ast_expression *next;
121 /* arrays get a member-count */
123 MEM_VECTOR_MAKE(ast_value*, params);
125 /* The codegen functions should store their output values
126 * so we can call it multiple times without re-evaluating.
127 * Store lvalue and rvalue seperately though. So that
128 * ast_entfield for example can generate both if required.
132 } ast_expression_common;
133 MEM_VECTOR_PROTO(ast_expression_common, ast_value*, params);
137 * Types are also values, both have a type and a name.
138 * especially considering possible constructs like typedefs.
140 * is like creating a 'float foo', foo serving as the type's name.
144 ast_expression_common expression;
163 /* usecount for the parser */
167 ir_value **ir_values;
168 size_t ir_value_count;
171 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
172 ast_value* ast_value_copy(const ast_value *self);
173 /* This will NOT delete an underlying ast_function */
174 void ast_value_delete(ast_value*);
176 bool ast_value_set_name(ast_value*, const char *name);
178 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
179 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
180 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
182 bool GMQCC_WARN ast_value_params_add(ast_value*, ast_value*);
184 bool ast_compare_type(ast_expression *a, ast_expression *b);
185 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
186 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
187 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
188 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
192 * A value-returning binary expression.
196 ast_expression_common expression;
199 ast_expression *left;
200 ast_expression *right;
202 ast_binary* ast_binary_new(lex_ctx ctx,
204 ast_expression *left,
205 ast_expression *right);
206 void ast_binary_delete(ast_binary*);
208 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
212 * An assignment including a binary expression with the source as left operand.
213 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
215 struct ast_binstore_s
217 ast_expression_common expression;
221 ast_expression *dest;
222 ast_expression *source;
224 ast_binstore* ast_binstore_new(lex_ctx ctx,
227 ast_expression *left,
228 ast_expression *right);
229 void ast_binstore_delete(ast_binstore*);
231 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
235 * Regular unary expressions: not,neg
239 ast_expression_common expression;
242 ast_expression *operand;
244 ast_unary* ast_unary_new(lex_ctx ctx,
246 ast_expression *expr);
247 void ast_unary_delete(ast_unary*);
249 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
253 * Make sure 'return' only happens at the end of a block, otherwise the IR
254 * will refuse to create further instructions.
255 * This should be honored by the parser.
259 ast_expression_common expression;
260 ast_expression *operand;
262 ast_return* ast_return_new(lex_ctx ctx,
263 ast_expression *expr);
264 void ast_return_delete(ast_return*);
266 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
270 * This must do 2 things:
271 * -) Provide a way to fetch an entity field value. (Rvalue)
272 * -) Provide a pointer to an entity field. (Lvalue)
274 * In original QC, there's only a STORE via pointer, but
275 * no LOAD via pointer.
276 * So we must know beforehand if we are going to read or assign
278 * For this we will have to extend the codegen() functions with
279 * a flag saying whether or not we need an L or an R-value.
281 struct ast_entfield_s
283 ast_expression_common expression;
284 /* The entity can come from an expression of course. */
285 ast_expression *entity;
286 /* As can the field, it just must result in a value of TYPE_FIELD */
287 ast_expression *field;
289 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
290 void ast_entfield_delete(ast_entfield*);
292 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
296 * For now used for vectors. If we get structs or unions
297 * we can have them handled here as well.
301 ast_expression_common expression;
302 ast_expression *owner;
305 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field);
306 void ast_member_delete(ast_member*);
308 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
310 /* Array index access:
312 * QC forces us to take special action on arrays:
313 * an ast_store on an ast_array_index must not codegen the index,
314 * but call its setter - unless we have an instruction set which supports
316 * Any other array index access will be codegened to a call to the getter.
317 * In any case, accessing an element via a compiletime-constant index will
318 * result in quick access to that variable.
320 struct ast_array_index_s
322 ast_expression_common expression;
323 ast_expression *array;
324 ast_expression *index;
326 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
327 void ast_array_index_delete(ast_array_index*);
329 bool ast_array_index_codegen(ast_array_index*, ast_function*, bool lvalue, ir_value**);
333 * Stores left<-right and returns left.
334 * Specialized binary expression node
338 ast_expression_common expression;
340 ast_expression *dest;
341 ast_expression *source;
343 ast_store* ast_store_new(lex_ctx ctx, int op,
344 ast_expression *d, ast_expression *s);
345 void ast_store_delete(ast_store*);
347 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
351 * A general 'if then else' statement, either side can be NULL and will
352 * thus be omitted. It is an error for *both* cases to be NULL at once.
354 * During its 'codegen' it'll be changing the ast_function's block.
356 * An if is also an "expression". Its codegen will put NULL into the
357 * output field though. For ternary expressions an ast_ternary will be
362 ast_expression_common expression;
363 ast_expression *cond;
364 /* It's all just 'expressions', since an ast_block is one too. */
365 ast_expression *on_true;
366 ast_expression *on_false;
368 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
369 void ast_ifthen_delete(ast_ifthen*);
371 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
373 /* Ternary expressions...
375 * Contrary to 'if-then-else' nodes, ternary expressions actually
376 * return a value, otherwise they behave the very same way.
377 * The difference in 'codegen' is that it'll return the value of
380 * The other difference is that in an ast_ternary, NEITHER side
381 * must be NULL, there's ALWAYS an else branch.
383 * This is the only ast_node beside ast_value which contains
384 * an ir_value. Theoretically we don't need to remember it though.
388 ast_expression_common expression;
389 ast_expression *cond;
390 /* It's all just 'expressions', since an ast_block is one too. */
391 ast_expression *on_true;
392 ast_expression *on_false;
393 /* After a ternary expression we find ourselves in a new IR block
394 * and start with a PHI node */
397 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
398 void ast_ternary_delete(ast_ternary*);
400 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
402 /* A general loop node
404 * For convenience it contains 4 parts:
405 * -) (ini) = initializing expression
406 * -) (pre) = pre-loop condition
407 * -) (pst) = post-loop condition
408 * -) (inc) = "increment" expression
409 * The following is a psudo-representation of this loop
410 * note that '=>' bears the logical meaning of "implies".
411 * (a => b) equals (!a || b)
414 while (has_pre => {pre})
418 continue: // a 'continue' will jump here
419 if (has_pst => {pst})
427 ast_expression_common expression;
428 ast_expression *initexpr;
429 ast_expression *precond;
430 ast_expression *postcond;
431 ast_expression *increment;
432 ast_expression *body;
434 ast_loop* ast_loop_new(lex_ctx ctx,
435 ast_expression *initexpr,
436 ast_expression *precond,
437 ast_expression *postcond,
438 ast_expression *increment,
439 ast_expression *body);
440 void ast_loop_delete(ast_loop*);
442 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
446 * Contains an ast_expression as target, rather than an ast_function/value.
447 * Since it's how QC works, every ast_function has an ast_value
448 * associated anyway - in other words, the VM contains function
449 * pointers for every function anyway. Thus, this node will call
451 * Additionally it contains a list of ast_expressions as parameters.
452 * Since calls can return values, an ast_call is also an ast_expression.
456 ast_expression_common expression;
457 ast_expression *func;
458 MEM_VECTOR_MAKE(ast_expression*, params);
460 ast_call* ast_call_new(lex_ctx ctx,
461 ast_expression *funcexpr);
462 void ast_call_delete(ast_call*);
463 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
464 bool ast_call_check_types(ast_call*);
466 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
473 ast_expression_common expression;
475 MEM_VECTOR_MAKE(ast_value*, locals);
476 MEM_VECTOR_MAKE(ast_expression*, exprs);
477 MEM_VECTOR_MAKE(ast_expression*, collect);
479 ast_block* ast_block_new(lex_ctx ctx);
480 void ast_block_delete(ast_block*);
481 bool ast_block_set_type(ast_block*, ast_expression *from);
483 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
484 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
485 MEM_VECTOR_PROTO(ast_block, ast_expression*, collect);
487 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
488 bool ast_block_collect(ast_block*, ast_expression*);
492 * Contains a list of blocks... at least in theory.
493 * Usually there's just the main block, other blocks are inside that.
495 * Technically, functions don't need to be an AST node, since we have
496 * neither functions inside functions, nor lambdas, and function
497 * pointers could just work with a name. However, this way could be
498 * more flexible, and adds no real complexity.
500 struct ast_function_s
502 ast_node_common node;
509 ir_function *ir_func;
511 ir_block *breakblock;
512 ir_block *continueblock;
515 /* in order for thread safety - for the optional
516 * channel abesed multithreading... keeping a buffer
517 * here to use in ast_function_label.
521 MEM_VECTOR_MAKE(ast_block*, blocks);
523 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
524 /* This will NOT delete the underlying ast_value */
525 void ast_function_delete(ast_function*);
526 /* For "optimized" builds this can just keep returning "foo"...
529 const char* ast_function_label(ast_function*, const char *prefix);
531 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
533 bool ast_function_codegen(ast_function *self, ir_builder *builder);
537 union ast_expression_u
539 ast_expression_common expression;
547 ast_entfield entfield;
554 ast_node_common node;
555 ast_expression expression;