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) ( (x)->m_node_type == (TYPE_##t) )
98 /* Node interface with common components
100 typedef void ast_node_delete(ast_node*);
105 ast_node(lex_ctx_t, int nodetype);
109 /* I don't feel comfortable using keywords like 'delete' as names... */
111 /* keep_node: if a node contains this node, 'keep_node'
112 * prevents its dtor from destroying this node as well.
117 void propagate_side_effects(ast_node *other) const;
120 #define ast_unref(x) do \
122 if (! (x)->m_keep_node ) { \
127 enum class ast_copy_type_t { value };
128 static const ast_copy_type_t ast_copy_type = ast_copy_type_t::value;
130 /* Expression interface
132 * Any expression or block returns an ir_value, and needs
133 * to know the current function.
135 typedef bool ast_expression_codegen(ast_expression*,
139 /* TODO: the codegen function should take an output-type parameter
140 * indicating whether a variable, type, label etc. is expected, and
142 * Then later an ast_ident could have a codegen using this to figure
143 * out what to look for.
144 * eg. in code which uses a not-yet defined variable, the expression
145 * would take an ast_ident, and the codegen would be called with
146 * type `expression`, so the ast_ident's codegen would search for
147 * variables through the environment (or functions, constants...).
149 struct ast_expression : ast_node {
150 ast_expression() = delete;
151 ast_expression(lex_ctx_t ctx, int nodetype, qc_type vtype);
152 ast_expression(lex_ctx_t ctx, int nodetype);
154 ast_expression(ast_copy_type_t, int nodetype, const ast_expression&);
155 ast_expression(ast_copy_type_t, const ast_expression&);
157 static ast_expression *shallow_type(lex_ctx_t ctx, qc_type vtype);
159 bool compare_type(const ast_expression &other) const;
160 void adopt_type(const ast_expression &other);
162 qc_type m_vtype = TYPE_VOID;
163 ast_expression *m_next = nullptr;
164 /* arrays get a member-count */
166 std::vector<std::unique_ptr<ast_value>> m_type_params;
168 ast_flag_t m_flags = 0;
169 /* void foo(string...) gets varparam set as a restriction
170 * for variadic parameters
172 ast_expression *m_varparam = nullptr;
173 /* The codegen functions should store their output values
174 * so we can call it multiple times without re-evaluating.
175 * Store lvalue and rvalue seperately though. So that
176 * ast_entfield for example can generate both if required.
178 ir_value *m_outl = nullptr;
179 ir_value *m_outr = nullptr;
184 * Types are also values, both have a type and a name.
185 * especially considering possible constructs like typedefs.
187 * is like creating a 'float foo', foo serving as the type's name.
189 union basic_value_t {
199 struct ast_value : ast_expression
201 ast_value() = delete;
202 ast_value(lex_ctx_t ctx, const std::string &name, qc_type qctype);
205 ast_value(ast_copy_type_t, const ast_expression&, const std::string&);
206 ast_value(ast_copy_type_t, const ast_value&);
207 ast_value(ast_copy_type_t, const ast_value&, const std::string&);
209 void add_param(ast_value*);
214 const char *m_argcounter = nullptr;
216 int m_cvq = CV_NONE; /* const/var qualifier */
217 bool m_isfield = false; /* this declares a field */
218 bool m_isimm = false; /* an immediate, not just const */
219 bool m_hasvalue = false;
220 bool m_inexact = false; /* inexact coming from folded expression */
221 basic_value_t m_constval;
222 /* for TYPE_ARRAY we have an optional vector
223 * of constants when an initializer list
226 std::vector<basic_value_t> m_initlist;
228 /* usecount for the parser */
231 ir_value *m_ir_v = nullptr;
232 ir_value **m_ir_values = nullptr;
233 size_t m_ir_value_count = 0;
235 /* ONLY for arrays in progs version up to 6 */
236 ast_value *m_setter = nullptr;
237 ast_value *m_getter = nullptr;
240 bool m_intrinsic = false; /* true if associated with intrinsic */
243 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
245 void ast_type_to_string(const ast_expression *e, char *buf, size_t bufsize);
247 enum ast_binary_ref {
249 AST_REF_LEFT = 1 << 1,
250 AST_REF_RIGHT = 1 << 2,
251 AST_REF_ALL = (AST_REF_LEFT | AST_REF_RIGHT)
257 * A value-returning binary expression.
259 struct ast_binary : ast_expression
261 ast_binary() = delete;
262 ast_binary(lex_ctx_t ctx, int op, ast_expression *l, ast_expression *r);
266 ast_expression *m_left;
267 ast_expression *m_right;
268 ast_binary_ref m_refs;
274 * An assignment including a binary expression with the source as left operand.
275 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
277 struct ast_binstore : ast_expression
279 ast_binstore() = delete;
280 ast_binstore(lex_ctx_t ctx, int storeop, int mathop, ast_expression *l, ast_expression *r);
285 ast_expression *m_dest;
286 ast_expression *m_source;
287 /* for &~= which uses the destination in a binary in source we can use this */
290 ast_binstore* ast_binstore_new(lex_ctx_t ctx,
293 ast_expression *left,
294 ast_expression *right);
298 * Regular unary expressions: not,neg
300 struct ast_unary : ast_expression
302 ast_unary() = delete;
305 ast_expression *m_operand;
306 static ast_unary* make(lex_ctx_t ctx, int op, ast_expression *expr);
308 ast_unary(lex_ctx_t ctx, int op, ast_expression *expr);
313 * Make sure 'return' only happens at the end of a block, otherwise the IR
314 * will refuse to create further instructions.
315 * This should be honored by the parser.
317 struct ast_return : ast_expression
319 ast_return() = delete;
320 ast_return(lex_ctx_t ctx, ast_expression *expr);
322 ast_expression *m_operand;
327 * This must do 2 things:
328 * -) Provide a way to fetch an entity field value. (Rvalue)
329 * -) Provide a pointer to an entity field. (Lvalue)
331 * In original QC, there's only a STORE via pointer, but
332 * no LOAD via pointer.
333 * So we must know beforehand if we are going to read or assign
335 * For this we will have to extend the codegen() functions with
336 * a flag saying whether or not we need an L or an R-value.
338 struct ast_entfield : ast_expression
340 ast_entfield() = delete;
341 ast_entfield(lex_ctx_t ctx, ast_expression *entity, ast_expression *field);
342 ast_entfield(lex_ctx_t ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
344 // The entity can come from an expression of course.
345 ast_expression *m_entity;
346 // As can the field, it just must result in a value of TYPE_FIELD
347 ast_expression *m_field;
352 * For now used for vectors. If we get structs or unions
353 * we can have them handled here as well.
355 struct ast_member : ast_expression
357 ast_expression *m_owner;
358 unsigned int m_field;
362 ast_member* ast_member_new(lex_ctx_t ctx, ast_expression *owner, unsigned int field, const char *name);
363 void ast_member_delete(ast_member*);
364 bool ast_member_set_name(ast_member*, const char *name);
367 /* Array index access:
369 * QC forces us to take special action on arrays:
370 * an ast_store on an ast_array_index must not codegen the index,
371 * but call its setter - unless we have an instruction set which supports
373 * Any other array index access will be codegened to a call to the getter.
374 * In any case, accessing an element via a compiletime-constant index will
375 * result in quick access to that variable.
377 struct ast_array_index : ast_expression
379 ast_expression *m_array;
380 ast_expression *m_index;
382 ast_array_index* ast_array_index_new(lex_ctx_t ctx, ast_expression *array, ast_expression *index);
386 * copy all varargs starting from a specific index
388 struct ast_argpipe : ast_expression
390 ast_expression *m_index;
392 ast_argpipe* ast_argpipe_new(lex_ctx_t ctx, ast_expression *index);
396 * Stores left<-right and returns left.
397 * Specialized binary expression node
399 struct ast_store : ast_expression
402 ast_expression *m_dest;
403 ast_expression *m_source;
405 ast_store* ast_store_new(lex_ctx_t ctx, int op,
406 ast_expression *d, ast_expression *s);
410 * A general 'if then else' statement, either side can be nullptr and will
411 * thus be omitted. It is an error for *both* cases to be nullptr at once.
413 * During its 'codegen' it'll be changing the ast_function's block.
415 * An if is also an "expression". Its codegen will put nullptr into the
416 * output field though. For ternary expressions an ast_ternary will be
419 struct ast_ifthen : ast_expression
421 ast_expression *m_cond;
422 /* It's all just 'expressions', since an ast_block is one too. */
423 ast_expression *m_on_true;
424 ast_expression *m_on_false;
426 ast_ifthen* ast_ifthen_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
428 /* Ternary expressions...
430 * Contrary to 'if-then-else' nodes, ternary expressions actually
431 * return a value, otherwise they behave the very same way.
432 * The difference in 'codegen' is that it'll return the value of
435 * The other difference is that in an ast_ternary, NEITHER side
436 * must be nullptr, there's ALWAYS an else branch.
438 * This is the only ast_node beside ast_value which contains
439 * an ir_value. Theoretically we don't need to remember it though.
441 struct ast_ternary : ast_expression
443 ast_expression *m_cond;
444 /* It's all just 'expressions', since an ast_block is one too. */
445 ast_expression *m_on_true;
446 ast_expression *m_on_false;
448 ast_ternary* ast_ternary_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
450 /* A general loop node
452 * For convenience it contains 4 parts:
453 * -) (ini) = initializing expression
454 * -) (pre) = pre-loop condition
455 * -) (pst) = post-loop condition
456 * -) (inc) = "increment" expression
457 * The following is a psudo-representation of this loop
458 * note that '=>' bears the logical meaning of "implies".
459 * (a => b) equals (!a || b)
462 while (has_pre => {pre})
466 continue: // a 'continue' will jump here
467 if (has_pst => {pst})
473 struct ast_loop : ast_expression
475 ast_expression *m_initexpr;
476 ast_expression *m_precond;
477 ast_expression *m_postcond;
478 ast_expression *m_increment;
479 ast_expression *m_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 : ast_expression
501 unsigned int m_levels;
503 ast_breakcont* ast_breakcont_new(lex_ctx_t ctx, bool iscont, unsigned int levels);
507 * A few notes about this: with the original QCVM, no real optimization
508 * is possible. The SWITCH instruction set isn't really helping a lot, since
509 * it only collapes the EQ and IF instructions into one.
510 * Note: Declaring local variables inside caseblocks is normal.
511 * Since we don't have to deal with a stack there's no unnatural behaviour to
512 * be expected from it.
515 struct ast_switch_case {
516 ast_expression *m_value; /* #20 will replace this */
517 ast_expression *m_code;
520 struct ast_switch : ast_expression
522 ast_expression *m_operand;
523 std::vector<ast_switch_case> m_cases;
526 ast_switch* ast_switch_new(lex_ctx_t ctx, ast_expression *op);
530 * Introduce a label which can be used together with 'goto'
532 struct ast_label : ast_expression
536 std::vector<ast_goto*> m_gotos;
538 /* means it has not yet been defined */
542 ast_label* ast_label_new(lex_ctx_t ctx, const char *name, bool undefined);
546 * Go to a label, the label node is filled in at a later point!
548 struct ast_goto : ast_expression
552 ir_block *m_irblock_from;
555 ast_goto* ast_goto_new(lex_ctx_t ctx, const char *name);
556 void ast_goto_set_label(ast_goto*, ast_label*);
560 * For frame/think state updates: void foo() [framenum, nextthink] {}
562 struct ast_state : ast_expression
564 ast_expression *m_framenum;
565 ast_expression *m_nextthink;
567 ast_state* ast_state_new(lex_ctx_t ctx, ast_expression *frame, ast_expression *think);
568 void ast_state_delete(ast_state*);
572 * Contains an ast_expression as target, rather than an ast_function/value.
573 * Since it's how QC works, every ast_function has an ast_value
574 * associated anyway - in other words, the VM contains function
575 * pointers for every function anyway. Thus, this node will call
577 * Additionally it contains a list of ast_expressions as parameters.
578 * Since calls can return values, an ast_call is also an ast_expression.
580 struct ast_call : ast_expression
582 ast_expression *m_func;
583 std::vector<ast_expression *> m_params;
584 ast_expression *m_va_count;
586 ast_call* ast_call_new(lex_ctx_t ctx,
587 ast_expression *funcexpr);
588 bool ast_call_check_types(ast_call*, ast_expression *this_func_va_type);
593 struct ast_block : ast_expression
595 std::vector<ast_value*> m_locals;
596 std::vector<ast_expression*> m_exprs;
597 std::vector<ast_expression*> m_collect;
599 ast_block* ast_block_new(lex_ctx_t ctx);
600 void ast_block_delete(ast_block*);
601 void ast_block_set_type(ast_block*, ast_expression *from);
602 void ast_block_collect(ast_block*, ast_expression*);
604 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
608 * Contains a list of blocks... at least in theory.
609 * Usually there's just the main block, other blocks are inside that.
611 * Technically, functions don't need to be an AST node, since we have
612 * neither functions inside functions, nor lambdas, and function
613 * pointers could just work with a name. However, this way could be
614 * more flexible, and adds no real complexity.
616 struct ast_function : ast_node
618 ast_value *m_function_type;
623 /* list of used-up names for statics without the count suffix */
624 std::vector<char*> m_static_names;
625 /* number of static variables, by convention this includes the
626 * ones without the count-suffix - remember this when dealing
627 * with savegames. uint instead of size_t as %zu in printf is
628 * C99, so no windows support. */
629 unsigned int m_static_count;
631 ir_function *m_ir_func;
632 ir_block *m_curblock;
633 std::vector<ir_block*> m_breakblocks;
634 std::vector<ir_block*> m_continueblocks;
637 /* in order for thread safety - for the optional
638 * channel abesed multithreading... keeping a buffer
639 * here to use in ast_function_label.
642 std::vector<std::unique_ptr<ast_block>> m_blocks;
643 ast_value *m_varargs;
645 ast_value *m_fixedparams;
646 ast_value *m_return_value;
648 ast_function* ast_function_new(lex_ctx_t ctx, const char *name, ast_value *vtype);
649 /* This will NOT delete the underlying ast_value */
650 void ast_function_delete(ast_function*);
651 /* For "optimized" builds this can just keep returning "foo"...
654 const char* ast_function_label(ast_function*, const char *prefix);
656 bool ast_function_codegen(ast_function *self, ir_builder *builder);
657 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
660 * If the condition creates a situation where this becomes -1 size it means there are
661 * more AST_FLAGs than the type ast_flag_t is capable of holding. So either eliminate
662 * the AST flag count or change the ast_flag_t typedef to a type large enough to accomodate
665 typedef int static_assert_is_ast_flag_safe [((AST_FLAG_LAST) <= (ast_flag_t)(-1)) ? 1 : -1];