2 * Copyright (C) 2012, 2013
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 /* void foo(string...) gets varparam set as a restriction
136 * for variadic parameters
138 ast_expression *varparam;
139 /* The codegen functions should store their output values
140 * so we can call it multiple times without re-evaluating.
141 * Store lvalue and rvalue seperately though. So that
142 * ast_entfield for example can generate both if required.
146 } ast_expression_common;
147 #define AST_FLAG_VARIADIC (1<<0)
148 #define AST_FLAG_NORETURN (1<<1)
149 #define AST_FLAG_INLINE (1<<2)
150 #define AST_FLAG_INITIALIZED (1<<3)
151 #define AST_FLAG_DEPRECATED (1<<4)
152 #define AST_FLAG_INCLUDE_DEF (1<<5)
153 #define AST_FLAG_IS_VARARG (1<<6)
154 #define AST_FLAG_ALIAS (1<<7)
155 #define AST_FLAG_TYPE_MASK (AST_FLAG_VARIADIC | AST_FLAG_NORETURN)
159 * Types are also values, both have a type and a name.
160 * especially considering possible constructs like typedefs.
162 * is like creating a 'float foo', foo serving as the type's name.
166 ast_expression_common expression;
171 const char *argcounter;
178 int cvq; /* const/var qualifier */
179 bool isfield; /* this declares a field */
191 /* usecount for the parser */
195 ir_value **ir_values;
196 size_t ir_value_count;
198 /* ONLY for arrays in progs version up to 6 */
203 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
204 ast_value* ast_value_copy(const ast_value *self);
205 /* This will NOT delete an underlying ast_function */
206 void ast_value_delete(ast_value*);
208 bool ast_value_set_name(ast_value*, const char *name);
210 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
211 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
212 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
214 void ast_value_params_add(ast_value*, ast_value*);
216 bool ast_compare_type(ast_expression *a, ast_expression *b);
217 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
218 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
219 void ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
220 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
222 typedef enum ast_binary_ref_s {
223 AST_REF_LEFT = 1 << 1,
224 AST_REF_RIGHT = 1 << 2,
225 AST_REF_ALL = (AST_REF_LEFT | AST_REF_RIGHT)
231 * A value-returning binary expression.
235 ast_expression_common expression;
238 ast_expression *left;
239 ast_expression *right;
243 ast_binary* ast_binary_new(lex_ctx ctx,
245 ast_expression *left,
246 ast_expression *right);
247 void ast_binary_delete(ast_binary*);
249 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
253 * An assignment including a binary expression with the source as left operand.
254 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
256 struct ast_binstore_s
258 ast_expression_common expression;
262 ast_expression *dest;
263 ast_expression *source;
264 /* for &~= which uses the destination in a binary in source we can use this */
267 ast_binstore* ast_binstore_new(lex_ctx ctx,
270 ast_expression *left,
271 ast_expression *right);
272 void ast_binstore_delete(ast_binstore*);
274 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
278 * Regular unary expressions: not,neg
282 ast_expression_common expression;
285 ast_expression *operand;
287 ast_unary* ast_unary_new(lex_ctx ctx,
289 ast_expression *expr);
290 void ast_unary_delete(ast_unary*);
292 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
296 * Make sure 'return' only happens at the end of a block, otherwise the IR
297 * will refuse to create further instructions.
298 * This should be honored by the parser.
302 ast_expression_common expression;
303 ast_expression *operand;
305 ast_return* ast_return_new(lex_ctx ctx,
306 ast_expression *expr);
307 void ast_return_delete(ast_return*);
309 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
313 * This must do 2 things:
314 * -) Provide a way to fetch an entity field value. (Rvalue)
315 * -) Provide a pointer to an entity field. (Lvalue)
317 * In original QC, there's only a STORE via pointer, but
318 * no LOAD via pointer.
319 * So we must know beforehand if we are going to read or assign
321 * For this we will have to extend the codegen() functions with
322 * a flag saying whether or not we need an L or an R-value.
324 struct ast_entfield_s
326 ast_expression_common expression;
327 /* The entity can come from an expression of course. */
328 ast_expression *entity;
329 /* As can the field, it just must result in a value of TYPE_FIELD */
330 ast_expression *field;
332 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
333 ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
334 void ast_entfield_delete(ast_entfield*);
336 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
340 * For now used for vectors. If we get structs or unions
341 * we can have them handled here as well.
345 ast_expression_common expression;
346 ast_expression *owner;
351 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field, const char *name);
352 void ast_member_delete(ast_member*);
353 bool ast_member_set_name(ast_member*, const char *name);
355 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
357 /* Array index access:
359 * QC forces us to take special action on arrays:
360 * an ast_store on an ast_array_index must not codegen the index,
361 * but call its setter - unless we have an instruction set which supports
363 * Any other array index access will be codegened to a call to the getter.
364 * In any case, accessing an element via a compiletime-constant index will
365 * result in quick access to that variable.
367 struct ast_array_index_s
369 ast_expression_common expression;
370 ast_expression *array;
371 ast_expression *index;
373 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
374 void ast_array_index_delete(ast_array_index*);
376 bool ast_array_index_codegen(ast_array_index*, ast_function*, bool lvalue, ir_value**);
380 * Stores left<-right and returns left.
381 * Specialized binary expression node
385 ast_expression_common expression;
387 ast_expression *dest;
388 ast_expression *source;
390 ast_store* ast_store_new(lex_ctx ctx, int op,
391 ast_expression *d, ast_expression *s);
392 void ast_store_delete(ast_store*);
394 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
398 * A general 'if then else' statement, either side can be NULL and will
399 * thus be omitted. It is an error for *both* cases to be NULL at once.
401 * During its 'codegen' it'll be changing the ast_function's block.
403 * An if is also an "expression". Its codegen will put NULL into the
404 * output field though. For ternary expressions an ast_ternary will be
409 ast_expression_common expression;
410 ast_expression *cond;
411 /* It's all just 'expressions', since an ast_block is one too. */
412 ast_expression *on_true;
413 ast_expression *on_false;
415 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
416 void ast_ifthen_delete(ast_ifthen*);
418 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
420 /* Ternary expressions...
422 * Contrary to 'if-then-else' nodes, ternary expressions actually
423 * return a value, otherwise they behave the very same way.
424 * The difference in 'codegen' is that it'll return the value of
427 * The other difference is that in an ast_ternary, NEITHER side
428 * must be NULL, there's ALWAYS an else branch.
430 * This is the only ast_node beside ast_value which contains
431 * an ir_value. Theoretically we don't need to remember it though.
435 ast_expression_common expression;
436 ast_expression *cond;
437 /* It's all just 'expressions', since an ast_block is one too. */
438 ast_expression *on_true;
439 ast_expression *on_false;
441 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
442 void ast_ternary_delete(ast_ternary*);
444 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
446 /* A general loop node
448 * For convenience it contains 4 parts:
449 * -) (ini) = initializing expression
450 * -) (pre) = pre-loop condition
451 * -) (pst) = post-loop condition
452 * -) (inc) = "increment" expression
453 * The following is a psudo-representation of this loop
454 * note that '=>' bears the logical meaning of "implies".
455 * (a => b) equals (!a || b)
458 while (has_pre => {pre})
462 continue: // a 'continue' will jump here
463 if (has_pst => {pst})
471 ast_expression_common expression;
472 ast_expression *initexpr;
473 ast_expression *precond;
474 ast_expression *postcond;
475 ast_expression *increment;
476 ast_expression *body;
477 /* For now we allow a seperate flag on whether or not the condition
478 * is supposed to be true or false.
479 * That way, the parser can generate a 'while not(!x)' for `while(x)`
480 * if desired, which is useful for the new -f{true,false}-empty-strings
486 ast_loop* ast_loop_new(lex_ctx ctx,
487 ast_expression *initexpr,
488 ast_expression *precond, bool pre_not,
489 ast_expression *postcond, bool post_not,
490 ast_expression *increment,
491 ast_expression *body);
492 void ast_loop_delete(ast_loop*);
494 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
498 struct ast_breakcont_s
500 ast_expression_common expression;
504 ast_breakcont* ast_breakcont_new(lex_ctx ctx, bool iscont, unsigned int levels);
505 void ast_breakcont_delete(ast_breakcont*);
507 bool ast_breakcont_codegen(ast_breakcont*, ast_function*, bool lvalue, ir_value**);
511 * A few notes about this: with the original QCVM, no real optimization
512 * is possible. The SWITCH instruction set isn't really helping a lot, since
513 * it only collapes the EQ and IF instructions into one.
514 * Note: Declaring local variables inside caseblocks is normal.
515 * Since we don't have to deal with a stack there's no unnatural behaviour to
516 * be expected from it.
520 ast_expression *value; /* #20 will replace this */
521 ast_expression *code;
525 ast_expression_common expression;
527 ast_expression *operand;
528 ast_switch_case *cases;
531 ast_switch* ast_switch_new(lex_ctx ctx, ast_expression *op);
532 void ast_switch_delete(ast_switch*);
534 bool ast_switch_codegen(ast_switch*, ast_function*, bool lvalue, ir_value**);
538 * Introduce a label which can be used together with 'goto'
542 ast_expression_common expression;
546 /* means it has not yet been defined */
550 ast_label* ast_label_new(lex_ctx ctx, const char *name, bool undefined);
551 void ast_label_delete(ast_label*);
552 void ast_label_register_goto(ast_label*, ast_goto*);
554 bool ast_label_codegen(ast_label*, ast_function*, bool lvalue, ir_value**);
558 * Go to a label, the label node is filled in at a later point!
562 ast_expression_common expression;
565 ir_block *irblock_from;
568 ast_goto* ast_goto_new(lex_ctx ctx, const char *name);
569 void ast_goto_delete(ast_goto*);
570 void ast_goto_set_label(ast_goto*, ast_label*);
572 bool ast_goto_codegen(ast_goto*, ast_function*, bool lvalue, ir_value**);
576 * Contains an ast_expression as target, rather than an ast_function/value.
577 * Since it's how QC works, every ast_function has an ast_value
578 * associated anyway - in other words, the VM contains function
579 * pointers for every function anyway. Thus, this node will call
581 * Additionally it contains a list of ast_expressions as parameters.
582 * Since calls can return values, an ast_call is also an ast_expression.
586 ast_expression_common expression;
587 ast_expression *func;
588 ast_expression* *params;
589 ast_expression *va_count;
591 ast_call* ast_call_new(lex_ctx ctx,
592 ast_expression *funcexpr);
593 void ast_call_delete(ast_call*);
594 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
595 bool ast_call_check_types(ast_call*);
602 ast_expression_common expression;
605 ast_expression* *exprs;
606 ast_expression* *collect;
608 ast_block* ast_block_new(lex_ctx ctx);
609 void ast_block_delete(ast_block*);
610 void ast_block_set_type(ast_block*, ast_expression *from);
612 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
613 void ast_block_collect(ast_block*, ast_expression*);
615 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
619 * Contains a list of blocks... at least in theory.
620 * Usually there's just the main block, other blocks are inside that.
622 * Technically, functions don't need to be an AST node, since we have
623 * neither functions inside functions, nor lambdas, and function
624 * pointers could just work with a name. However, this way could be
625 * more flexible, and adds no real complexity.
627 struct ast_function_s
629 ast_node_common node;
636 ir_function *ir_func;
638 ir_block **breakblocks;
639 ir_block **continueblocks;
642 /* In order for early-out logic not to go over
643 * excessive jumps, we remember their target
651 /* in order for thread safety - for the optional
652 * channel abesed multithreading... keeping a buffer
653 * here to use in ast_function_label.
661 ast_value *fixedparams;
663 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
664 /* This will NOT delete the underlying ast_value */
665 void ast_function_delete(ast_function*);
666 /* For "optimized" builds this can just keep returning "foo"...
669 const char* ast_function_label(ast_function*, const char *prefix);
671 bool ast_function_codegen(ast_function *self, ir_builder *builder);
672 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
676 union ast_expression_u
678 ast_expression_common expression;
686 ast_entfield entfield;
693 ast_node_common node;
694 ast_expression expression;