2 * Copyright (C) 2012, 2013, 2014
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;
57 typedef struct ast_state_s ast_state;
60 AST_FLAG_VARIADIC = 1 << 0,
61 AST_FLAG_NORETURN = 1 << 1,
62 AST_FLAG_INLINE = 1 << 2,
63 AST_FLAG_INITIALIZED = 1 << 3,
64 AST_FLAG_DEPRECATED = 1 << 4,
65 AST_FLAG_INCLUDE_DEF = 1 << 5,
66 AST_FLAG_IS_VARARG = 1 << 6,
67 AST_FLAG_ALIAS = 1 << 7,
68 AST_FLAG_ERASEABLE = 1 << 8,
69 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,
78 /* Several coverage options
79 * AST_FLAG_COVERAGE means there was an explicit [[coverage]] attribute,
80 * which will overwrite the default set via the commandline switches.
81 * BLOCK_COVERAGE inserts coverage() calls into every basic block.
82 * In the future there might be more options like tracking variable access
83 * by creating get/set wrapper functions.
85 AST_FLAG_COVERAGE = 1 << 12,
86 AST_FLAG_BLOCK_COVERAGE = 1 << 13,
89 AST_FLAG_TYPE_MASK = (AST_FLAG_VARIADIC | AST_FLAG_NORETURN),
90 AST_FLAG_COVERAGE_MASK = (AST_FLAG_BLOCK_COVERAGE)
94 TYPE_ast_node, /* 0 */
95 TYPE_ast_expression, /* 1 */
96 TYPE_ast_value, /* 2 */
97 TYPE_ast_function, /* 3 */
98 TYPE_ast_block, /* 4 */
99 TYPE_ast_binary, /* 5 */
100 TYPE_ast_store, /* 6 */
101 TYPE_ast_binstore, /* 7 */
102 TYPE_ast_entfield, /* 8 */
103 TYPE_ast_ifthen, /* 9 */
104 TYPE_ast_ternary, /* 10 */
105 TYPE_ast_loop, /* 11 */
106 TYPE_ast_call, /* 12 */
107 TYPE_ast_unary, /* 13 */
108 TYPE_ast_return, /* 14 */
109 TYPE_ast_member, /* 15 */
110 TYPE_ast_array_index, /* 16 */
111 TYPE_ast_breakcont, /* 17 */
112 TYPE_ast_switch, /* 18 */
113 TYPE_ast_label, /* 19 */
114 TYPE_ast_goto, /* 20 */
115 TYPE_ast_argpipe, /* 21 */
116 TYPE_ast_state /* 22 */
119 #define ast_istype(x, t) ( ((ast_node*)x)->nodetype == (TYPE_##t) )
120 #define ast_ctx(node) (((ast_node*)(node))->context)
121 #define ast_side_effects(node) (((ast_node*)(node))->side_effects)
123 /* Node interface with common components
125 typedef void ast_node_delete(ast_node*);
126 struct ast_node_common
129 /* I don't feel comfortable using keywords like 'delete' as names... */
130 ast_node_delete *destroy;
132 /* keep: if a node contains this node, 'keep'
133 * prevents its dtor from destroying this node as well.
139 #define ast_delete(x) (*( ((ast_node*)(x))->destroy ))((ast_node*)(x))
140 #define ast_unref(x) do \
142 if (! (((ast_node*)(x))->keep) ) { \
147 /* Expression interface
149 * Any expression or block returns an ir_value, and needs
150 * to know the current function.
152 typedef bool ast_expression_codegen(ast_expression*,
156 /* TODO: the codegen function should take an output-type parameter
157 * indicating whether a variable, type, label etc. is expected, and
159 * Then later an ast_ident could have a codegen using this to figure
160 * out what to look for.
161 * eg. in code which uses a not-yet defined variable, the expression
162 * would take an ast_ident, and the codegen would be called with
163 * type `expression`, so the ast_ident's codegen would search for
164 * variables through the environment (or functions, constants...).
166 struct ast_expression_common
169 ast_expression_codegen *codegen;
171 ast_expression *next;
172 /* arrays get a member-count */
176 /* void foo(string...) gets varparam set as a restriction
177 * for variadic parameters
179 ast_expression *varparam;
180 /* The codegen functions should store their output values
181 * so we can call it multiple times without re-evaluating.
182 * Store lvalue and rvalue seperately though. So that
183 * ast_entfield for example can generate both if required.
191 * Types are also values, both have a type and a name.
192 * especially considering possible constructs like typedefs.
194 * is like creating a 'float foo', foo serving as the type's name.
208 ast_expression expression;
213 const char *argcounter;
215 int cvq; /* const/var qualifier */
216 bool isfield; /* this declares a field */
217 bool isimm; /* an immediate, not just const */
219 bool inexact; /* inexact coming from folded expression */
220 basic_value_t constval;
221 /* for TYPE_ARRAY we have an optional vector
222 * of constants when an initializer list
225 basic_value_t *initlist;
227 /* usecount for the parser */
231 ir_value **ir_values;
232 size_t ir_value_count;
234 /* ONLY for arrays in progs version up to 6 */
239 bool intrinsic; /* true if associated with intrinsic */
242 ast_value* ast_value_new(lex_ctx_t ctx, const char *name, int qctype);
243 ast_value* ast_value_copy(const ast_value *self);
244 /* This will NOT delete an underlying ast_function */
245 void ast_value_delete(ast_value*);
247 bool ast_value_set_name(ast_value*, const char *name);
250 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
251 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
254 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
256 void ast_value_params_add(ast_value*, ast_value*);
258 bool ast_compare_type(ast_expression *a, ast_expression *b);
259 ast_expression* ast_type_copy(lex_ctx_t ctx, const ast_expression *ex);
260 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
261 void ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
262 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
264 typedef enum ast_binary_ref_s {
266 AST_REF_LEFT = 1 << 1,
267 AST_REF_RIGHT = 1 << 2,
268 AST_REF_ALL = (AST_REF_LEFT | AST_REF_RIGHT)
274 * A value-returning binary expression.
278 ast_expression expression;
281 ast_expression *left;
282 ast_expression *right;
286 ast_binary* ast_binary_new(lex_ctx_t ctx,
288 ast_expression *left,
289 ast_expression *right);
293 * An assignment including a binary expression with the source as left operand.
294 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
296 struct ast_binstore_s
298 ast_expression expression;
302 ast_expression *dest;
303 ast_expression *source;
304 /* for &~= which uses the destination in a binary in source we can use this */
307 ast_binstore* ast_binstore_new(lex_ctx_t ctx,
310 ast_expression *left,
311 ast_expression *right);
315 * Regular unary expressions: not,neg
319 ast_expression expression;
322 ast_expression *operand;
324 ast_unary* ast_unary_new(lex_ctx_t ctx,
326 ast_expression *expr);
330 * Make sure 'return' only happens at the end of a block, otherwise the IR
331 * will refuse to create further instructions.
332 * This should be honored by the parser.
336 ast_expression expression;
337 ast_expression *operand;
339 ast_return* ast_return_new(lex_ctx_t ctx,
340 ast_expression *expr);
344 * This must do 2 things:
345 * -) Provide a way to fetch an entity field value. (Rvalue)
346 * -) Provide a pointer to an entity field. (Lvalue)
348 * In original QC, there's only a STORE via pointer, but
349 * no LOAD via pointer.
350 * So we must know beforehand if we are going to read or assign
352 * For this we will have to extend the codegen() functions with
353 * a flag saying whether or not we need an L or an R-value.
355 struct ast_entfield_s
357 ast_expression expression;
358 /* The entity can come from an expression of course. */
359 ast_expression *entity;
360 /* As can the field, it just must result in a value of TYPE_FIELD */
361 ast_expression *field;
363 ast_entfield* ast_entfield_new(lex_ctx_t ctx, ast_expression *entity, ast_expression *field);
364 ast_entfield* ast_entfield_new_force(lex_ctx_t ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
368 * For now used for vectors. If we get structs or unions
369 * we can have them handled here as well.
373 ast_expression expression;
374 ast_expression *owner;
379 ast_member* ast_member_new(lex_ctx_t ctx, ast_expression *owner, unsigned int field, const char *name);
380 void ast_member_delete(ast_member*);
381 bool ast_member_set_name(ast_member*, const char *name);
384 /* Array index access:
386 * QC forces us to take special action on arrays:
387 * an ast_store on an ast_array_index must not codegen the index,
388 * but call its setter - unless we have an instruction set which supports
390 * Any other array index access will be codegened to a call to the getter.
391 * In any case, accessing an element via a compiletime-constant index will
392 * result in quick access to that variable.
394 struct ast_array_index_s
396 ast_expression expression;
397 ast_expression *array;
398 ast_expression *index;
400 ast_array_index* ast_array_index_new(lex_ctx_t ctx, ast_expression *array, ast_expression *index);
404 * copy all varargs starting from a specific index
408 ast_expression expression;
409 ast_expression *index;
411 ast_argpipe* ast_argpipe_new(lex_ctx_t ctx, ast_expression *index);
415 * Stores left<-right and returns left.
416 * Specialized binary expression node
420 ast_expression expression;
422 ast_expression *dest;
423 ast_expression *source;
425 ast_store* ast_store_new(lex_ctx_t ctx, int op,
426 ast_expression *d, ast_expression *s);
430 * A general 'if then else' statement, either side can be NULL and will
431 * thus be omitted. It is an error for *both* cases to be NULL at once.
433 * During its 'codegen' it'll be changing the ast_function's block.
435 * An if is also an "expression". Its codegen will put NULL into the
436 * output field though. For ternary expressions an ast_ternary will be
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_ifthen* ast_ifthen_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
449 /* Ternary expressions...
451 * Contrary to 'if-then-else' nodes, ternary expressions actually
452 * return a value, otherwise they behave the very same way.
453 * The difference in 'codegen' is that it'll return the value of
456 * The other difference is that in an ast_ternary, NEITHER side
457 * must be NULL, there's ALWAYS an else branch.
459 * This is the only ast_node beside ast_value which contains
460 * an ir_value. Theoretically we don't need to remember it though.
464 ast_expression expression;
465 ast_expression *cond;
466 /* It's all just 'expressions', since an ast_block is one too. */
467 ast_expression *on_true;
468 ast_expression *on_false;
470 ast_ternary* ast_ternary_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
472 /* A general loop node
474 * For convenience it contains 4 parts:
475 * -) (ini) = initializing expression
476 * -) (pre) = pre-loop condition
477 * -) (pst) = post-loop condition
478 * -) (inc) = "increment" expression
479 * The following is a psudo-representation of this loop
480 * note that '=>' bears the logical meaning of "implies".
481 * (a => b) equals (!a || b)
484 while (has_pre => {pre})
488 continue: // a 'continue' will jump here
489 if (has_pst => {pst})
497 ast_expression expression;
498 ast_expression *initexpr;
499 ast_expression *precond;
500 ast_expression *postcond;
501 ast_expression *increment;
502 ast_expression *body;
503 /* For now we allow a seperate flag on whether or not the condition
504 * is supposed to be true or false.
505 * That way, the parser can generate a 'while not(!x)' for `while(x)`
506 * if desired, which is useful for the new -f{true,false}-empty-strings
512 ast_loop* ast_loop_new(lex_ctx_t ctx,
513 ast_expression *initexpr,
514 ast_expression *precond, bool pre_not,
515 ast_expression *postcond, bool post_not,
516 ast_expression *increment,
517 ast_expression *body);
521 struct ast_breakcont_s
523 ast_expression expression;
527 ast_breakcont* ast_breakcont_new(lex_ctx_t ctx, bool iscont, unsigned int levels);
531 * A few notes about this: with the original QCVM, no real optimization
532 * is possible. The SWITCH instruction set isn't really helping a lot, since
533 * it only collapes the EQ and IF instructions into one.
534 * Note: Declaring local variables inside caseblocks is normal.
535 * Since we don't have to deal with a stack there's no unnatural behaviour to
536 * be expected from it.
540 ast_expression *value; /* #20 will replace this */
541 ast_expression *code;
545 ast_expression expression;
547 ast_expression *operand;
548 ast_switch_case *cases;
551 ast_switch* ast_switch_new(lex_ctx_t ctx, ast_expression *op);
555 * Introduce a label which can be used together with 'goto'
559 ast_expression expression;
564 /* means it has not yet been defined */
568 ast_label* ast_label_new(lex_ctx_t ctx, const char *name, bool undefined);
572 * Go to a label, the label node is filled in at a later point!
576 ast_expression expression;
579 ir_block *irblock_from;
582 ast_goto* ast_goto_new(lex_ctx_t ctx, const char *name);
583 void ast_goto_set_label(ast_goto*, ast_label*);
587 * For frame/think state updates: void foo() [framenum, nextthink] {}
591 ast_expression expression;
592 ast_expression *framenum;
593 ast_expression *nextthink;
595 ast_state* ast_state_new(lex_ctx_t ctx, ast_expression *frame, ast_expression *think);
596 void ast_state_delete(ast_state*);
600 * Contains an ast_expression as target, rather than an ast_function/value.
601 * Since it's how QC works, every ast_function has an ast_value
602 * associated anyway - in other words, the VM contains function
603 * pointers for every function anyway. Thus, this node will call
605 * Additionally it contains a list of ast_expressions as parameters.
606 * Since calls can return values, an ast_call is also an ast_expression.
610 ast_expression expression;
611 ast_expression *func;
612 ast_expression **params;
613 ast_expression *va_count;
615 ast_call* ast_call_new(lex_ctx_t ctx,
616 ast_expression *funcexpr);
617 bool ast_call_check_types(ast_call*, ast_expression *this_func_va_type);
624 ast_expression expression;
627 ast_expression* *exprs;
628 ast_expression* *collect;
630 ast_block* ast_block_new(lex_ctx_t ctx);
631 void ast_block_delete(ast_block*);
632 void ast_block_set_type(ast_block*, ast_expression *from);
633 void ast_block_collect(ast_block*, ast_expression*);
635 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
639 * Contains a list of blocks... at least in theory.
640 * Usually there's just the main block, other blocks are inside that.
642 * Technically, functions don't need to be an AST node, since we have
643 * neither functions inside functions, nor lambdas, and function
644 * pointers could just work with a name. However, this way could be
645 * more flexible, and adds no real complexity.
647 struct ast_function_s
656 /* list of used-up names for statics without the count suffix */
658 /* number of static variables, by convention this includes the
659 * ones without the count-suffix - remember this when dealing
660 * with savegames. uint instead of size_t as %zu in printf is
661 * C99, so no windows support. */
662 unsigned int static_count;
664 ir_function *ir_func;
666 ir_block **breakblocks;
667 ir_block **continueblocks;
670 /* In order for early-out logic not to go over
671 * excessive jumps, we remember their target
679 /* in order for thread safety - for the optional
680 * channel abesed multithreading... keeping a buffer
681 * here to use in ast_function_label.
689 ast_value *fixedparams;
690 ast_value *return_value;
692 ast_function* ast_function_new(lex_ctx_t ctx, const char *name, ast_value *vtype);
693 /* This will NOT delete the underlying ast_value */
694 void ast_function_delete(ast_function*);
695 /* For "optimized" builds this can just keep returning "foo"...
698 const char* ast_function_label(ast_function*, const char *prefix);
700 bool ast_function_codegen(ast_function *self, ir_builder *builder);
701 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
704 * If the condition creates a situation where this becomes -1 size it means there are
705 * more AST_FLAGs than the type ast_flag_t is capable of holding. So either eliminate
706 * the AST flag count or change the ast_flag_t typedef to a type large enough to accomodate
709 typedef int static_assert_is_ast_flag_safe [((AST_FLAG_LAST) <= (ast_flag_t)(-1)) ? 1 : -1];