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 basic_value_t constval;
220 /* for TYPE_ARRAY we have an optional vector
221 * of constants when an initializer list
224 basic_value_t *initlist;
226 /* usecount for the parser */
230 ir_value **ir_values;
231 size_t ir_value_count;
233 /* ONLY for arrays in progs version up to 6 */
238 bool intrinsic; /* true if associated with intrinsic */
241 ast_value* ast_value_new(lex_ctx_t ctx, const char *name, int qctype);
242 ast_value* ast_value_copy(const ast_value *self);
243 /* This will NOT delete an underlying ast_function */
244 void ast_value_delete(ast_value*);
246 bool ast_value_set_name(ast_value*, const char *name);
249 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
250 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
253 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
255 void ast_value_params_add(ast_value*, ast_value*);
257 bool ast_compare_type(ast_expression *a, ast_expression *b);
258 ast_expression* ast_type_copy(lex_ctx_t ctx, const ast_expression *ex);
259 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
260 void ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
261 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
263 typedef enum ast_binary_ref_s {
265 AST_REF_LEFT = 1 << 1,
266 AST_REF_RIGHT = 1 << 2,
267 AST_REF_ALL = (AST_REF_LEFT | AST_REF_RIGHT)
273 * A value-returning binary expression.
277 ast_expression expression;
280 ast_expression *left;
281 ast_expression *right;
285 ast_binary* ast_binary_new(lex_ctx_t ctx,
287 ast_expression *left,
288 ast_expression *right);
292 * An assignment including a binary expression with the source as left operand.
293 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
295 struct ast_binstore_s
297 ast_expression expression;
301 ast_expression *dest;
302 ast_expression *source;
303 /* for &~= which uses the destination in a binary in source we can use this */
306 ast_binstore* ast_binstore_new(lex_ctx_t ctx,
309 ast_expression *left,
310 ast_expression *right);
314 * Regular unary expressions: not,neg
318 ast_expression expression;
321 ast_expression *operand;
323 ast_unary* ast_unary_new(lex_ctx_t ctx,
325 ast_expression *expr);
329 * Make sure 'return' only happens at the end of a block, otherwise the IR
330 * will refuse to create further instructions.
331 * This should be honored by the parser.
335 ast_expression expression;
336 ast_expression *operand;
338 ast_return* ast_return_new(lex_ctx_t ctx,
339 ast_expression *expr);
343 * This must do 2 things:
344 * -) Provide a way to fetch an entity field value. (Rvalue)
345 * -) Provide a pointer to an entity field. (Lvalue)
347 * In original QC, there's only a STORE via pointer, but
348 * no LOAD via pointer.
349 * So we must know beforehand if we are going to read or assign
351 * For this we will have to extend the codegen() functions with
352 * a flag saying whether or not we need an L or an R-value.
354 struct ast_entfield_s
356 ast_expression expression;
357 /* The entity can come from an expression of course. */
358 ast_expression *entity;
359 /* As can the field, it just must result in a value of TYPE_FIELD */
360 ast_expression *field;
362 ast_entfield* ast_entfield_new(lex_ctx_t ctx, ast_expression *entity, ast_expression *field);
363 ast_entfield* ast_entfield_new_force(lex_ctx_t ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
367 * For now used for vectors. If we get structs or unions
368 * we can have them handled here as well.
372 ast_expression expression;
373 ast_expression *owner;
378 ast_member* ast_member_new(lex_ctx_t ctx, ast_expression *owner, unsigned int field, const char *name);
379 void ast_member_delete(ast_member*);
380 bool ast_member_set_name(ast_member*, const char *name);
383 /* Array index access:
385 * QC forces us to take special action on arrays:
386 * an ast_store on an ast_array_index must not codegen the index,
387 * but call its setter - unless we have an instruction set which supports
389 * Any other array index access will be codegened to a call to the getter.
390 * In any case, accessing an element via a compiletime-constant index will
391 * result in quick access to that variable.
393 struct ast_array_index_s
395 ast_expression expression;
396 ast_expression *array;
397 ast_expression *index;
399 ast_array_index* ast_array_index_new(lex_ctx_t ctx, ast_expression *array, ast_expression *index);
403 * copy all varargs starting from a specific index
407 ast_expression expression;
408 ast_expression *index;
410 ast_argpipe* ast_argpipe_new(lex_ctx_t ctx, ast_expression *index);
414 * Stores left<-right and returns left.
415 * Specialized binary expression node
419 ast_expression expression;
421 ast_expression *dest;
422 ast_expression *source;
424 ast_store* ast_store_new(lex_ctx_t ctx, int op,
425 ast_expression *d, ast_expression *s);
429 * A general 'if then else' statement, either side can be NULL and will
430 * thus be omitted. It is an error for *both* cases to be NULL at once.
432 * During its 'codegen' it'll be changing the ast_function's block.
434 * An if is also an "expression". Its codegen will put NULL into the
435 * output field though. For ternary expressions an ast_ternary will be
440 ast_expression expression;
441 ast_expression *cond;
442 /* It's all just 'expressions', since an ast_block is one too. */
443 ast_expression *on_true;
444 ast_expression *on_false;
446 ast_ifthen* ast_ifthen_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
448 /* Ternary expressions...
450 * Contrary to 'if-then-else' nodes, ternary expressions actually
451 * return a value, otherwise they behave the very same way.
452 * The difference in 'codegen' is that it'll return the value of
455 * The other difference is that in an ast_ternary, NEITHER side
456 * must be NULL, there's ALWAYS an else branch.
458 * This is the only ast_node beside ast_value which contains
459 * an ir_value. Theoretically we don't need to remember it though.
463 ast_expression expression;
464 ast_expression *cond;
465 /* It's all just 'expressions', since an ast_block is one too. */
466 ast_expression *on_true;
467 ast_expression *on_false;
469 ast_ternary* ast_ternary_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
471 /* A general loop node
473 * For convenience it contains 4 parts:
474 * -) (ini) = initializing expression
475 * -) (pre) = pre-loop condition
476 * -) (pst) = post-loop condition
477 * -) (inc) = "increment" expression
478 * The following is a psudo-representation of this loop
479 * note that '=>' bears the logical meaning of "implies".
480 * (a => b) equals (!a || b)
483 while (has_pre => {pre})
487 continue: // a 'continue' will jump here
488 if (has_pst => {pst})
496 ast_expression expression;
497 ast_expression *initexpr;
498 ast_expression *precond;
499 ast_expression *postcond;
500 ast_expression *increment;
501 ast_expression *body;
502 /* For now we allow a seperate flag on whether or not the condition
503 * is supposed to be true or false.
504 * That way, the parser can generate a 'while not(!x)' for `while(x)`
505 * if desired, which is useful for the new -f{true,false}-empty-strings
511 ast_loop* ast_loop_new(lex_ctx_t ctx,
512 ast_expression *initexpr,
513 ast_expression *precond, bool pre_not,
514 ast_expression *postcond, bool post_not,
515 ast_expression *increment,
516 ast_expression *body);
520 struct ast_breakcont_s
522 ast_expression expression;
526 ast_breakcont* ast_breakcont_new(lex_ctx_t ctx, bool iscont, unsigned int levels);
530 * A few notes about this: with the original QCVM, no real optimization
531 * is possible. The SWITCH instruction set isn't really helping a lot, since
532 * it only collapes the EQ and IF instructions into one.
533 * Note: Declaring local variables inside caseblocks is normal.
534 * Since we don't have to deal with a stack there's no unnatural behaviour to
535 * be expected from it.
539 ast_expression *value; /* #20 will replace this */
540 ast_expression *code;
544 ast_expression expression;
546 ast_expression *operand;
547 ast_switch_case *cases;
550 ast_switch* ast_switch_new(lex_ctx_t ctx, ast_expression *op);
554 * Introduce a label which can be used together with 'goto'
558 ast_expression expression;
563 /* means it has not yet been defined */
567 ast_label* ast_label_new(lex_ctx_t ctx, const char *name, bool undefined);
571 * Go to a label, the label node is filled in at a later point!
575 ast_expression expression;
578 ir_block *irblock_from;
581 ast_goto* ast_goto_new(lex_ctx_t ctx, const char *name);
582 void ast_goto_set_label(ast_goto*, ast_label*);
586 * For frame/think state updates: void foo() [framenum, nextthink] {}
590 ast_expression expression;
591 ast_expression *framenum;
592 ast_expression *nextthink;
594 ast_state* ast_state_new(lex_ctx_t ctx, ast_expression *frame, ast_expression *think);
595 void ast_state_delete(ast_state*);
599 * Contains an ast_expression as target, rather than an ast_function/value.
600 * Since it's how QC works, every ast_function has an ast_value
601 * associated anyway - in other words, the VM contains function
602 * pointers for every function anyway. Thus, this node will call
604 * Additionally it contains a list of ast_expressions as parameters.
605 * Since calls can return values, an ast_call is also an ast_expression.
609 ast_expression expression;
610 ast_expression *func;
611 ast_expression **params;
612 ast_expression *va_count;
614 ast_call* ast_call_new(lex_ctx_t ctx,
615 ast_expression *funcexpr);
616 bool ast_call_check_types(ast_call*, ast_expression *this_func_va_type);
623 ast_expression expression;
626 ast_expression* *exprs;
627 ast_expression* *collect;
629 ast_block* ast_block_new(lex_ctx_t ctx);
630 void ast_block_delete(ast_block*);
631 void ast_block_set_type(ast_block*, ast_expression *from);
632 void ast_block_collect(ast_block*, ast_expression*);
634 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
638 * Contains a list of blocks... at least in theory.
639 * Usually there's just the main block, other blocks are inside that.
641 * Technically, functions don't need to be an AST node, since we have
642 * neither functions inside functions, nor lambdas, and function
643 * pointers could just work with a name. However, this way could be
644 * more flexible, and adds no real complexity.
646 struct ast_function_s
655 /* list of used-up names for statics without the count suffix */
657 /* number of static variables, by convention this includes the
658 * ones without the count-suffix - remember this when dealing
659 * with savegames. uint instead of size_t as %zu in printf is
660 * C99, so no windows support. */
661 unsigned int static_count;
663 ir_function *ir_func;
665 ir_block **breakblocks;
666 ir_block **continueblocks;
669 /* In order for early-out logic not to go over
670 * excessive jumps, we remember their target
678 /* in order for thread safety - for the optional
679 * channel abesed multithreading... keeping a buffer
680 * here to use in ast_function_label.
688 ast_value *fixedparams;
689 ast_value *return_value;
691 ast_function* ast_function_new(lex_ctx_t ctx, const char *name, ast_value *vtype);
692 /* This will NOT delete the underlying ast_value */
693 void ast_function_delete(ast_function*);
694 /* For "optimized" builds this can just keep returning "foo"...
697 const char* ast_function_label(ast_function*, const char *prefix);
699 bool ast_function_codegen(ast_function *self, ir_builder *builder);
700 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
703 * If the condition creates a situation where this becomes -1 size it means there are
704 * more AST_FLAGs than the type ast_flag_t is capable of holding. So either eliminate
705 * the AST flag count or change the ast_flag_t typedef to a type large enough to accomodate
708 typedef int static_assert_is_ast_flag_safe [((AST_FLAG_LAST) <= (ast_flag_t)(-1)) ? 1 : -1];