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)->node_type == (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_node: if a node contains this node, 'keep_node'
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_node) ) { \
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 : ast_node {
147 ast_expression_codegen *codegen;
149 ast_expression *next;
150 /* arrays get a member-count */
152 std::vector<ast_value*> type_params;
155 /* void foo(string...) gets varparam set as a restriction
156 * for variadic parameters
158 ast_expression *varparam;
159 /* The codegen functions should store their output values
160 * so we can call it multiple times without re-evaluating.
161 * Store lvalue and rvalue seperately though. So that
162 * ast_entfield for example can generate both if required.
170 * Types are also values, both have a type and a name.
171 * especially considering possible constructs like typedefs.
173 * is like creating a 'float foo', foo serving as the type's name.
175 union basic_value_t {
185 struct ast_value : ast_expression
190 const char *argcounter;
192 int cvq; /* const/var qualifier */
193 bool isfield; /* this declares a field */
194 bool isimm; /* an immediate, not just const */
196 bool inexact; /* inexact coming from folded expression */
197 basic_value_t constval;
198 /* for TYPE_ARRAY we have an optional vector
199 * of constants when an initializer list
202 std::vector<basic_value_t> initlist;
204 /* usecount for the parser */
208 ir_value **ir_values;
209 size_t ir_value_count;
211 /* ONLY for arrays in progs version up to 6 */
216 bool intrinsic; /* true if associated with intrinsic */
219 ast_value* ast_value_new(lex_ctx_t ctx, const char *name, qc_type qctype);
220 ast_value* ast_value_copy(const ast_value *self);
221 /* This will NOT delete an underlying ast_function */
222 void ast_value_delete(ast_value*);
224 bool ast_value_set_name(ast_value*, const char *name);
227 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
228 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
231 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
233 void ast_value_params_add(ast_value*, ast_value*);
235 bool ast_compare_type(ast_expression *a, ast_expression *b);
236 ast_expression* ast_type_copy(lex_ctx_t ctx, const ast_expression *ex);
237 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
238 void ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
239 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
241 enum ast_binary_ref {
243 AST_REF_LEFT = 1 << 1,
244 AST_REF_RIGHT = 1 << 2,
245 AST_REF_ALL = (AST_REF_LEFT | AST_REF_RIGHT)
251 * A value-returning binary expression.
253 struct ast_binary : ast_expression
256 ast_expression *left;
257 ast_expression *right;
261 ast_binary* ast_binary_new(lex_ctx_t ctx,
263 ast_expression *left,
264 ast_expression *right);
268 * An assignment including a binary expression with the source as left operand.
269 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
271 struct ast_binstore : ast_expression
275 ast_expression *dest;
276 ast_expression *source;
277 /* for &~= which uses the destination in a binary in source we can use this */
280 ast_binstore* ast_binstore_new(lex_ctx_t ctx,
283 ast_expression *left,
284 ast_expression *right);
288 * Regular unary expressions: not,neg
290 struct ast_unary : ast_expression
293 ast_expression *operand;
295 ast_unary* ast_unary_new(lex_ctx_t ctx,
297 ast_expression *expr);
301 * Make sure 'return' only happens at the end of a block, otherwise the IR
302 * will refuse to create further instructions.
303 * This should be honored by the parser.
305 struct ast_return : ast_expression
307 ast_expression *operand;
309 ast_return* ast_return_new(lex_ctx_t ctx,
310 ast_expression *expr);
314 * This must do 2 things:
315 * -) Provide a way to fetch an entity field value. (Rvalue)
316 * -) Provide a pointer to an entity field. (Lvalue)
318 * In original QC, there's only a STORE via pointer, but
319 * no LOAD via pointer.
320 * So we must know beforehand if we are going to read or assign
322 * For this we will have to extend the codegen() functions with
323 * a flag saying whether or not we need an L or an R-value.
325 struct ast_entfield : ast_expression
327 /* The entity can come from an expression of course. */
328 ast_expression *entity;
329 /* As can the field, it just must result in a value of TYPE_FIELD */
330 ast_expression *field;
332 ast_entfield* ast_entfield_new(lex_ctx_t ctx, ast_expression *entity, ast_expression *field);
333 ast_entfield* ast_entfield_new_force(lex_ctx_t ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
337 * For now used for vectors. If we get structs or unions
338 * we can have them handled here as well.
340 struct ast_member : ast_expression
342 ast_expression *owner;
347 ast_member* ast_member_new(lex_ctx_t ctx, ast_expression *owner, unsigned int field, const char *name);
348 void ast_member_delete(ast_member*);
349 bool ast_member_set_name(ast_member*, const char *name);
352 /* Array index access:
354 * QC forces us to take special action on arrays:
355 * an ast_store on an ast_array_index must not codegen the index,
356 * but call its setter - unless we have an instruction set which supports
358 * Any other array index access will be codegened to a call to the getter.
359 * In any case, accessing an element via a compiletime-constant index will
360 * result in quick access to that variable.
362 struct ast_array_index : ast_expression
364 ast_expression *array;
365 ast_expression *index;
367 ast_array_index* ast_array_index_new(lex_ctx_t ctx, ast_expression *array, ast_expression *index);
371 * copy all varargs starting from a specific index
373 struct ast_argpipe : ast_expression
375 ast_expression *index;
377 ast_argpipe* ast_argpipe_new(lex_ctx_t ctx, ast_expression *index);
381 * Stores left<-right and returns left.
382 * Specialized binary expression node
384 struct ast_store : ast_expression
387 ast_expression *dest;
388 ast_expression *source;
390 ast_store* ast_store_new(lex_ctx_t ctx, int op,
391 ast_expression *d, ast_expression *s);
395 * A general 'if then else' statement, either side can be nullptr and will
396 * thus be omitted. It is an error for *both* cases to be nullptr at once.
398 * During its 'codegen' it'll be changing the ast_function's block.
400 * An if is also an "expression". Its codegen will put nullptr into the
401 * output field though. For ternary expressions an ast_ternary will be
404 struct ast_ifthen : ast_expression
406 ast_expression *cond;
407 /* It's all just 'expressions', since an ast_block is one too. */
408 ast_expression *on_true;
409 ast_expression *on_false;
411 ast_ifthen* ast_ifthen_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
413 /* Ternary expressions...
415 * Contrary to 'if-then-else' nodes, ternary expressions actually
416 * return a value, otherwise they behave the very same way.
417 * The difference in 'codegen' is that it'll return the value of
420 * The other difference is that in an ast_ternary, NEITHER side
421 * must be nullptr, there's ALWAYS an else branch.
423 * This is the only ast_node beside ast_value which contains
424 * an ir_value. Theoretically we don't need to remember it though.
426 struct ast_ternary : ast_expression
428 ast_expression *cond;
429 /* It's all just 'expressions', since an ast_block is one too. */
430 ast_expression *on_true;
431 ast_expression *on_false;
433 ast_ternary* ast_ternary_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
435 /* A general loop node
437 * For convenience it contains 4 parts:
438 * -) (ini) = initializing expression
439 * -) (pre) = pre-loop condition
440 * -) (pst) = post-loop condition
441 * -) (inc) = "increment" expression
442 * The following is a psudo-representation of this loop
443 * note that '=>' bears the logical meaning of "implies".
444 * (a => b) equals (!a || b)
447 while (has_pre => {pre})
451 continue: // a 'continue' will jump here
452 if (has_pst => {pst})
458 struct ast_loop : ast_expression
460 ast_expression *initexpr;
461 ast_expression *precond;
462 ast_expression *postcond;
463 ast_expression *increment;
464 ast_expression *body;
465 /* For now we allow a seperate flag on whether or not the condition
466 * is supposed to be true or false.
467 * That way, the parser can generate a 'while not(!x)' for `while(x)`
468 * if desired, which is useful for the new -f{true,false}-empty-strings
474 ast_loop* ast_loop_new(lex_ctx_t ctx,
475 ast_expression *initexpr,
476 ast_expression *precond, bool pre_not,
477 ast_expression *postcond, bool post_not,
478 ast_expression *increment,
479 ast_expression *body);
483 struct ast_breakcont : ast_expression
488 ast_breakcont* ast_breakcont_new(lex_ctx_t ctx, bool iscont, unsigned int levels);
492 * A few notes about this: with the original QCVM, no real optimization
493 * is possible. The SWITCH instruction set isn't really helping a lot, since
494 * it only collapes the EQ and IF instructions into one.
495 * Note: Declaring local variables inside caseblocks is normal.
496 * Since we don't have to deal with a stack there's no unnatural behaviour to
497 * be expected from it.
500 struct ast_switch_case {
501 ast_expression *value; /* #20 will replace this */
502 ast_expression *code;
505 struct ast_switch : ast_expression
507 ast_expression *operand;
508 std::vector<ast_switch_case> cases;
511 ast_switch* ast_switch_new(lex_ctx_t ctx, ast_expression *op);
515 * Introduce a label which can be used together with 'goto'
517 struct ast_label : ast_expression
521 std::vector<ast_goto*> gotos;
523 /* means it has not yet been defined */
527 ast_label* ast_label_new(lex_ctx_t ctx, const char *name, bool undefined);
531 * Go to a label, the label node is filled in at a later point!
533 struct ast_goto : ast_expression
537 ir_block *irblock_from;
540 ast_goto* ast_goto_new(lex_ctx_t ctx, const char *name);
541 void ast_goto_set_label(ast_goto*, ast_label*);
545 * For frame/think state updates: void foo() [framenum, nextthink] {}
547 struct ast_state : ast_expression
549 ast_expression *framenum;
550 ast_expression *nextthink;
552 ast_state* ast_state_new(lex_ctx_t ctx, ast_expression *frame, ast_expression *think);
553 void ast_state_delete(ast_state*);
557 * Contains an ast_expression as target, rather than an ast_function/value.
558 * Since it's how QC works, every ast_function has an ast_value
559 * associated anyway - in other words, the VM contains function
560 * pointers for every function anyway. Thus, this node will call
562 * Additionally it contains a list of ast_expressions as parameters.
563 * Since calls can return values, an ast_call is also an ast_expression.
565 struct ast_call : ast_expression
567 ast_expression *func;
568 std::vector<ast_expression *> params;
569 ast_expression *va_count;
571 ast_call* ast_call_new(lex_ctx_t ctx,
572 ast_expression *funcexpr);
573 bool ast_call_check_types(ast_call*, ast_expression *this_func_va_type);
578 struct ast_block : ast_expression
580 std::vector<ast_value*> locals;
581 std::vector<ast_expression*> exprs;
582 std::vector<ast_expression*> collect;
584 ast_block* ast_block_new(lex_ctx_t ctx);
585 void ast_block_delete(ast_block*);
586 void ast_block_set_type(ast_block*, ast_expression *from);
587 void ast_block_collect(ast_block*, ast_expression*);
589 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
593 * Contains a list of blocks... at least in theory.
594 * Usually there's just the main block, other blocks are inside that.
596 * Technically, functions don't need to be an AST node, since we have
597 * neither functions inside functions, nor lambdas, and function
598 * pointers could just work with a name. However, this way could be
599 * more flexible, and adds no real complexity.
605 ast_value *function_type;
610 /* list of used-up names for statics without the count suffix */
611 std::vector<char*> static_names;
612 /* number of static variables, by convention this includes the
613 * ones without the count-suffix - remember this when dealing
614 * with savegames. uint instead of size_t as %zu in printf is
615 * C99, so no windows support. */
616 unsigned int static_count;
618 ir_function *ir_func;
620 std::vector<ir_block*> breakblocks;
621 std::vector<ir_block*> continueblocks;
624 /* in order for thread safety - for the optional
625 * channel abesed multithreading... keeping a buffer
626 * here to use in ast_function_label.
629 std::vector<std::unique_ptr<ast_block>> blocks;
632 ast_value *fixedparams;
633 ast_value *return_value;
635 ast_function* ast_function_new(lex_ctx_t ctx, const char *name, ast_value *vtype);
636 /* This will NOT delete the underlying ast_value */
637 void ast_function_delete(ast_function*);
638 /* For "optimized" builds this can just keep returning "foo"...
641 const char* ast_function_label(ast_function*, const char *prefix);
643 bool ast_function_codegen(ast_function *self, ir_builder *builder);
644 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
647 * If the condition creates a situation where this becomes -1 size it means there are
648 * more AST_FLAGs than the type ast_flag_t is capable of holding. So either eliminate
649 * the AST flag count or change the ast_flag_t typedef to a type large enough to accomodate
652 typedef int static_assert_is_ast_flag_safe [((AST_FLAG_LAST) <= (ast_flag_t)(-1)) ? 1 : -1];