6 typedef uint16_t ast_flag_t;
8 /* Note: I will not be using a _t suffix for the
9 * "main" ast node types for now.
13 struct ast_expression;
28 struct ast_array_index;
37 AST_FLAG_VARIADIC = 1 << 0,
38 AST_FLAG_NORETURN = 1 << 1,
39 AST_FLAG_INLINE = 1 << 2,
40 AST_FLAG_INITIALIZED = 1 << 3,
41 AST_FLAG_DEPRECATED = 1 << 4,
42 AST_FLAG_INCLUDE_DEF = 1 << 5,
43 AST_FLAG_IS_VARARG = 1 << 6,
44 AST_FLAG_ALIAS = 1 << 7,
45 AST_FLAG_ERASEABLE = 1 << 8,
46 AST_FLAG_ACCUMULATE = 1 << 9,
48 /* An array declared as []
49 * so that the size is taken from the initializer
51 AST_FLAG_ARRAY_INIT = 1 << 10,
53 AST_FLAG_FINAL_DECL = 1 << 11,
55 /* Several coverage options
56 * AST_FLAG_COVERAGE means there was an explicit [[coverage]] attribute,
57 * which will overwrite the default set via the commandline switches.
58 * BLOCK_COVERAGE inserts coverage() calls into every basic block.
59 * In the future there might be more options like tracking variable access
60 * by creating get/set wrapper functions.
62 AST_FLAG_COVERAGE = 1 << 12,
63 AST_FLAG_BLOCK_COVERAGE = 1 << 13,
66 AST_FLAG_TYPE_MASK = (AST_FLAG_VARIADIC | AST_FLAG_NORETURN),
67 AST_FLAG_COVERAGE_MASK = (AST_FLAG_BLOCK_COVERAGE)
71 TYPE_ast_node, /* 0 */
72 TYPE_ast_expression, /* 1 */
73 TYPE_ast_value, /* 2 */
74 TYPE_ast_function, /* 3 */
75 TYPE_ast_block, /* 4 */
76 TYPE_ast_binary, /* 5 */
77 TYPE_ast_store, /* 6 */
78 TYPE_ast_binstore, /* 7 */
79 TYPE_ast_entfield, /* 8 */
80 TYPE_ast_ifthen, /* 9 */
81 TYPE_ast_ternary, /* 10 */
82 TYPE_ast_loop, /* 11 */
83 TYPE_ast_call, /* 12 */
84 TYPE_ast_unary, /* 13 */
85 TYPE_ast_return, /* 14 */
86 TYPE_ast_member, /* 15 */
87 TYPE_ast_array_index, /* 16 */
88 TYPE_ast_breakcont, /* 17 */
89 TYPE_ast_switch, /* 18 */
90 TYPE_ast_label, /* 19 */
91 TYPE_ast_goto, /* 20 */
92 TYPE_ast_argpipe, /* 21 */
93 TYPE_ast_state /* 22 */
96 #define ast_istype(x, t) ( ((ast_node*)x)->nodetype == (TYPE_##t) )
97 #define ast_ctx(node) (((ast_node*)(node))->context)
98 #define ast_side_effects(node) (((ast_node*)(node))->side_effects)
100 /* Node interface with common components
102 typedef void ast_node_delete(ast_node*);
107 /* I don't feel comfortable using keywords like 'delete' as names... */
108 ast_node_delete *destroy;
110 /* keep: if a node contains this node, 'keep'
111 * prevents its dtor from destroying this node as well.
117 #define ast_delete(x) (*( ((ast_node*)(x))->destroy ))((ast_node*)(x))
118 #define ast_unref(x) do \
120 if (! (((ast_node*)(x))->keep) ) { \
125 /* Expression interface
127 * Any expression or block returns an ir_value, and needs
128 * to know the current function.
130 typedef bool ast_expression_codegen(ast_expression*,
134 /* TODO: the codegen function should take an output-type parameter
135 * indicating whether a variable, type, label etc. is expected, and
137 * Then later an ast_ident could have a codegen using this to figure
138 * out what to look for.
139 * eg. in code which uses a not-yet defined variable, the expression
140 * would take an ast_ident, and the codegen would be called with
141 * type `expression`, so the ast_ident's codegen would search for
142 * variables through the environment (or functions, constants...).
144 struct ast_expression {
148 ast_expression_codegen *codegen;
150 ast_expression *next;
151 /* arrays get a member-count */
153 std::vector<ast_value*> params;
156 /* void foo(string...) gets varparam set as a restriction
157 * for variadic parameters
159 ast_expression *varparam;
160 /* The codegen functions should store their output values
161 * so we can call it multiple times without re-evaluating.
162 * Store lvalue and rvalue seperately though. So that
163 * ast_entfield for example can generate both if required.
171 * Types are also values, both have a type and a name.
172 * especially considering possible constructs like typedefs.
174 * is like creating a 'float foo', foo serving as the type's name.
176 union basic_value_t {
188 ast_expression expression;
193 const char *argcounter;
195 int cvq; /* const/var qualifier */
196 bool isfield; /* this declares a field */
197 bool isimm; /* an immediate, not just const */
199 bool inexact; /* inexact coming from folded expression */
200 basic_value_t constval;
201 /* for TYPE_ARRAY we have an optional vector
202 * of constants when an initializer list
205 basic_value_t *initlist;
207 /* usecount for the parser */
211 ir_value **ir_values;
212 size_t ir_value_count;
214 /* ONLY for arrays in progs version up to 6 */
219 bool intrinsic; /* true if associated with intrinsic */
222 ast_value* ast_value_new(lex_ctx_t ctx, const char *name, int qctype);
223 ast_value* ast_value_copy(const ast_value *self);
224 /* This will NOT delete an underlying ast_function */
225 void ast_value_delete(ast_value*);
227 bool ast_value_set_name(ast_value*, const char *name);
230 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
231 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
234 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
236 void ast_value_params_add(ast_value*, ast_value*);
238 bool ast_compare_type(ast_expression *a, ast_expression *b);
239 ast_expression* ast_type_copy(lex_ctx_t ctx, const ast_expression *ex);
240 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
241 void ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
242 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
244 enum ast_binary_ref {
246 AST_REF_LEFT = 1 << 1,
247 AST_REF_RIGHT = 1 << 2,
248 AST_REF_ALL = (AST_REF_LEFT | AST_REF_RIGHT)
254 * A value-returning binary expression.
258 ast_expression expression;
260 ast_expression *left;
261 ast_expression *right;
265 ast_binary* ast_binary_new(lex_ctx_t ctx,
267 ast_expression *left,
268 ast_expression *right);
272 * An assignment including a binary expression with the source as left operand.
273 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
277 ast_expression expression;
280 ast_expression *dest;
281 ast_expression *source;
282 /* for &~= which uses the destination in a binary in source we can use this */
285 ast_binstore* ast_binstore_new(lex_ctx_t ctx,
288 ast_expression *left,
289 ast_expression *right);
293 * Regular unary expressions: not,neg
297 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.
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
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);
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.
516 struct ast_switch_case {
517 ast_expression *value; /* #20 will replace this */
518 ast_expression *code;
523 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;
539 std::vector<ast_goto*> gotos;
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 * For frame/think state updates: void foo() [framenum, nextthink] {}
568 ast_expression expression;
569 ast_expression *framenum;
570 ast_expression *nextthink;
572 ast_state* ast_state_new(lex_ctx_t ctx, ast_expression *frame, ast_expression *think);
573 void ast_state_delete(ast_state*);
577 * Contains an ast_expression as target, rather than an ast_function/value.
578 * Since it's how QC works, every ast_function has an ast_value
579 * associated anyway - in other words, the VM contains function
580 * pointers for every function anyway. Thus, this node will call
582 * Additionally it contains a list of ast_expressions as parameters.
583 * Since calls can return values, an ast_call is also an ast_expression.
587 ast_expression expression;
588 ast_expression *func;
589 std::vector<ast_expression *> params;
590 ast_expression *va_count;
592 ast_call* ast_call_new(lex_ctx_t ctx,
593 ast_expression *funcexpr);
594 bool ast_call_check_types(ast_call*, ast_expression *this_func_va_type);
601 ast_expression expression;
603 std::vector<ast_value*> locals;
604 std::vector<ast_expression*> exprs;
605 std::vector<ast_expression*> collect;
607 ast_block* ast_block_new(lex_ctx_t ctx);
608 void ast_block_delete(ast_block*);
609 void ast_block_set_type(ast_block*, ast_expression *from);
610 void ast_block_collect(ast_block*, ast_expression*);
612 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
616 * Contains a list of blocks... at least in theory.
617 * Usually there's just the main block, other blocks are inside that.
619 * Technically, functions don't need to be an AST node, since we have
620 * neither functions inside functions, nor lambdas, and function
621 * pointers could just work with a name. However, this way could be
622 * more flexible, and adds no real complexity.
633 /* list of used-up names for statics without the count suffix */
635 /* number of static variables, by convention this includes the
636 * ones without the count-suffix - remember this when dealing
637 * with savegames. uint instead of size_t as %zu in printf is
638 * C99, so no windows support. */
639 unsigned int static_count;
641 ir_function *ir_func;
643 ir_block **breakblocks;
644 ir_block **continueblocks;
647 /* in order for thread safety - for the optional
648 * channel abesed multithreading... keeping a buffer
649 * here to use in ast_function_label.
655 ast_value *fixedparams;
656 ast_value *return_value;
658 ast_function* ast_function_new(lex_ctx_t ctx, const char *name, ast_value *vtype);
659 /* This will NOT delete the underlying ast_value */
660 void ast_function_delete(ast_function*);
661 /* For "optimized" builds this can just keep returning "foo"...
664 const char* ast_function_label(ast_function*, const char *prefix);
666 bool ast_function_codegen(ast_function *self, ir_builder *builder);
667 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
670 * If the condition creates a situation where this becomes -1 size it means there are
671 * more AST_FLAGs than the type ast_flag_t is capable of holding. So either eliminate
672 * the AST flag count or change the ast_flag_t typedef to a type large enough to accomodate
675 typedef int static_assert_is_ast_flag_safe [((AST_FLAG_LAST) <= (ast_flag_t)(-1)) ? 1 : -1];