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;
49 typedef struct ast_breakcont_s ast_breakcont;
50 typedef struct ast_switch_s ast_switch;
51 typedef struct ast_label_s ast_label;
52 typedef struct ast_goto_s ast_goto;
78 #define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
79 #define ast_ctx(node) (((ast_node_common*)(node))->context)
80 #define ast_side_effects(node) (((ast_node_common*)(node))->side_effects)
82 /* Node interface with common components
84 typedef void ast_node_delete(ast_node*);
88 /* I don't feel comfortable using keywords like 'delete' as names... */
89 ast_node_delete *destroy;
91 /* keep: if a node contains this node, 'keep'
92 * prevents its dtor from destroying this node as well.
98 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
99 #define ast_unref(x) do \
101 if (! (((ast_node*)(x))->node.keep) ) { \
106 /* Expression interface
108 * Any expression or block returns an ir_value, and needs
109 * to know the current function.
111 typedef bool ast_expression_codegen(ast_expression*,
115 /* TODO: the codegen function should take an output-type parameter
116 * indicating whether a variable, type, label etc. is expected, and
118 * Then later an ast_ident could have a codegen using this to figure
119 * out what to look for.
120 * eg. in code which uses a not-yet defined variable, the expression
121 * would take an ast_ident, and the codegen would be called with
122 * type `expression`, so the ast_ident's codegen would search for
123 * variables through the environment (or functions, constants...).
127 ast_node_common node;
128 ast_expression_codegen *codegen;
130 ast_expression *next;
131 /* arrays get a member-count */
135 /* The codegen functions should store their output values
136 * so we can call it multiple times without re-evaluating.
137 * Store lvalue and rvalue seperately though. So that
138 * ast_entfield for example can generate both if required.
142 } ast_expression_common;
146 * Types are also values, both have a type and a name.
147 * especially considering possible constructs like typedefs.
149 * is like creating a 'float foo', foo serving as the type's name.
153 ast_expression_common expression;
173 /* usecount for the parser */
177 ir_value **ir_values;
178 size_t ir_value_count;
180 /* ONLY for arrays in progs version up to 6 */
185 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
186 ast_value* ast_value_copy(const ast_value *self);
187 /* This will NOT delete an underlying ast_function */
188 void ast_value_delete(ast_value*);
190 bool ast_value_set_name(ast_value*, const char *name);
192 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
193 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
194 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
196 void ast_value_params_add(ast_value*, ast_value*);
198 bool ast_compare_type(ast_expression *a, ast_expression *b);
199 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
200 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
201 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
202 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
206 * A value-returning binary expression.
210 ast_expression_common expression;
213 ast_expression *left;
214 ast_expression *right;
216 ast_binary* ast_binary_new(lex_ctx ctx,
218 ast_expression *left,
219 ast_expression *right);
220 void ast_binary_delete(ast_binary*);
222 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
226 * An assignment including a binary expression with the source as left operand.
227 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
229 struct ast_binstore_s
231 ast_expression_common expression;
235 ast_expression *dest;
236 ast_expression *source;
237 /* for &~= which uses the destination in a binary in source we can use this */
240 ast_binstore* ast_binstore_new(lex_ctx ctx,
243 ast_expression *left,
244 ast_expression *right);
245 void ast_binstore_delete(ast_binstore*);
247 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
251 * Regular unary expressions: not,neg
255 ast_expression_common expression;
258 ast_expression *operand;
260 ast_unary* ast_unary_new(lex_ctx ctx,
262 ast_expression *expr);
263 void ast_unary_delete(ast_unary*);
265 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
269 * Make sure 'return' only happens at the end of a block, otherwise the IR
270 * will refuse to create further instructions.
271 * This should be honored by the parser.
275 ast_expression_common expression;
276 ast_expression *operand;
278 ast_return* ast_return_new(lex_ctx ctx,
279 ast_expression *expr);
280 void ast_return_delete(ast_return*);
282 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
286 * This must do 2 things:
287 * -) Provide a way to fetch an entity field value. (Rvalue)
288 * -) Provide a pointer to an entity field. (Lvalue)
290 * In original QC, there's only a STORE via pointer, but
291 * no LOAD via pointer.
292 * So we must know beforehand if we are going to read or assign
294 * For this we will have to extend the codegen() functions with
295 * a flag saying whether or not we need an L or an R-value.
297 struct ast_entfield_s
299 ast_expression_common expression;
300 /* The entity can come from an expression of course. */
301 ast_expression *entity;
302 /* As can the field, it just must result in a value of TYPE_FIELD */
303 ast_expression *field;
305 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
306 ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
307 void ast_entfield_delete(ast_entfield*);
309 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
313 * For now used for vectors. If we get structs or unions
314 * we can have them handled here as well.
318 ast_expression_common expression;
319 ast_expression *owner;
323 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field, const char *name);
324 void ast_member_delete(ast_member*);
326 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
328 /* Array index access:
330 * QC forces us to take special action on arrays:
331 * an ast_store on an ast_array_index must not codegen the index,
332 * but call its setter - unless we have an instruction set which supports
334 * Any other array index access will be codegened to a call to the getter.
335 * In any case, accessing an element via a compiletime-constant index will
336 * result in quick access to that variable.
338 struct ast_array_index_s
340 ast_expression_common expression;
341 ast_expression *array;
342 ast_expression *index;
344 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
345 void ast_array_index_delete(ast_array_index*);
347 bool ast_array_index_codegen(ast_array_index*, ast_function*, bool lvalue, ir_value**);
351 * Stores left<-right and returns left.
352 * Specialized binary expression node
356 ast_expression_common expression;
358 ast_expression *dest;
359 ast_expression *source;
361 ast_store* ast_store_new(lex_ctx ctx, int op,
362 ast_expression *d, ast_expression *s);
363 void ast_store_delete(ast_store*);
365 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
369 * A general 'if then else' statement, either side can be NULL and will
370 * thus be omitted. It is an error for *both* cases to be NULL at once.
372 * During its 'codegen' it'll be changing the ast_function's block.
374 * An if is also an "expression". Its codegen will put NULL into the
375 * output field though. For ternary expressions an ast_ternary will be
380 ast_expression_common expression;
381 ast_expression *cond;
382 /* It's all just 'expressions', since an ast_block is one too. */
383 ast_expression *on_true;
384 ast_expression *on_false;
386 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
387 void ast_ifthen_delete(ast_ifthen*);
389 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
391 /* Ternary expressions...
393 * Contrary to 'if-then-else' nodes, ternary expressions actually
394 * return a value, otherwise they behave the very same way.
395 * The difference in 'codegen' is that it'll return the value of
398 * The other difference is that in an ast_ternary, NEITHER side
399 * must be NULL, there's ALWAYS an else branch.
401 * This is the only ast_node beside ast_value which contains
402 * an ir_value. Theoretically we don't need to remember it though.
406 ast_expression_common expression;
407 ast_expression *cond;
408 /* It's all just 'expressions', since an ast_block is one too. */
409 ast_expression *on_true;
410 ast_expression *on_false;
412 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
413 void ast_ternary_delete(ast_ternary*);
415 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
417 /* A general loop node
419 * For convenience it contains 4 parts:
420 * -) (ini) = initializing expression
421 * -) (pre) = pre-loop condition
422 * -) (pst) = post-loop condition
423 * -) (inc) = "increment" expression
424 * The following is a psudo-representation of this loop
425 * note that '=>' bears the logical meaning of "implies".
426 * (a => b) equals (!a || b)
429 while (has_pre => {pre})
433 continue: // a 'continue' will jump here
434 if (has_pst => {pst})
442 ast_expression_common expression;
443 ast_expression *initexpr;
444 ast_expression *precond;
445 ast_expression *postcond;
446 ast_expression *increment;
447 ast_expression *body;
449 ast_loop* ast_loop_new(lex_ctx ctx,
450 ast_expression *initexpr,
451 ast_expression *precond,
452 ast_expression *postcond,
453 ast_expression *increment,
454 ast_expression *body);
455 void ast_loop_delete(ast_loop*);
457 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
461 struct ast_breakcont_s
463 ast_expression_common expression;
466 ast_breakcont* ast_breakcont_new(lex_ctx ctx, bool iscont);
467 void ast_breakcont_delete(ast_breakcont*);
469 bool ast_breakcont_codegen(ast_breakcont*, ast_function*, bool lvalue, ir_value**);
473 * A few notes about this: with the original QCVM, no real optimization
474 * is possible. The SWITCH instruction set isn't really helping a lot, since
475 * it only collapes the EQ and IF instructions into one.
476 * Note: Declaring local variables inside caseblocks is normal.
477 * Since we don't have to deal with a stack there's no unnatural behaviour to
478 * be expected from it.
482 ast_expression *value; /* #20 will replace this */
483 ast_expression *code;
487 ast_expression_common expression;
489 ast_expression *operand;
490 ast_switch_case *cases;
493 ast_switch* ast_switch_new(lex_ctx ctx, ast_expression *op);
494 void ast_switch_delete(ast_switch*);
496 bool ast_switch_codegen(ast_switch*, ast_function*, bool lvalue, ir_value**);
500 * Introduce a label which can be used together with 'goto'
504 ast_expression_common expression;
510 ast_label* ast_label_new(lex_ctx ctx, const char *name);
511 void ast_label_delete(ast_label*);
512 void ast_label_register_goto(ast_label*, ast_goto*);
514 bool ast_label_codegen(ast_label*, ast_function*, bool lvalue, ir_value**);
518 * Go to a label, the label node is filled in at a later point!
522 ast_expression_common expression;
525 ir_block *irblock_from;
528 ast_goto* ast_goto_new(lex_ctx ctx, const char *name);
529 void ast_goto_delete(ast_goto*);
530 void ast_goto_set_label(ast_goto*, ast_label*);
532 bool ast_goto_codegen(ast_goto*, ast_function*, bool lvalue, ir_value**);
536 * Contains an ast_expression as target, rather than an ast_function/value.
537 * Since it's how QC works, every ast_function has an ast_value
538 * associated anyway - in other words, the VM contains function
539 * pointers for every function anyway. Thus, this node will call
541 * Additionally it contains a list of ast_expressions as parameters.
542 * Since calls can return values, an ast_call is also an ast_expression.
546 ast_expression_common expression;
547 ast_expression *func;
548 ast_expression* *params;
550 ast_call* ast_call_new(lex_ctx ctx,
551 ast_expression *funcexpr);
552 void ast_call_delete(ast_call*);
553 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
554 bool ast_call_check_types(ast_call*);
561 ast_expression_common expression;
564 ast_expression* *exprs;
565 ast_expression* *collect;
567 ast_block* ast_block_new(lex_ctx ctx);
568 void ast_block_delete(ast_block*);
569 bool ast_block_set_type(ast_block*, ast_expression *from);
571 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
572 void ast_block_collect(ast_block*, ast_expression*);
574 void ast_block_add_expr(ast_block*, ast_expression*);
578 * Contains a list of blocks... at least in theory.
579 * Usually there's just the main block, other blocks are inside that.
581 * Technically, functions don't need to be an AST node, since we have
582 * neither functions inside functions, nor lambdas, and function
583 * pointers could just work with a name. However, this way could be
584 * more flexible, and adds no real complexity.
586 struct ast_function_s
588 ast_node_common node;
595 ir_function *ir_func;
597 ir_block *breakblock;
598 ir_block *continueblock;
601 /* In order for early-out logic not to go over
602 * excessive jumps, we remember their target
610 /* in order for thread safety - for the optional
611 * channel abesed multithreading... keeping a buffer
612 * here to use in ast_function_label.
618 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
619 /* This will NOT delete the underlying ast_value */
620 void ast_function_delete(ast_function*);
621 /* For "optimized" builds this can just keep returning "foo"...
624 const char* ast_function_label(ast_function*, const char *prefix);
626 bool ast_function_codegen(ast_function *self, ir_builder *builder);
630 union ast_expression_u
632 ast_expression_common expression;
640 ast_entfield entfield;
647 ast_node_common node;
648 ast_expression expression;