2 * Copyright (C) 2012, 2013
6 * Permission is hereby granted, free of charge, to any person obtaining a copy of
7 * this software and associated documentation files (the "Software"), to deal in
8 * the Software without restriction, including without limitation the rights to
9 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10 * of the Software, and to permit persons to whom the Software is furnished to do
11 * so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 /* Note: I will not be using a _t suffix for the
29 * "main" ast node types for now.
32 typedef struct ast_node_common ast_node;
33 typedef struct ast_expression_common ast_expression;
35 typedef struct ast_value_s ast_value;
36 typedef struct ast_function_s ast_function;
37 typedef struct ast_block_s ast_block;
38 typedef struct ast_binary_s ast_binary;
39 typedef struct ast_store_s ast_store;
40 typedef struct ast_binstore_s ast_binstore;
41 typedef struct ast_entfield_s ast_entfield;
42 typedef struct ast_ifthen_s ast_ifthen;
43 typedef struct ast_ternary_s ast_ternary;
44 typedef struct ast_loop_s ast_loop;
45 typedef struct ast_call_s ast_call;
46 typedef struct ast_unary_s ast_unary;
47 typedef struct ast_return_s ast_return;
48 typedef struct ast_member_s ast_member;
49 typedef struct ast_array_index_s ast_array_index;
50 typedef struct ast_breakcont_s ast_breakcont;
51 typedef struct ast_switch_s ast_switch;
52 typedef struct ast_label_s ast_label;
53 typedef struct ast_goto_s ast_goto;
54 typedef struct ast_argpipe_s ast_argpipe;
57 TYPE_ast_node, /* 0 */
58 TYPE_ast_expression, /* 1 */
59 TYPE_ast_value, /* 2 */
60 TYPE_ast_function, /* 3 */
61 TYPE_ast_block, /* 4 */
62 TYPE_ast_binary, /* 5 */
63 TYPE_ast_store, /* 6 */
64 TYPE_ast_binstore, /* 7 */
65 TYPE_ast_entfield, /* 8 */
66 TYPE_ast_ifthen, /* 9 */
67 TYPE_ast_ternary, /* 10 */
68 TYPE_ast_loop, /* 11 */
69 TYPE_ast_call, /* 12 */
70 TYPE_ast_unary, /* 13 */
71 TYPE_ast_return, /* 14 */
72 TYPE_ast_member, /* 15 */
73 TYPE_ast_array_index, /* 16 */
74 TYPE_ast_breakcont, /* 17 */
75 TYPE_ast_switch, /* 18 */
76 TYPE_ast_label, /* 19 */
77 TYPE_ast_goto, /* 20 */
78 TYPE_ast_argpipe /* 21 */
81 #define ast_istype(x, t) ( ((ast_node*)x)->nodetype == (TYPE_##t) )
82 #define ast_ctx(node) (((ast_node*)(node))->context)
83 #define ast_side_effects(node) (((ast_node*)(node))->side_effects)
85 /* Node interface with common components
87 typedef void ast_node_delete(ast_node*);
88 struct ast_node_common
91 /* I don't feel comfortable using keywords like 'delete' as names... */
92 ast_node_delete *destroy;
94 /* keep: if a node contains this node, 'keep'
95 * prevents its dtor from destroying this node as well.
101 #define ast_delete(x) (*( ((ast_node*)(x))->destroy ))((ast_node*)(x))
102 #define ast_unref(x) do \
104 if (! (((ast_node*)(x))->keep) ) { \
109 /* Expression interface
111 * Any expression or block returns an ir_value, and needs
112 * to know the current function.
114 typedef bool ast_expression_codegen(ast_expression*,
118 /* TODO: the codegen function should take an output-type parameter
119 * indicating whether a variable, type, label etc. is expected, and
121 * Then later an ast_ident could have a codegen using this to figure
122 * out what to look for.
123 * eg. in code which uses a not-yet defined variable, the expression
124 * would take an ast_ident, and the codegen would be called with
125 * type `expression`, so the ast_ident's codegen would search for
126 * variables through the environment (or functions, constants...).
128 struct ast_expression_common
131 ast_expression_codegen *codegen;
133 ast_expression *next;
134 /* arrays get a member-count */
138 /* void foo(string...) gets varparam set as a restriction
139 * for variadic parameters
141 ast_expression *varparam;
142 /* The codegen functions should store their output values
143 * so we can call it multiple times without re-evaluating.
144 * Store lvalue and rvalue seperately though. So that
145 * ast_entfield for example can generate both if required.
150 #define AST_FLAG_VARIADIC (1<<0)
151 #define AST_FLAG_NORETURN (1<<1)
152 #define AST_FLAG_INLINE (1<<2)
153 #define AST_FLAG_INITIALIZED (1<<3)
154 #define AST_FLAG_DEPRECATED (1<<4)
155 #define AST_FLAG_INCLUDE_DEF (1<<5)
156 #define AST_FLAG_IS_VARARG (1<<6)
157 #define AST_FLAG_ALIAS (1<<7)
158 #define AST_FLAG_ERASEABLE (1<<8)
159 #define AST_FLAG_ACCUMULATE (1<<9)
161 * An array declared as []
162 * so that the size is taken from the initializer
164 #define AST_FLAG_ARRAY_INIT (1<<10)
165 #define AST_FLAG_TYPE_MASK (AST_FLAG_VARIADIC | AST_FLAG_NORETURN)
169 * Types are also values, both have a type and a name.
170 * especially considering possible constructs like typedefs.
172 * is like creating a 'float foo', foo serving as the type's name.
186 ast_expression expression;
191 const char *argcounter;
193 int cvq; /* const/var qualifier */
194 bool isfield; /* this declares a field */
195 bool isimm; /* an immediate, not just const */
197 basic_value_t constval;
198 /* for TYPE_ARRAY we have an optional vector
199 * of constants when an initializer list
202 basic_value_t *initlist;
204 /* usecount for the parser */
208 ir_value **ir_values;
209 size_t ir_value_count;
211 /* ONLY for arrays in progs version up to 6 */
216 bool intrinsic; /* true if associated with intrinsic */
219 ast_value* ast_value_new(lex_ctx_t ctx, const char *name, int qctype);
220 ast_value* ast_value_copy(const ast_value *self);
221 /* This will NOT delete an underlying ast_function */
222 void ast_value_delete(ast_value*);
224 bool ast_value_set_name(ast_value*, const char *name);
227 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
228 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
231 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
233 void ast_value_params_add(ast_value*, ast_value*);
235 bool ast_compare_type(ast_expression *a, ast_expression *b);
236 ast_expression* ast_type_copy(lex_ctx_t ctx, const ast_expression *ex);
237 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
238 void ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
239 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
241 typedef enum ast_binary_ref_s {
243 AST_REF_LEFT = 1 << 1,
244 AST_REF_RIGHT = 1 << 2,
245 AST_REF_ALL = (AST_REF_LEFT | AST_REF_RIGHT)
251 * A value-returning binary expression.
255 ast_expression expression;
258 ast_expression *left;
259 ast_expression *right;
263 ast_binary* ast_binary_new(lex_ctx_t ctx,
265 ast_expression *left,
266 ast_expression *right);
270 * An assignment including a binary expression with the source as left operand.
271 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
273 struct ast_binstore_s
275 ast_expression expression;
279 ast_expression *dest;
280 ast_expression *source;
281 /* for &~= which uses the destination in a binary in source we can use this */
284 ast_binstore* ast_binstore_new(lex_ctx_t ctx,
287 ast_expression *left,
288 ast_expression *right);
292 * Regular unary expressions: not,neg
296 ast_expression expression;
299 ast_expression *operand;
301 ast_unary* ast_unary_new(lex_ctx_t ctx,
303 ast_expression *expr);
307 * Make sure 'return' only happens at the end of a block, otherwise the IR
308 * will refuse to create further instructions.
309 * This should be honored by the parser.
313 ast_expression expression;
314 ast_expression *operand;
316 ast_return* ast_return_new(lex_ctx_t ctx,
317 ast_expression *expr);
321 * This must do 2 things:
322 * -) Provide a way to fetch an entity field value. (Rvalue)
323 * -) Provide a pointer to an entity field. (Lvalue)
325 * In original QC, there's only a STORE via pointer, but
326 * no LOAD via pointer.
327 * So we must know beforehand if we are going to read or assign
329 * For this we will have to extend the codegen() functions with
330 * a flag saying whether or not we need an L or an R-value.
332 struct ast_entfield_s
334 ast_expression expression;
335 /* The entity can come from an expression of course. */
336 ast_expression *entity;
337 /* As can the field, it just must result in a value of TYPE_FIELD */
338 ast_expression *field;
340 ast_entfield* ast_entfield_new(lex_ctx_t ctx, ast_expression *entity, ast_expression *field);
341 ast_entfield* ast_entfield_new_force(lex_ctx_t ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
345 * For now used for vectors. If we get structs or unions
346 * we can have them handled here as well.
350 ast_expression expression;
351 ast_expression *owner;
356 ast_member* ast_member_new(lex_ctx_t ctx, ast_expression *owner, unsigned int field, const char *name);
357 void ast_member_delete(ast_member*);
358 bool ast_member_set_name(ast_member*, const char *name);
361 /* Array index access:
363 * QC forces us to take special action on arrays:
364 * an ast_store on an ast_array_index must not codegen the index,
365 * but call its setter - unless we have an instruction set which supports
367 * Any other array index access will be codegened to a call to the getter.
368 * In any case, accessing an element via a compiletime-constant index will
369 * result in quick access to that variable.
371 struct ast_array_index_s
373 ast_expression expression;
374 ast_expression *array;
375 ast_expression *index;
377 ast_array_index* ast_array_index_new(lex_ctx_t ctx, ast_expression *array, ast_expression *index);
381 * copy all varargs starting from a specific index
385 ast_expression expression;
386 ast_expression *index;
388 ast_argpipe* ast_argpipe_new(lex_ctx_t ctx, ast_expression *index);
392 * Stores left<-right and returns left.
393 * Specialized binary expression node
397 ast_expression expression;
399 ast_expression *dest;
400 ast_expression *source;
402 ast_store* ast_store_new(lex_ctx_t ctx, int op,
403 ast_expression *d, ast_expression *s);
407 * A general 'if then else' statement, either side can be NULL and will
408 * thus be omitted. It is an error for *both* cases to be NULL at once.
410 * During its 'codegen' it'll be changing the ast_function's block.
412 * An if is also an "expression". Its codegen will put NULL into the
413 * output field though. For ternary expressions an ast_ternary will be
418 ast_expression expression;
419 ast_expression *cond;
420 /* It's all just 'expressions', since an ast_block is one too. */
421 ast_expression *on_true;
422 ast_expression *on_false;
424 ast_ifthen* ast_ifthen_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
426 /* Ternary expressions...
428 * Contrary to 'if-then-else' nodes, ternary expressions actually
429 * return a value, otherwise they behave the very same way.
430 * The difference in 'codegen' is that it'll return the value of
433 * The other difference is that in an ast_ternary, NEITHER side
434 * must be NULL, there's ALWAYS an else branch.
436 * This is the only ast_node beside ast_value which contains
437 * an ir_value. Theoretically we don't need to remember it though.
441 ast_expression expression;
442 ast_expression *cond;
443 /* It's all just 'expressions', since an ast_block is one too. */
444 ast_expression *on_true;
445 ast_expression *on_false;
447 ast_ternary* ast_ternary_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
449 /* A general loop node
451 * For convenience it contains 4 parts:
452 * -) (ini) = initializing expression
453 * -) (pre) = pre-loop condition
454 * -) (pst) = post-loop condition
455 * -) (inc) = "increment" expression
456 * The following is a psudo-representation of this loop
457 * note that '=>' bears the logical meaning of "implies".
458 * (a => b) equals (!a || b)
461 while (has_pre => {pre})
465 continue: // a 'continue' will jump here
466 if (has_pst => {pst})
474 ast_expression expression;
475 ast_expression *initexpr;
476 ast_expression *precond;
477 ast_expression *postcond;
478 ast_expression *increment;
479 ast_expression *body;
480 /* For now we allow a seperate flag on whether or not the condition
481 * is supposed to be true or false.
482 * That way, the parser can generate a 'while not(!x)' for `while(x)`
483 * if desired, which is useful for the new -f{true,false}-empty-strings
489 ast_loop* ast_loop_new(lex_ctx_t ctx,
490 ast_expression *initexpr,
491 ast_expression *precond, bool pre_not,
492 ast_expression *postcond, bool post_not,
493 ast_expression *increment,
494 ast_expression *body);
498 struct ast_breakcont_s
500 ast_expression expression;
504 ast_breakcont* ast_breakcont_new(lex_ctx_t ctx, bool iscont, unsigned int levels);
508 * A few notes about this: with the original QCVM, no real optimization
509 * is possible. The SWITCH instruction set isn't really helping a lot, since
510 * it only collapes the EQ and IF instructions into one.
511 * Note: Declaring local variables inside caseblocks is normal.
512 * Since we don't have to deal with a stack there's no unnatural behaviour to
513 * be expected from it.
517 ast_expression *value; /* #20 will replace this */
518 ast_expression *code;
522 ast_expression expression;
524 ast_expression *operand;
525 ast_switch_case *cases;
528 ast_switch* ast_switch_new(lex_ctx_t ctx, ast_expression *op);
532 * Introduce a label which can be used together with 'goto'
536 ast_expression expression;
541 /* means it has not yet been defined */
545 ast_label* ast_label_new(lex_ctx_t ctx, const char *name, bool undefined);
549 * Go to a label, the label node is filled in at a later point!
553 ast_expression expression;
556 ir_block *irblock_from;
559 ast_goto* ast_goto_new(lex_ctx_t ctx, const char *name);
560 void ast_goto_set_label(ast_goto*, ast_label*);
564 * Contains an ast_expression as target, rather than an ast_function/value.
565 * Since it's how QC works, every ast_function has an ast_value
566 * associated anyway - in other words, the VM contains function
567 * pointers for every function anyway. Thus, this node will call
569 * Additionally it contains a list of ast_expressions as parameters.
570 * Since calls can return values, an ast_call is also an ast_expression.
574 ast_expression expression;
575 ast_expression *func;
576 ast_expression **params;
577 ast_expression *va_count;
579 ast_call* ast_call_new(lex_ctx_t ctx,
580 ast_expression *funcexpr);
581 bool ast_call_check_types(ast_call*, ast_expression *this_func_va_type);
588 ast_expression expression;
591 ast_expression* *exprs;
592 ast_expression* *collect;
594 ast_block* ast_block_new(lex_ctx_t ctx);
595 void ast_block_delete(ast_block*);
596 void ast_block_set_type(ast_block*, ast_expression *from);
597 void ast_block_collect(ast_block*, ast_expression*);
599 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
603 * Contains a list of blocks... at least in theory.
604 * Usually there's just the main block, other blocks are inside that.
606 * Technically, functions don't need to be an AST node, since we have
607 * neither functions inside functions, nor lambdas, and function
608 * pointers could just work with a name. However, this way could be
609 * more flexible, and adds no real complexity.
611 struct ast_function_s
620 /* function accumulation */
621 ast_function *accumulate; /* pointer to the next function in the chain */
622 size_t accumulation; /* base functions # of accumulations */
624 ir_function *ir_func;
626 ir_block **breakblocks;
627 ir_block **continueblocks;
630 /* In order for early-out logic not to go over
631 * excessive jumps, we remember their target
639 /* in order for thread safety - for the optional
640 * channel abesed multithreading... keeping a buffer
641 * here to use in ast_function_label.
649 ast_value *fixedparams;
650 ast_value *return_value;
652 ast_function* ast_function_new(lex_ctx_t ctx, const char *name, ast_value *vtype);
653 /* This will NOT delete the underlying ast_value */
654 void ast_function_delete(ast_function*);
655 /* For "optimized" builds this can just keep returning "foo"...
658 const char* ast_function_label(ast_function*, const char *prefix);
660 bool ast_function_codegen(ast_function *self, ir_builder *builder);
661 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);