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)
148 * Types are also values, both have a type and a name.
149 * especially considering possible constructs like typedefs.
151 * is like creating a 'float foo', foo serving as the type's name.
155 ast_expression_common expression;
164 int cvq; /* const/var qualifier */
165 bool isfield; /* this declares a field */
177 /* usecount for the parser */
181 ir_value **ir_values;
182 size_t ir_value_count;
184 /* ONLY for arrays in progs version up to 6 */
189 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
190 ast_value* ast_value_copy(const ast_value *self);
191 /* This will NOT delete an underlying ast_function */
192 void ast_value_delete(ast_value*);
194 bool ast_value_set_name(ast_value*, const char *name);
196 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
197 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
198 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
200 void ast_value_params_add(ast_value*, ast_value*);
202 bool ast_compare_type(ast_expression *a, ast_expression *b);
203 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
204 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
205 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
206 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
210 * A value-returning binary expression.
214 ast_expression_common expression;
217 ast_expression *left;
218 ast_expression *right;
220 ast_binary* ast_binary_new(lex_ctx ctx,
222 ast_expression *left,
223 ast_expression *right);
224 void ast_binary_delete(ast_binary*);
226 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
230 * An assignment including a binary expression with the source as left operand.
231 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
233 struct ast_binstore_s
235 ast_expression_common expression;
239 ast_expression *dest;
240 ast_expression *source;
241 /* for &~= which uses the destination in a binary in source we can use this */
244 ast_binstore* ast_binstore_new(lex_ctx ctx,
247 ast_expression *left,
248 ast_expression *right);
249 void ast_binstore_delete(ast_binstore*);
251 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
255 * Regular unary expressions: not,neg
259 ast_expression_common expression;
262 ast_expression *operand;
264 ast_unary* ast_unary_new(lex_ctx ctx,
266 ast_expression *expr);
267 void ast_unary_delete(ast_unary*);
269 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
273 * Make sure 'return' only happens at the end of a block, otherwise the IR
274 * will refuse to create further instructions.
275 * This should be honored by the parser.
279 ast_expression_common expression;
280 ast_expression *operand;
282 ast_return* ast_return_new(lex_ctx ctx,
283 ast_expression *expr);
284 void ast_return_delete(ast_return*);
286 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
290 * This must do 2 things:
291 * -) Provide a way to fetch an entity field value. (Rvalue)
292 * -) Provide a pointer to an entity field. (Lvalue)
294 * In original QC, there's only a STORE via pointer, but
295 * no LOAD via pointer.
296 * So we must know beforehand if we are going to read or assign
298 * For this we will have to extend the codegen() functions with
299 * a flag saying whether or not we need an L or an R-value.
301 struct ast_entfield_s
303 ast_expression_common expression;
304 /* The entity can come from an expression of course. */
305 ast_expression *entity;
306 /* As can the field, it just must result in a value of TYPE_FIELD */
307 ast_expression *field;
309 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
310 ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
311 void ast_entfield_delete(ast_entfield*);
313 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
317 * For now used for vectors. If we get structs or unions
318 * we can have them handled here as well.
322 ast_expression_common expression;
323 ast_expression *owner;
327 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field, const char *name);
328 void ast_member_delete(ast_member*);
329 bool ast_member_set_name(ast_member*, const char *name);
331 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
333 /* Array index access:
335 * QC forces us to take special action on arrays:
336 * an ast_store on an ast_array_index must not codegen the index,
337 * but call its setter - unless we have an instruction set which supports
339 * Any other array index access will be codegened to a call to the getter.
340 * In any case, accessing an element via a compiletime-constant index will
341 * result in quick access to that variable.
343 struct ast_array_index_s
345 ast_expression_common expression;
346 ast_expression *array;
347 ast_expression *index;
349 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
350 void ast_array_index_delete(ast_array_index*);
352 bool ast_array_index_codegen(ast_array_index*, ast_function*, bool lvalue, ir_value**);
356 * Stores left<-right and returns left.
357 * Specialized binary expression node
361 ast_expression_common expression;
363 ast_expression *dest;
364 ast_expression *source;
366 ast_store* ast_store_new(lex_ctx ctx, int op,
367 ast_expression *d, ast_expression *s);
368 void ast_store_delete(ast_store*);
370 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
374 * A general 'if then else' statement, either side can be NULL and will
375 * thus be omitted. It is an error for *both* cases to be NULL at once.
377 * During its 'codegen' it'll be changing the ast_function's block.
379 * An if is also an "expression". Its codegen will put NULL into the
380 * output field though. For ternary expressions an ast_ternary will be
385 ast_expression_common expression;
386 ast_expression *cond;
387 /* It's all just 'expressions', since an ast_block is one too. */
388 ast_expression *on_true;
389 ast_expression *on_false;
391 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
392 void ast_ifthen_delete(ast_ifthen*);
394 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
396 /* Ternary expressions...
398 * Contrary to 'if-then-else' nodes, ternary expressions actually
399 * return a value, otherwise they behave the very same way.
400 * The difference in 'codegen' is that it'll return the value of
403 * The other difference is that in an ast_ternary, NEITHER side
404 * must be NULL, there's ALWAYS an else branch.
406 * This is the only ast_node beside ast_value which contains
407 * an ir_value. Theoretically we don't need to remember it though.
411 ast_expression_common expression;
412 ast_expression *cond;
413 /* It's all just 'expressions', since an ast_block is one too. */
414 ast_expression *on_true;
415 ast_expression *on_false;
417 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
418 void ast_ternary_delete(ast_ternary*);
420 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
422 /* A general loop node
424 * For convenience it contains 4 parts:
425 * -) (ini) = initializing expression
426 * -) (pre) = pre-loop condition
427 * -) (pst) = post-loop condition
428 * -) (inc) = "increment" expression
429 * The following is a psudo-representation of this loop
430 * note that '=>' bears the logical meaning of "implies".
431 * (a => b) equals (!a || b)
434 while (has_pre => {pre})
438 continue: // a 'continue' will jump here
439 if (has_pst => {pst})
447 ast_expression_common expression;
448 ast_expression *initexpr;
449 ast_expression *precond;
450 ast_expression *postcond;
451 ast_expression *increment;
452 ast_expression *body;
453 /* For now we allow a seperate flag on whether or not the condition
454 * is supposed to be true or false.
455 * That way, the parser can generate a 'while not(!x)' for `while(x)`
456 * if desired, which is useful for the new -f{true,false}-empty-strings
462 ast_loop* ast_loop_new(lex_ctx ctx,
463 ast_expression *initexpr,
464 ast_expression *precond, bool pre_not,
465 ast_expression *postcond, bool post_not,
466 ast_expression *increment,
467 ast_expression *body);
468 void ast_loop_delete(ast_loop*);
470 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
474 struct ast_breakcont_s
476 ast_expression_common expression;
480 ast_breakcont* ast_breakcont_new(lex_ctx ctx, bool iscont, unsigned int levels);
481 void ast_breakcont_delete(ast_breakcont*);
483 bool ast_breakcont_codegen(ast_breakcont*, ast_function*, bool lvalue, ir_value**);
487 * A few notes about this: with the original QCVM, no real optimization
488 * is possible. The SWITCH instruction set isn't really helping a lot, since
489 * it only collapes the EQ and IF instructions into one.
490 * Note: Declaring local variables inside caseblocks is normal.
491 * Since we don't have to deal with a stack there's no unnatural behaviour to
492 * be expected from it.
496 ast_expression *value; /* #20 will replace this */
497 ast_expression *code;
501 ast_expression_common expression;
503 ast_expression *operand;
504 ast_switch_case *cases;
507 ast_switch* ast_switch_new(lex_ctx ctx, ast_expression *op);
508 void ast_switch_delete(ast_switch*);
510 bool ast_switch_codegen(ast_switch*, ast_function*, bool lvalue, ir_value**);
514 * Introduce a label which can be used together with 'goto'
518 ast_expression_common expression;
524 ast_label* ast_label_new(lex_ctx ctx, const char *name);
525 void ast_label_delete(ast_label*);
526 void ast_label_register_goto(ast_label*, ast_goto*);
528 bool ast_label_codegen(ast_label*, ast_function*, bool lvalue, ir_value**);
532 * Go to a label, the label node is filled in at a later point!
536 ast_expression_common expression;
539 ir_block *irblock_from;
542 ast_goto* ast_goto_new(lex_ctx ctx, const char *name);
543 void ast_goto_delete(ast_goto*);
544 void ast_goto_set_label(ast_goto*, ast_label*);
546 bool ast_goto_codegen(ast_goto*, ast_function*, bool lvalue, ir_value**);
550 * Contains an ast_expression as target, rather than an ast_function/value.
551 * Since it's how QC works, every ast_function has an ast_value
552 * associated anyway - in other words, the VM contains function
553 * pointers for every function anyway. Thus, this node will call
555 * Additionally it contains a list of ast_expressions as parameters.
556 * Since calls can return values, an ast_call is also an ast_expression.
560 ast_expression_common expression;
561 ast_expression *func;
562 ast_expression* *params;
564 ast_call* ast_call_new(lex_ctx ctx,
565 ast_expression *funcexpr);
566 void ast_call_delete(ast_call*);
567 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
568 bool ast_call_check_types(ast_call*);
575 ast_expression_common expression;
578 ast_expression* *exprs;
579 ast_expression* *collect;
581 ast_block* ast_block_new(lex_ctx ctx);
582 void ast_block_delete(ast_block*);
583 bool ast_block_set_type(ast_block*, ast_expression *from);
585 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
586 void ast_block_collect(ast_block*, ast_expression*);
588 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
592 * Contains a list of blocks... at least in theory.
593 * Usually there's just the main block, other blocks are inside that.
595 * Technically, functions don't need to be an AST node, since we have
596 * neither functions inside functions, nor lambdas, and function
597 * pointers could just work with a name. However, this way could be
598 * more flexible, and adds no real complexity.
600 struct ast_function_s
602 ast_node_common node;
609 ir_function *ir_func;
611 ir_block **breakblocks;
612 ir_block **continueblocks;
615 /* In order for early-out logic not to go over
616 * excessive jumps, we remember their target
624 /* in order for thread safety - for the optional
625 * channel abesed multithreading... keeping a buffer
626 * here to use in ast_function_label.
632 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
633 /* This will NOT delete the underlying ast_value */
634 void ast_function_delete(ast_function*);
635 /* For "optimized" builds this can just keep returning "foo"...
638 const char* ast_function_label(ast_function*, const char *prefix);
640 bool ast_function_codegen(ast_function *self, ir_builder *builder);
641 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
645 union ast_expression_u
647 ast_expression_common expression;
655 ast_entfield entfield;
662 ast_node_common node;
663 ast_expression expression;