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 typedef uint16_t ast_flag_t;
30 /* Note: I will not be using a _t suffix for the
31 * "main" ast node types for now.
34 typedef struct ast_node_common ast_node;
35 typedef struct ast_expression_common ast_expression;
37 typedef struct ast_value_s ast_value;
38 typedef struct ast_function_s ast_function;
39 typedef struct ast_block_s ast_block;
40 typedef struct ast_binary_s ast_binary;
41 typedef struct ast_store_s ast_store;
42 typedef struct ast_binstore_s ast_binstore;
43 typedef struct ast_entfield_s ast_entfield;
44 typedef struct ast_ifthen_s ast_ifthen;
45 typedef struct ast_ternary_s ast_ternary;
46 typedef struct ast_loop_s ast_loop;
47 typedef struct ast_call_s ast_call;
48 typedef struct ast_unary_s ast_unary;
49 typedef struct ast_return_s ast_return;
50 typedef struct ast_member_s ast_member;
51 typedef struct ast_array_index_s ast_array_index;
52 typedef struct ast_breakcont_s ast_breakcont;
53 typedef struct ast_switch_s ast_switch;
54 typedef struct ast_label_s ast_label;
55 typedef struct ast_goto_s ast_goto;
56 typedef struct ast_argpipe_s ast_argpipe;
59 AST_FLAG_VARIADIC = 1 << 0,
60 AST_FLAG_NORETURN = 1 << 1,
61 AST_FLAG_INLINE = 1 << 2,
62 AST_FLAG_INITIALIZED = 1 << 3,
63 AST_FLAG_DEPRECATED = 1 << 4,
64 AST_FLAG_INCLUDE_DEF = 1 << 5,
65 AST_FLAG_IS_VARARG = 1 << 6,
66 AST_FLAG_ALIAS = 1 << 7,
67 AST_FLAG_ERASEABLE = 1 << 8,
68 AST_FLAG_ACCUMULATE = 1 << 9,
71 * An array declared as []
72 * so that the size is taken from the initializer
74 AST_FLAG_ARRAY_INIT = 1 << 10,
76 AST_FLAG_FINAL_DECL = 1 << 11,
79 AST_FLAG_TYPE_MASK = (AST_FLAG_VARIADIC | AST_FLAG_NORETURN)
83 TYPE_ast_node, /* 0 */
84 TYPE_ast_expression, /* 1 */
85 TYPE_ast_value, /* 2 */
86 TYPE_ast_function, /* 3 */
87 TYPE_ast_block, /* 4 */
88 TYPE_ast_binary, /* 5 */
89 TYPE_ast_store, /* 6 */
90 TYPE_ast_binstore, /* 7 */
91 TYPE_ast_entfield, /* 8 */
92 TYPE_ast_ifthen, /* 9 */
93 TYPE_ast_ternary, /* 10 */
94 TYPE_ast_loop, /* 11 */
95 TYPE_ast_call, /* 12 */
96 TYPE_ast_unary, /* 13 */
97 TYPE_ast_return, /* 14 */
98 TYPE_ast_member, /* 15 */
99 TYPE_ast_array_index, /* 16 */
100 TYPE_ast_breakcont, /* 17 */
101 TYPE_ast_switch, /* 18 */
102 TYPE_ast_label, /* 19 */
103 TYPE_ast_goto, /* 20 */
104 TYPE_ast_argpipe /* 21 */
107 #define ast_istype(x, t) ( ((ast_node*)x)->nodetype == (TYPE_##t) )
108 #define ast_ctx(node) (((ast_node*)(node))->context)
109 #define ast_side_effects(node) (((ast_node*)(node))->side_effects)
111 /* Node interface with common components
113 typedef void ast_node_delete(ast_node*);
114 struct ast_node_common
117 /* I don't feel comfortable using keywords like 'delete' as names... */
118 ast_node_delete *destroy;
120 /* keep: if a node contains this node, 'keep'
121 * prevents its dtor from destroying this node as well.
127 #define ast_delete(x) (*( ((ast_node*)(x))->destroy ))((ast_node*)(x))
128 #define ast_unref(x) do \
130 if (! (((ast_node*)(x))->keep) ) { \
135 /* Expression interface
137 * Any expression or block returns an ir_value, and needs
138 * to know the current function.
140 typedef bool ast_expression_codegen(ast_expression*,
144 /* TODO: the codegen function should take an output-type parameter
145 * indicating whether a variable, type, label etc. is expected, and
147 * Then later an ast_ident could have a codegen using this to figure
148 * out what to look for.
149 * eg. in code which uses a not-yet defined variable, the expression
150 * would take an ast_ident, and the codegen would be called with
151 * type `expression`, so the ast_ident's codegen would search for
152 * variables through the environment (or functions, constants...).
154 struct ast_expression_common
157 ast_expression_codegen *codegen;
159 ast_expression *next;
160 /* arrays get a member-count */
164 /* void foo(string...) gets varparam set as a restriction
165 * for variadic parameters
167 ast_expression *varparam;
168 /* The codegen functions should store their output values
169 * so we can call it multiple times without re-evaluating.
170 * Store lvalue and rvalue seperately though. So that
171 * ast_entfield for example can generate both if required.
179 * Types are also values, both have a type and a name.
180 * especially considering possible constructs like typedefs.
182 * is like creating a 'float foo', foo serving as the type's name.
196 ast_expression expression;
201 const char *argcounter;
203 int cvq; /* const/var qualifier */
204 bool isfield; /* this declares a field */
205 bool isimm; /* an immediate, not just const */
207 basic_value_t constval;
208 /* for TYPE_ARRAY we have an optional vector
209 * of constants when an initializer list
212 basic_value_t *initlist;
214 /* usecount for the parser */
218 ir_value **ir_values;
219 size_t ir_value_count;
221 /* ONLY for arrays in progs version up to 6 */
226 bool intrinsic; /* true if associated with intrinsic */
229 ast_value* ast_value_new(lex_ctx_t ctx, const char *name, int qctype);
230 ast_value* ast_value_copy(const ast_value *self);
231 /* This will NOT delete an underlying ast_function */
232 void ast_value_delete(ast_value*);
234 bool ast_value_set_name(ast_value*, const char *name);
237 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
238 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
241 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
243 void ast_value_params_add(ast_value*, ast_value*);
245 bool ast_compare_type(ast_expression *a, ast_expression *b);
246 ast_expression* ast_type_copy(lex_ctx_t ctx, const ast_expression *ex);
247 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
248 void ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
249 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
251 typedef enum ast_binary_ref_s {
253 AST_REF_LEFT = 1 << 1,
254 AST_REF_RIGHT = 1 << 2,
255 AST_REF_ALL = (AST_REF_LEFT | AST_REF_RIGHT)
261 * A value-returning binary expression.
265 ast_expression expression;
268 ast_expression *left;
269 ast_expression *right;
273 ast_binary* ast_binary_new(lex_ctx_t ctx,
275 ast_expression *left,
276 ast_expression *right);
280 * An assignment including a binary expression with the source as left operand.
281 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
283 struct ast_binstore_s
285 ast_expression expression;
289 ast_expression *dest;
290 ast_expression *source;
291 /* for &~= which uses the destination in a binary in source we can use this */
294 ast_binstore* ast_binstore_new(lex_ctx_t ctx,
297 ast_expression *left,
298 ast_expression *right);
302 * Regular unary expressions: not,neg
306 ast_expression expression;
309 ast_expression *operand;
311 ast_unary* ast_unary_new(lex_ctx_t ctx,
313 ast_expression *expr);
317 * Make sure 'return' only happens at the end of a block, otherwise the IR
318 * will refuse to create further instructions.
319 * This should be honored by the parser.
323 ast_expression expression;
324 ast_expression *operand;
326 ast_return* ast_return_new(lex_ctx_t ctx,
327 ast_expression *expr);
331 * This must do 2 things:
332 * -) Provide a way to fetch an entity field value. (Rvalue)
333 * -) Provide a pointer to an entity field. (Lvalue)
335 * In original QC, there's only a STORE via pointer, but
336 * no LOAD via pointer.
337 * So we must know beforehand if we are going to read or assign
339 * For this we will have to extend the codegen() functions with
340 * a flag saying whether or not we need an L or an R-value.
342 struct ast_entfield_s
344 ast_expression expression;
345 /* The entity can come from an expression of course. */
346 ast_expression *entity;
347 /* As can the field, it just must result in a value of TYPE_FIELD */
348 ast_expression *field;
350 ast_entfield* ast_entfield_new(lex_ctx_t ctx, ast_expression *entity, ast_expression *field);
351 ast_entfield* ast_entfield_new_force(lex_ctx_t ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
355 * For now used for vectors. If we get structs or unions
356 * we can have them handled here as well.
360 ast_expression expression;
361 ast_expression *owner;
366 ast_member* ast_member_new(lex_ctx_t ctx, ast_expression *owner, unsigned int field, const char *name);
367 void ast_member_delete(ast_member*);
368 bool ast_member_set_name(ast_member*, const char *name);
371 /* Array index access:
373 * QC forces us to take special action on arrays:
374 * an ast_store on an ast_array_index must not codegen the index,
375 * but call its setter - unless we have an instruction set which supports
377 * Any other array index access will be codegened to a call to the getter.
378 * In any case, accessing an element via a compiletime-constant index will
379 * result in quick access to that variable.
381 struct ast_array_index_s
383 ast_expression expression;
384 ast_expression *array;
385 ast_expression *index;
387 ast_array_index* ast_array_index_new(lex_ctx_t ctx, ast_expression *array, ast_expression *index);
391 * copy all varargs starting from a specific index
395 ast_expression expression;
396 ast_expression *index;
398 ast_argpipe* ast_argpipe_new(lex_ctx_t ctx, ast_expression *index);
402 * Stores left<-right and returns left.
403 * Specialized binary expression node
407 ast_expression expression;
409 ast_expression *dest;
410 ast_expression *source;
412 ast_store* ast_store_new(lex_ctx_t ctx, int op,
413 ast_expression *d, ast_expression *s);
417 * A general 'if then else' statement, either side can be NULL and will
418 * thus be omitted. It is an error for *both* cases to be NULL at once.
420 * During its 'codegen' it'll be changing the ast_function's block.
422 * An if is also an "expression". Its codegen will put NULL into the
423 * output field though. For ternary expressions an ast_ternary will be
428 ast_expression expression;
429 ast_expression *cond;
430 /* It's all just 'expressions', since an ast_block is one too. */
431 ast_expression *on_true;
432 ast_expression *on_false;
434 ast_ifthen* ast_ifthen_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
436 /* Ternary expressions...
438 * Contrary to 'if-then-else' nodes, ternary expressions actually
439 * return a value, otherwise they behave the very same way.
440 * The difference in 'codegen' is that it'll return the value of
443 * The other difference is that in an ast_ternary, NEITHER side
444 * must be NULL, there's ALWAYS an else branch.
446 * This is the only ast_node beside ast_value which contains
447 * an ir_value. Theoretically we don't need to remember it though.
451 ast_expression expression;
452 ast_expression *cond;
453 /* It's all just 'expressions', since an ast_block is one too. */
454 ast_expression *on_true;
455 ast_expression *on_false;
457 ast_ternary* ast_ternary_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
459 /* A general loop node
461 * For convenience it contains 4 parts:
462 * -) (ini) = initializing expression
463 * -) (pre) = pre-loop condition
464 * -) (pst) = post-loop condition
465 * -) (inc) = "increment" expression
466 * The following is a psudo-representation of this loop
467 * note that '=>' bears the logical meaning of "implies".
468 * (a => b) equals (!a || b)
471 while (has_pre => {pre})
475 continue: // a 'continue' will jump here
476 if (has_pst => {pst})
484 ast_expression expression;
485 ast_expression *initexpr;
486 ast_expression *precond;
487 ast_expression *postcond;
488 ast_expression *increment;
489 ast_expression *body;
490 /* For now we allow a seperate flag on whether or not the condition
491 * is supposed to be true or false.
492 * That way, the parser can generate a 'while not(!x)' for `while(x)`
493 * if desired, which is useful for the new -f{true,false}-empty-strings
499 ast_loop* ast_loop_new(lex_ctx_t ctx,
500 ast_expression *initexpr,
501 ast_expression *precond, bool pre_not,
502 ast_expression *postcond, bool post_not,
503 ast_expression *increment,
504 ast_expression *body);
508 struct ast_breakcont_s
510 ast_expression expression;
514 ast_breakcont* ast_breakcont_new(lex_ctx_t ctx, bool iscont, unsigned int levels);
518 * A few notes about this: with the original QCVM, no real optimization
519 * is possible. The SWITCH instruction set isn't really helping a lot, since
520 * it only collapes the EQ and IF instructions into one.
521 * Note: Declaring local variables inside caseblocks is normal.
522 * Since we don't have to deal with a stack there's no unnatural behaviour to
523 * be expected from it.
527 ast_expression *value; /* #20 will replace this */
528 ast_expression *code;
532 ast_expression expression;
534 ast_expression *operand;
535 ast_switch_case *cases;
538 ast_switch* ast_switch_new(lex_ctx_t ctx, ast_expression *op);
542 * Introduce a label which can be used together with 'goto'
546 ast_expression expression;
551 /* means it has not yet been defined */
555 ast_label* ast_label_new(lex_ctx_t ctx, const char *name, bool undefined);
559 * Go to a label, the label node is filled in at a later point!
563 ast_expression expression;
566 ir_block *irblock_from;
569 ast_goto* ast_goto_new(lex_ctx_t ctx, const char *name);
570 void ast_goto_set_label(ast_goto*, ast_label*);
574 * Contains an ast_expression as target, rather than an ast_function/value.
575 * Since it's how QC works, every ast_function has an ast_value
576 * associated anyway - in other words, the VM contains function
577 * pointers for every function anyway. Thus, this node will call
579 * Additionally it contains a list of ast_expressions as parameters.
580 * Since calls can return values, an ast_call is also an ast_expression.
584 ast_expression expression;
585 ast_expression *func;
586 ast_expression **params;
587 ast_expression *va_count;
589 ast_call* ast_call_new(lex_ctx_t ctx,
590 ast_expression *funcexpr);
591 bool ast_call_check_types(ast_call*, ast_expression *this_func_va_type);
598 ast_expression expression;
601 ast_expression* *exprs;
602 ast_expression* *collect;
604 ast_block* ast_block_new(lex_ctx_t ctx);
605 void ast_block_delete(ast_block*);
606 void ast_block_set_type(ast_block*, ast_expression *from);
607 void ast_block_collect(ast_block*, ast_expression*);
609 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
613 * Contains a list of blocks... at least in theory.
614 * Usually there's just the main block, other blocks are inside that.
616 * Technically, functions don't need to be an AST node, since we have
617 * neither functions inside functions, nor lambdas, and function
618 * pointers could just work with a name. However, this way could be
619 * more flexible, and adds no real complexity.
621 struct ast_function_s
630 /* list of used-up names for statics without the count suffix */
632 /* number of static variables, by convention this includes the
633 * ones without the count-suffix - remember this when dealing
634 * with savegames. uint instead of size_t as %zu in printf is
635 * C99, so no windows support. */
636 unsigned int static_count;
638 ir_function *ir_func;
640 ir_block **breakblocks;
641 ir_block **continueblocks;
644 /* In order for early-out logic not to go over
645 * excessive jumps, we remember their target
653 /* in order for thread safety - for the optional
654 * channel abesed multithreading... keeping a buffer
655 * here to use in ast_function_label.
663 ast_value *fixedparams;
664 ast_value *return_value;
666 ast_function* ast_function_new(lex_ctx_t ctx, const char *name, ast_value *vtype);
667 /* This will NOT delete the underlying ast_value */
668 void ast_function_delete(ast_function*);
669 /* For "optimized" builds this can just keep returning "foo"...
672 const char* ast_function_label(ast_function*, const char *prefix);
674 bool ast_function_codegen(ast_function *self, ir_builder *builder);
675 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
678 * If the condition creates a situation where this becomes -1 size it means there are
679 * more AST_FLAGs than the type ast_flag_t is capable of holding. So either eliminate
680 * the AST flag count or change the ast_flag_t typedef to a type large enough to accomodate
683 typedef int static_assert_is_ast_flag_safe [((AST_FLAG_LAST) <= (ast_flag_t)(-1)) ? 1 : -1];