2 * Copyright (C) 2012, 2013
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_range_s ast_range;
55 typedef struct ast_label_s ast_label;
56 typedef struct ast_goto_s ast_goto;
57 typedef struct ast_argpipe_s ast_argpipe;
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,
72 * An array declared as []
73 * so that the size is taken from the initializer
75 AST_FLAG_ARRAY_INIT = 1 << 10,
77 AST_FLAG_FINAL_DECL = 1 << 11,
80 AST_FLAG_TYPE_MASK = (AST_FLAG_VARIADIC | AST_FLAG_NORETURN)
84 TYPE_ast_node, /* 0 */
85 TYPE_ast_expression, /* 1 */
86 TYPE_ast_value, /* 2 */
87 TYPE_ast_function, /* 3 */
88 TYPE_ast_block, /* 4 */
89 TYPE_ast_binary, /* 5 */
90 TYPE_ast_store, /* 6 */
91 TYPE_ast_binstore, /* 7 */
92 TYPE_ast_entfield, /* 8 */
93 TYPE_ast_ifthen, /* 9 */
94 TYPE_ast_ternary, /* 10 */
95 TYPE_ast_loop, /* 11 */
96 TYPE_ast_call, /* 12 */
97 TYPE_ast_unary, /* 13 */
98 TYPE_ast_return, /* 14 */
99 TYPE_ast_member, /* 15 */
100 TYPE_ast_array_index, /* 16 */
101 TYPE_ast_breakcont, /* 17 */
102 TYPE_ast_range, /* 18 */
103 TYPE_ast_switch, /* 19 */
104 TYPE_ast_label, /* 20 */
105 TYPE_ast_goto, /* 21 */
106 TYPE_ast_argpipe /* 22 */
109 #define ast_istype(x, t) ( ((ast_node*)x)->nodetype == (TYPE_##t) )
110 #define ast_ctx(node) (((ast_node*)(node))->context)
111 #define ast_side_effects(node) (((ast_node*)(node))->side_effects)
113 /* Node interface with common components
115 typedef void ast_node_delete(ast_node*);
116 struct ast_node_common
119 /* I don't feel comfortable using keywords like 'delete' as names... */
120 ast_node_delete *destroy;
122 /* keep: if a node contains this node, 'keep'
123 * prevents its dtor from destroying this node as well.
129 #define ast_delete(x) (*( ((ast_node*)(x))->destroy ))((ast_node*)(x))
130 #define ast_unref(x) do \
132 if (! (((ast_node*)(x))->keep) ) { \
137 /* Expression interface
139 * Any expression or block returns an ir_value, and needs
140 * to know the current function.
142 typedef bool ast_expression_codegen(ast_expression*,
146 /* TODO: the codegen function should take an output-type parameter
147 * indicating whether a variable, type, label etc. is expected, and
149 * Then later an ast_ident could have a codegen using this to figure
150 * out what to look for.
151 * eg. in code which uses a not-yet defined variable, the expression
152 * would take an ast_ident, and the codegen would be called with
153 * type `expression`, so the ast_ident's codegen would search for
154 * variables through the environment (or functions, constants...).
156 struct ast_expression_common
159 ast_expression_codegen *codegen;
161 ast_expression *next;
162 /* arrays get a member-count */
166 /* void foo(string...) gets varparam set as a restriction
167 * for variadic parameters
169 ast_expression *varparam;
170 /* The codegen functions should store their output values
171 * so we can call it multiple times without re-evaluating.
172 * Store lvalue and rvalue seperately though. So that
173 * ast_entfield for example can generate both if required.
181 * Types are also values, both have a type and a name.
182 * especially considering possible constructs like typedefs.
184 * is like creating a 'float foo', foo serving as the type's name.
198 ast_expression expression;
203 const char *argcounter;
205 int cvq; /* const/var qualifier */
206 bool isfield; /* this declares a field */
207 bool isimm; /* an immediate, not just const */
209 basic_value_t constval;
210 /* for TYPE_ARRAY we have an optional vector
211 * of constants when an initializer list
214 basic_value_t *initlist;
216 /* usecount for the parser */
220 ir_value **ir_values;
221 size_t ir_value_count;
223 /* ONLY for arrays in progs version up to 6 */
228 bool intrinsic; /* true if associated with intrinsic */
231 ast_value* ast_value_new(lex_ctx_t ctx, const char *name, int qctype);
232 ast_value* ast_value_copy(const ast_value *self);
233 /* This will NOT delete an underlying ast_function */
234 void ast_value_delete(ast_value*);
236 bool ast_value_set_name(ast_value*, const char *name);
239 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
240 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
243 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
245 void ast_value_params_add(ast_value*, ast_value*);
247 bool ast_compare_type(ast_expression *a, ast_expression *b);
248 ast_expression* ast_type_copy(lex_ctx_t ctx, const ast_expression *ex);
249 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
250 void ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
251 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
253 typedef enum ast_binary_ref_s {
255 AST_REF_LEFT = 1 << 1,
256 AST_REF_RIGHT = 1 << 2,
257 AST_REF_ALL = (AST_REF_LEFT | AST_REF_RIGHT)
263 * A value-returning binary expression.
267 ast_expression expression;
270 ast_expression *left;
271 ast_expression *right;
275 ast_binary* ast_binary_new(lex_ctx_t ctx,
277 ast_expression *left,
278 ast_expression *right);
282 * An assignment including a binary expression with the source as left operand.
283 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
285 struct ast_binstore_s
287 ast_expression expression;
291 ast_expression *dest;
292 ast_expression *source;
293 /* for &~= which uses the destination in a binary in source we can use this */
296 ast_binstore* ast_binstore_new(lex_ctx_t ctx,
299 ast_expression *left,
300 ast_expression *right);
304 * Regular unary expressions: not,neg
308 ast_expression expression;
311 ast_expression *operand;
313 ast_unary* ast_unary_new(lex_ctx_t ctx,
315 ast_expression *expr);
319 * Make sure 'return' only happens at the end of a block, otherwise the IR
320 * will refuse to create further instructions.
321 * This should be honored by the parser.
325 ast_expression expression;
326 ast_expression *operand;
328 ast_return* ast_return_new(lex_ctx_t ctx,
329 ast_expression *expr);
333 * This must do 2 things:
334 * -) Provide a way to fetch an entity field value. (Rvalue)
335 * -) Provide a pointer to an entity field. (Lvalue)
337 * In original QC, there's only a STORE via pointer, but
338 * no LOAD via pointer.
339 * So we must know beforehand if we are going to read or assign
341 * For this we will have to extend the codegen() functions with
342 * a flag saying whether or not we need an L or an R-value.
344 struct ast_entfield_s
346 ast_expression expression;
347 /* The entity can come from an expression of course. */
348 ast_expression *entity;
349 /* As can the field, it just must result in a value of TYPE_FIELD */
350 ast_expression *field;
352 ast_entfield* ast_entfield_new(lex_ctx_t ctx, ast_expression *entity, ast_expression *field);
353 ast_entfield* ast_entfield_new_force(lex_ctx_t ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
357 * For now used for vectors. If we get structs or unions
358 * we can have them handled here as well.
362 ast_expression expression;
363 ast_expression *owner;
368 ast_member* ast_member_new(lex_ctx_t ctx, ast_expression *owner, unsigned int field, const char *name);
369 void ast_member_delete(ast_member*);
370 bool ast_member_set_name(ast_member*, const char *name);
373 /* Array index access:
375 * QC forces us to take special action on arrays:
376 * an ast_store on an ast_array_index must not codegen the index,
377 * but call its setter - unless we have an instruction set which supports
379 * Any other array index access will be codegened to a call to the getter.
380 * In any case, accessing an element via a compiletime-constant index will
381 * result in quick access to that variable.
383 struct ast_array_index_s
385 ast_expression expression;
386 ast_expression *array;
387 ast_expression *index;
389 ast_array_index* ast_array_index_new(lex_ctx_t ctx, ast_expression *array, ast_expression *index);
393 * copy all varargs starting from a specific index
397 ast_expression expression;
398 ast_expression *index;
400 ast_argpipe* ast_argpipe_new(lex_ctx_t ctx, ast_expression *index);
404 * Stores left<-right and returns left.
405 * Specialized binary expression node
409 ast_expression expression;
411 ast_expression *dest;
412 ast_expression *source;
414 ast_store* ast_store_new(lex_ctx_t ctx, int op,
415 ast_expression *d, ast_expression *s);
419 * A general 'if then else' statement, either side can be NULL and will
420 * thus be omitted. It is an error for *both* cases to be NULL at once.
422 * During its 'codegen' it'll be changing the ast_function's block.
424 * An if is also an "expression". Its codegen will put NULL into the
425 * output field though. For ternary expressions an ast_ternary will be
430 ast_expression expression;
431 ast_expression *cond;
432 /* It's all just 'expressions', since an ast_block is one too. */
433 ast_expression *on_true;
434 ast_expression *on_false;
436 ast_ifthen* ast_ifthen_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
438 /* Ternary expressions...
440 * Contrary to 'if-then-else' nodes, ternary expressions actually
441 * return a value, otherwise they behave the very same way.
442 * The difference in 'codegen' is that it'll return the value of
445 * The other difference is that in an ast_ternary, NEITHER side
446 * must be NULL, there's ALWAYS an else branch.
448 * This is the only ast_node beside ast_value which contains
449 * an ir_value. Theoretically we don't need to remember it though.
453 ast_expression expression;
454 ast_expression *cond;
455 /* It's all just 'expressions', since an ast_block is one too. */
456 ast_expression *on_true;
457 ast_expression *on_false;
459 ast_ternary* ast_ternary_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
461 /* A general loop node
463 * For convenience it contains 4 parts:
464 * -) (ini) = initializing expression
465 * -) (pre) = pre-loop condition
466 * -) (pst) = post-loop condition
467 * -) (inc) = "increment" expression
468 * The following is a psudo-representation of this loop
469 * note that '=>' bears the logical meaning of "implies".
470 * (a => b) equals (!a || b)
473 while (has_pre => {pre})
477 continue: // a 'continue' will jump here
478 if (has_pst => {pst})
486 ast_expression expression;
487 ast_expression *initexpr;
488 ast_expression *precond;
489 ast_expression *postcond;
490 ast_expression *increment;
491 ast_expression *body;
492 /* For now we allow a seperate flag on whether or not the condition
493 * is supposed to be true or false.
494 * That way, the parser can generate a 'while not(!x)' for `while(x)`
495 * if desired, which is useful for the new -f{true,false}-empty-strings
501 ast_loop* ast_loop_new(lex_ctx_t ctx,
502 ast_expression *initexpr,
503 ast_expression *precond, bool pre_not,
504 ast_expression *postcond, bool post_not,
505 ast_expression *increment,
506 ast_expression *body);
510 struct ast_breakcont_s
512 ast_expression expression;
516 ast_breakcont* ast_breakcont_new(lex_ctx_t ctx, bool iscont, unsigned int levels);
520 * A few notes about this: with the original QCVM, no real optimization
521 * is possible. The SWITCH instruction set isn't really helping a lot, since
522 * it only collapes the EQ and IF instructions into one.
523 * Note: Declaring local variables inside caseblocks is normal.
524 * Since we don't have to deal with a stack there's no unnatural behaviour to
525 * be expected from it.
529 ast_expression *value; /* #20 will replace this */
530 ast_expression *code;
534 ast_expression expression;
536 ast_expression *operand;
537 ast_switch_case *cases;
540 ast_switch* ast_switch_new(lex_ctx_t ctx, ast_expression *op);
545 * Used to implement any/all ranges, which are inclusive only.
546 * This any / all are range specifiers which change the semantics of
547 * how the range expression is dealt with. Because of the nature of ranges
548 * the whole expression it's used in needs to be rewrote. A table of how
549 * the rewrite works is provided below:
551 * (a == any b .. c) -> (a >= b && a <= c)
552 * (a == all b .. c) -> error (makes no sense)
553 * (a != any b .. c) -> error (makes no sense)
554 * (a != all b .. c) -> (a < b || a > c)
555 * (a <= any b .. c) -> (a <= c)
556 * (a <= all b .. c) -> (a <= b)
557 * (a >= any b .. c) -> (a >= b)
558 * (a >= all b .. c) -> (a >= c)
559 * (a < any b .. c) -> (a < c)
560 * (a < all b .. c) -> (a < b)
561 * (a > any b .. c) -> (a > b)
562 * (a > all b .. c) -> (a > c)
563 * (a <=> any b .. c) -> error (why would you even try)
564 * (a <=> all b .. c) -> error (why would you even try)
567 ast_expression expression;
568 ast_expression *lower;
569 ast_expression *upper;
572 ast_range* ast_range_new(lex_ctx_t ctx, ast_expression *lower, ast_expression *upper);
576 * Introduce a label which can be used together with 'goto'
580 ast_expression expression;
585 /* means it has not yet been defined */
589 ast_label* ast_label_new(lex_ctx_t ctx, const char *name, bool undefined);
593 * Go to a label, the label node is filled in at a later point!
597 ast_expression expression;
600 ir_block *irblock_from;
603 ast_goto* ast_goto_new(lex_ctx_t ctx, const char *name);
604 void ast_goto_set_label(ast_goto*, ast_label*);
608 * Contains an ast_expression as target, rather than an ast_function/value.
609 * Since it's how QC works, every ast_function has an ast_value
610 * associated anyway - in other words, the VM contains function
611 * pointers for every function anyway. Thus, this node will call
613 * Additionally it contains a list of ast_expressions as parameters.
614 * Since calls can return values, an ast_call is also an ast_expression.
618 ast_expression expression;
619 ast_expression *func;
620 ast_expression **params;
621 ast_expression *va_count;
623 ast_call* ast_call_new(lex_ctx_t ctx,
624 ast_expression *funcexpr);
625 bool ast_call_check_types(ast_call*, ast_expression *this_func_va_type);
632 ast_expression expression;
635 ast_expression* *exprs;
636 ast_expression* *collect;
638 ast_block* ast_block_new(lex_ctx_t ctx);
639 void ast_block_delete(ast_block*);
640 void ast_block_set_type(ast_block*, ast_expression *from);
641 void ast_block_collect(ast_block*, ast_expression*);
643 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
647 * Contains a list of blocks... at least in theory.
648 * Usually there's just the main block, other blocks are inside that.
650 * Technically, functions don't need to be an AST node, since we have
651 * neither functions inside functions, nor lambdas, and function
652 * pointers could just work with a name. However, this way could be
653 * more flexible, and adds no real complexity.
655 struct ast_function_s
664 /* list of used-up names for statics without the count suffix */
666 /* number of static variables, by convention this includes the
667 * ones without the count-suffix - remember this when dealing
668 * with savegames. uint instead of size_t as %zu in printf is
669 * C99, so no windows support. */
670 unsigned int static_count;
672 ir_function *ir_func;
674 ir_block **breakblocks;
675 ir_block **continueblocks;
678 /* In order for early-out logic not to go over
679 * excessive jumps, we remember their target
687 /* in order for thread safety - for the optional
688 * channel abesed multithreading... keeping a buffer
689 * here to use in ast_function_label.
697 ast_value *fixedparams;
698 ast_value *return_value;
700 ast_function* ast_function_new(lex_ctx_t ctx, const char *name, ast_value *vtype);
701 /* This will NOT delete the underlying ast_value */
702 void ast_function_delete(ast_function*);
703 /* For "optimized" builds this can just keep returning "foo"...
706 const char* ast_function_label(ast_function*, const char *prefix);
708 bool ast_function_codegen(ast_function *self, ir_builder *builder);
709 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
712 * If the condition creates a situation where this becomes -1 size it means there are
713 * more AST_FLAGs than the type ast_flag_t is capable of holding. So either eliminate
714 * the AST flag count or change the ast_flag_t typedef to a type large enough to accomodate
717 typedef int static_assert_is_ast_flag_safe [((AST_FLAG_LAST) <= (ast_flag_t)(-1)) ? 1 : -1];