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;
55 TYPE_ast_node, /* 0 */
56 TYPE_ast_expression, /* 1 */
57 TYPE_ast_value, /* 2 */
58 TYPE_ast_function, /* 3 */
59 TYPE_ast_block, /* 4 */
60 TYPE_ast_binary, /* 5 */
61 TYPE_ast_store, /* 6 */
62 TYPE_ast_binstore, /* 7 */
63 TYPE_ast_entfield, /* 8 */
64 TYPE_ast_ifthen, /* 9 */
65 TYPE_ast_ternary, /* 10 */
66 TYPE_ast_loop, /* 11 */
67 TYPE_ast_call, /* 12 */
68 TYPE_ast_unary, /* 13 */
69 TYPE_ast_return, /* 14 */
70 TYPE_ast_member, /* 15 */
71 TYPE_ast_array_index, /* 16 */
72 TYPE_ast_breakcont, /* 17 */
73 TYPE_ast_switch, /* 18 */
74 TYPE_ast_label, /* 19 */
75 TYPE_ast_goto /* 20 */
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;
143 #define AST_FLAG_VARIADIC (1<<0)
144 #define AST_FLAG_NORETURN (1<<1)
145 #define AST_FLAG_INLINE (1<<2)
149 * Types are also values, both have a type and a name.
150 * especially considering possible constructs like typedefs.
152 * is like creating a 'float foo', foo serving as the type's name.
156 ast_expression_common expression;
165 int cvq; /* const/var qualifier */
166 bool isfield; /* this declares a field */
178 /* usecount for the parser */
182 ir_value **ir_values;
183 size_t ir_value_count;
185 /* ONLY for arrays in progs version up to 6 */
190 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
191 ast_value* ast_value_copy(const ast_value *self);
192 /* This will NOT delete an underlying ast_function */
193 void ast_value_delete(ast_value*);
195 bool ast_value_set_name(ast_value*, const char *name);
197 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
198 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
199 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
201 void ast_value_params_add(ast_value*, ast_value*);
203 bool ast_compare_type(ast_expression *a, ast_expression *b);
204 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
205 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
206 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
207 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
211 * A value-returning binary expression.
215 ast_expression_common expression;
218 ast_expression *left;
219 ast_expression *right;
221 ast_binary* ast_binary_new(lex_ctx ctx,
223 ast_expression *left,
224 ast_expression *right);
225 void ast_binary_delete(ast_binary*);
227 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
231 * An assignment including a binary expression with the source as left operand.
232 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
234 struct ast_binstore_s
236 ast_expression_common expression;
240 ast_expression *dest;
241 ast_expression *source;
242 /* for &~= which uses the destination in a binary in source we can use this */
245 ast_binstore* ast_binstore_new(lex_ctx ctx,
248 ast_expression *left,
249 ast_expression *right);
250 void ast_binstore_delete(ast_binstore*);
252 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
256 * Regular unary expressions: not,neg
260 ast_expression_common expression;
263 ast_expression *operand;
265 ast_unary* ast_unary_new(lex_ctx ctx,
267 ast_expression *expr);
268 void ast_unary_delete(ast_unary*);
270 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
274 * Make sure 'return' only happens at the end of a block, otherwise the IR
275 * will refuse to create further instructions.
276 * This should be honored by the parser.
280 ast_expression_common expression;
281 ast_expression *operand;
283 ast_return* ast_return_new(lex_ctx ctx,
284 ast_expression *expr);
285 void ast_return_delete(ast_return*);
287 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
291 * This must do 2 things:
292 * -) Provide a way to fetch an entity field value. (Rvalue)
293 * -) Provide a pointer to an entity field. (Lvalue)
295 * In original QC, there's only a STORE via pointer, but
296 * no LOAD via pointer.
297 * So we must know beforehand if we are going to read or assign
299 * For this we will have to extend the codegen() functions with
300 * a flag saying whether or not we need an L or an R-value.
302 struct ast_entfield_s
304 ast_expression_common expression;
305 /* The entity can come from an expression of course. */
306 ast_expression *entity;
307 /* As can the field, it just must result in a value of TYPE_FIELD */
308 ast_expression *field;
310 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
311 ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
312 void ast_entfield_delete(ast_entfield*);
314 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
318 * For now used for vectors. If we get structs or unions
319 * we can have them handled here as well.
323 ast_expression_common expression;
324 ast_expression *owner;
328 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field, const char *name);
329 void ast_member_delete(ast_member*);
330 bool ast_member_set_name(ast_member*, const char *name);
332 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
334 /* Array index access:
336 * QC forces us to take special action on arrays:
337 * an ast_store on an ast_array_index must not codegen the index,
338 * but call its setter - unless we have an instruction set which supports
340 * Any other array index access will be codegened to a call to the getter.
341 * In any case, accessing an element via a compiletime-constant index will
342 * result in quick access to that variable.
344 struct ast_array_index_s
346 ast_expression_common expression;
347 ast_expression *array;
348 ast_expression *index;
350 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
351 void ast_array_index_delete(ast_array_index*);
353 bool ast_array_index_codegen(ast_array_index*, ast_function*, bool lvalue, ir_value**);
357 * Stores left<-right and returns left.
358 * Specialized binary expression node
362 ast_expression_common expression;
364 ast_expression *dest;
365 ast_expression *source;
367 ast_store* ast_store_new(lex_ctx ctx, int op,
368 ast_expression *d, ast_expression *s);
369 void ast_store_delete(ast_store*);
371 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
375 * A general 'if then else' statement, either side can be NULL and will
376 * thus be omitted. It is an error for *both* cases to be NULL at once.
378 * During its 'codegen' it'll be changing the ast_function's block.
380 * An if is also an "expression". Its codegen will put NULL into the
381 * output field though. For ternary expressions an ast_ternary will be
386 ast_expression_common expression;
387 ast_expression *cond;
388 /* It's all just 'expressions', since an ast_block is one too. */
389 ast_expression *on_true;
390 ast_expression *on_false;
392 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
393 void ast_ifthen_delete(ast_ifthen*);
395 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
397 /* Ternary expressions...
399 * Contrary to 'if-then-else' nodes, ternary expressions actually
400 * return a value, otherwise they behave the very same way.
401 * The difference in 'codegen' is that it'll return the value of
404 * The other difference is that in an ast_ternary, NEITHER side
405 * must be NULL, there's ALWAYS an else branch.
407 * This is the only ast_node beside ast_value which contains
408 * an ir_value. Theoretically we don't need to remember it though.
412 ast_expression_common expression;
413 ast_expression *cond;
414 /* It's all just 'expressions', since an ast_block is one too. */
415 ast_expression *on_true;
416 ast_expression *on_false;
418 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
419 void ast_ternary_delete(ast_ternary*);
421 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
423 /* A general loop node
425 * For convenience it contains 4 parts:
426 * -) (ini) = initializing expression
427 * -) (pre) = pre-loop condition
428 * -) (pst) = post-loop condition
429 * -) (inc) = "increment" expression
430 * The following is a psudo-representation of this loop
431 * note that '=>' bears the logical meaning of "implies".
432 * (a => b) equals (!a || b)
435 while (has_pre => {pre})
439 continue: // a 'continue' will jump here
440 if (has_pst => {pst})
448 ast_expression_common expression;
449 ast_expression *initexpr;
450 ast_expression *precond;
451 ast_expression *postcond;
452 ast_expression *increment;
453 ast_expression *body;
454 /* For now we allow a seperate flag on whether or not the condition
455 * is supposed to be true or false.
456 * That way, the parser can generate a 'while not(!x)' for `while(x)`
457 * if desired, which is useful for the new -f{true,false}-empty-strings
463 ast_loop* ast_loop_new(lex_ctx ctx,
464 ast_expression *initexpr,
465 ast_expression *precond, bool pre_not,
466 ast_expression *postcond, bool post_not,
467 ast_expression *increment,
468 ast_expression *body);
469 void ast_loop_delete(ast_loop*);
471 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
475 struct ast_breakcont_s
477 ast_expression_common expression;
481 ast_breakcont* ast_breakcont_new(lex_ctx ctx, bool iscont, unsigned int levels);
482 void ast_breakcont_delete(ast_breakcont*);
484 bool ast_breakcont_codegen(ast_breakcont*, ast_function*, bool lvalue, ir_value**);
488 * A few notes about this: with the original QCVM, no real optimization
489 * is possible. The SWITCH instruction set isn't really helping a lot, since
490 * it only collapes the EQ and IF instructions into one.
491 * Note: Declaring local variables inside caseblocks is normal.
492 * Since we don't have to deal with a stack there's no unnatural behaviour to
493 * be expected from it.
497 ast_expression *value; /* #20 will replace this */
498 ast_expression *code;
502 ast_expression_common expression;
504 ast_expression *operand;
505 ast_switch_case *cases;
508 ast_switch* ast_switch_new(lex_ctx ctx, ast_expression *op);
509 void ast_switch_delete(ast_switch*);
511 bool ast_switch_codegen(ast_switch*, ast_function*, bool lvalue, ir_value**);
515 * Introduce a label which can be used together with 'goto'
519 ast_expression_common expression;
525 ast_label* ast_label_new(lex_ctx ctx, const char *name);
526 void ast_label_delete(ast_label*);
527 void ast_label_register_goto(ast_label*, ast_goto*);
529 bool ast_label_codegen(ast_label*, ast_function*, bool lvalue, ir_value**);
533 * Go to a label, the label node is filled in at a later point!
537 ast_expression_common expression;
540 ir_block *irblock_from;
543 ast_goto* ast_goto_new(lex_ctx ctx, const char *name);
544 void ast_goto_delete(ast_goto*);
545 void ast_goto_set_label(ast_goto*, ast_label*);
547 bool ast_goto_codegen(ast_goto*, ast_function*, bool lvalue, ir_value**);
551 * Contains an ast_expression as target, rather than an ast_function/value.
552 * Since it's how QC works, every ast_function has an ast_value
553 * associated anyway - in other words, the VM contains function
554 * pointers for every function anyway. Thus, this node will call
556 * Additionally it contains a list of ast_expressions as parameters.
557 * Since calls can return values, an ast_call is also an ast_expression.
561 ast_expression_common expression;
562 ast_expression *func;
563 ast_expression* *params;
565 ast_call* ast_call_new(lex_ctx ctx,
566 ast_expression *funcexpr);
567 void ast_call_delete(ast_call*);
568 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
569 bool ast_call_check_types(ast_call*);
576 ast_expression_common expression;
579 ast_expression* *exprs;
580 ast_expression* *collect;
582 ast_block* ast_block_new(lex_ctx ctx);
583 void ast_block_delete(ast_block*);
584 bool ast_block_set_type(ast_block*, ast_expression *from);
586 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
587 void ast_block_collect(ast_block*, ast_expression*);
589 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
593 * Contains a list of blocks... at least in theory.
594 * Usually there's just the main block, other blocks are inside that.
596 * Technically, functions don't need to be an AST node, since we have
597 * neither functions inside functions, nor lambdas, and function
598 * pointers could just work with a name. However, this way could be
599 * more flexible, and adds no real complexity.
601 struct ast_function_s
603 ast_node_common node;
610 ir_function *ir_func;
612 ir_block **breakblocks;
613 ir_block **continueblocks;
616 /* In order for early-out logic not to go over
617 * excessive jumps, we remember their target
625 /* in order for thread safety - for the optional
626 * channel abesed multithreading... keeping a buffer
627 * here to use in ast_function_label.
633 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
634 /* This will NOT delete the underlying ast_value */
635 void ast_function_delete(ast_function*);
636 /* For "optimized" builds this can just keep returning "foo"...
639 const char* ast_function_label(ast_function*, const char *prefix);
641 bool ast_function_codegen(ast_function *self, ir_builder *builder);
642 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
646 union ast_expression_u
648 ast_expression_common expression;
656 ast_entfield entfield;
663 ast_node_common node;
664 ast_expression expression;