e721afc1b7a7501f088099b0a1df9a7b4e2970d6
[xonotic/gmqcc.git] / ast.h
1 #ifndef GMQCC_AST_HDR
2 #define GMQCC_AST_HDR
3 #include <vector>
4 #include "ir.h"
5
6 typedef uint16_t ast_flag_t;
7
8 /* Note: I will not be using a _t suffix for the
9  * "main" ast node types for now.
10  */
11
12 struct ast_node;
13 struct ast_expression;
14 struct ast_value;
15 struct ast_function;
16 struct ast_block;
17 struct ast_binary;
18 struct ast_store;
19 struct ast_binstore;
20 struct ast_entfield;
21 struct ast_ifthen;
22 struct ast_ternary;
23 struct ast_loop;
24 struct ast_call;
25 struct ast_unary;
26 struct ast_return;
27 struct ast_member;
28 struct ast_array_index;
29 struct ast_breakcont;
30 struct ast_switch;
31 struct ast_label;
32 struct ast_goto;
33 struct ast_argpipe;
34 struct ast_state;
35
36 enum {
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,
47
48     /* An array declared as []
49      * so that the size is taken from the initializer
50      */
51     AST_FLAG_ARRAY_INIT     = 1 << 10,
52
53     AST_FLAG_FINAL_DECL     = 1 << 11,
54
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.
61      */
62     AST_FLAG_COVERAGE       = 1 << 12,
63     AST_FLAG_BLOCK_COVERAGE = 1 << 13,
64
65     AST_FLAG_LAST,
66     AST_FLAG_TYPE_MASK      = (AST_FLAG_VARIADIC | AST_FLAG_NORETURN),
67     AST_FLAG_COVERAGE_MASK  = (AST_FLAG_BLOCK_COVERAGE)
68 };
69
70 enum {
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 */
94 };
95
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)
99
100 /* Node interface with common components
101  */
102 typedef void ast_node_delete(ast_node*);
103
104 struct ast_node
105 {
106     lex_ctx_t context;
107     /* I don't feel comfortable using keywords like 'delete' as names... */
108     ast_node_delete *destroy;
109     int              node_type;
110     /* keep_node: if a node contains this node, 'keep_node'
111      * prevents its dtor from destroying this node as well.
112      */
113     bool             keep_node;
114     bool             side_effects;
115 };
116
117 #define ast_delete(x) (*( ((ast_node*)(x))->destroy ))((ast_node*)(x))
118 #define ast_unref(x) do                     \
119 {                                           \
120     if (! (((ast_node*)(x))->keep_node) ) { \
121         ast_delete(x);                      \
122     }                                       \
123 } while(0)
124
125 /* Expression interface
126  *
127  * Any expression or block returns an ir_value, and needs
128  * to know the current function.
129  */
130 typedef bool ast_expression_codegen(ast_expression*,
131                                     ast_function*,
132                                     bool lvalue,
133                                     ir_value**);
134 /* TODO: the codegen function should take an output-type parameter
135  * indicating whether a variable, type, label etc. is expected, and
136  * an environment!
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...).
143  */
144 struct ast_expression : ast_node {
145     ast_expression() {}
146
147     ast_expression_codegen *codegen;
148     int                     vtype;
149     ast_expression         *next;
150     /* arrays get a member-count */
151     size_t                  count;
152     std::vector<ast_value*> params;
153
154     ast_flag_t              flags;
155     /* void foo(string...) gets varparam set as a restriction
156      * for variadic parameters
157      */
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.
163      */
164     ir_value               *outl;
165     ir_value               *outr;
166 };
167
168 /* Value
169  *
170  * Types are also values, both have a type and a name.
171  * especially considering possible constructs like typedefs.
172  * typedef float foo;
173  * is like creating a 'float foo', foo serving as the type's name.
174  */
175 union basic_value_t {
176     qcfloat_t vfloat;
177     int vint;
178     vec3_t vvec;
179     const char *vstring;
180     int ventity;
181     ast_function *vfunc;
182     ast_value *vfield;
183 };
184
185 struct ast_value
186 {
187     ast_expression expression;
188
189     const char *name;
190     const char *desc;
191
192     const char *argcounter;
193
194     int cvq;     /* const/var qualifier */
195     bool isfield; /* this declares a field */
196     bool isimm;   /* an immediate, not just const */
197     bool hasvalue;
198     bool inexact; /* inexact coming from folded expression */
199     basic_value_t constval;
200     /* for TYPE_ARRAY we have an optional vector
201      * of constants when an initializer list
202      * was provided.
203      */
204     std::vector<basic_value_t> initlist;
205
206     /* usecount for the parser */
207     size_t uses;
208
209     ir_value *ir_v;
210     ir_value **ir_values;
211     size_t ir_value_count;
212
213     /* ONLY for arrays in progs version up to 6 */
214     ast_value *setter;
215     ast_value *getter;
216
217
218     bool intrinsic; /* true if associated with intrinsic */
219 };
220
221 ast_value* ast_value_new(lex_ctx_t ctx, const char *name, int qctype);
222 ast_value* ast_value_copy(const ast_value *self);
223 /* This will NOT delete an underlying ast_function */
224 void ast_value_delete(ast_value*);
225
226 bool ast_value_set_name(ast_value*, const char *name);
227
228 /*
229 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
230 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
231 */
232
233 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
234
235 void ast_value_params_add(ast_value*, ast_value*);
236
237 bool ast_compare_type(ast_expression *a, ast_expression *b);
238 ast_expression* ast_type_copy(lex_ctx_t ctx, const ast_expression *ex);
239 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
240 void ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
241 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
242
243 enum ast_binary_ref {
244     AST_REF_NONE  = 0,
245     AST_REF_LEFT  = 1 << 1,
246     AST_REF_RIGHT = 1 << 2,
247     AST_REF_ALL   = (AST_REF_LEFT | AST_REF_RIGHT)
248 };
249
250
251 /* Binary
252  *
253  * A value-returning binary expression.
254  */
255 struct ast_binary
256 {
257     ast_expression expression;
258     int op;
259     ast_expression *left;
260     ast_expression *right;
261     ast_binary_ref refs;
262     bool right_first;
263 };
264 ast_binary* ast_binary_new(lex_ctx_t    ctx,
265                            int        op,
266                            ast_expression *left,
267                            ast_expression *right);
268
269 /* Binstore
270  *
271  * An assignment including a binary expression with the source as left operand.
272  * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
273  */
274 struct ast_binstore
275 {
276     ast_expression expression;
277     int opstore;
278     int opbin;
279     ast_expression *dest;
280     ast_expression *source;
281     /* for &~= which uses the destination in a binary in source we can use this */
282     bool keep_dest;
283 };
284 ast_binstore* ast_binstore_new(lex_ctx_t    ctx,
285                                int        storeop,
286                                int        op,
287                                ast_expression *left,
288                                ast_expression *right);
289
290 /* Unary
291  *
292  * Regular unary expressions: not,neg
293  */
294 struct ast_unary
295 {
296     ast_expression expression;
297     int op;
298     ast_expression *operand;
299 };
300 ast_unary* ast_unary_new(lex_ctx_t ctx,
301                          int op,
302                          ast_expression *expr);
303
304 /* Return
305  *
306  * Make sure 'return' only happens at the end of a block, otherwise the IR
307  * will refuse to create further instructions.
308  * This should be honored by the parser.
309  */
310 struct ast_return
311 {
312     ast_expression expression;
313     ast_expression *operand;
314 };
315 ast_return* ast_return_new(lex_ctx_t ctx,
316                            ast_expression *expr);
317
318 /* Entity-field
319  *
320  * This must do 2 things:
321  * -) Provide a way to fetch an entity field value. (Rvalue)
322  * -) Provide a pointer to an entity field. (Lvalue)
323  * The problem:
324  * In original QC, there's only a STORE via pointer, but
325  * no LOAD via pointer.
326  * So we must know beforehand if we are going to read or assign
327  * the field.
328  * For this we will have to extend the codegen() functions with
329  * a flag saying whether or not we need an L or an R-value.
330  */
331 struct ast_entfield
332 {
333     ast_expression expression;
334     /* The entity can come from an expression of course. */
335     ast_expression *entity;
336     /* As can the field, it just must result in a value of TYPE_FIELD */
337     ast_expression *field;
338 };
339 ast_entfield* ast_entfield_new(lex_ctx_t ctx, ast_expression *entity, ast_expression *field);
340 ast_entfield* ast_entfield_new_force(lex_ctx_t ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
341
342 /* Member access:
343  *
344  * For now used for vectors. If we get structs or unions
345  * we can have them handled here as well.
346  */
347 struct ast_member
348 {
349     ast_expression expression;
350     ast_expression *owner;
351     unsigned int field;
352     const char *name;
353     bool rvalue;
354 };
355 ast_member* ast_member_new(lex_ctx_t ctx, ast_expression *owner, unsigned int field, const char *name);
356 void ast_member_delete(ast_member*);
357 bool ast_member_set_name(ast_member*, const char *name);
358
359
360 /* Array index access:
361  *
362  * QC forces us to take special action on arrays:
363  * an ast_store on an ast_array_index must not codegen the index,
364  * but call its setter - unless we have an instruction set which supports
365  * what we need.
366  * Any other array index access will be codegened to a call to the getter.
367  * In any case, accessing an element via a compiletime-constant index will
368  * result in quick access to that variable.
369  */
370 struct ast_array_index
371 {
372     ast_expression expression;
373     ast_expression *array;
374     ast_expression *index;
375 };
376 ast_array_index* ast_array_index_new(lex_ctx_t ctx, ast_expression *array, ast_expression *index);
377
378 /* Vararg pipe node:
379  *
380  * copy all varargs starting from a specific index
381  */
382 struct ast_argpipe
383 {
384     ast_expression expression;
385     ast_expression *index;
386 };
387 ast_argpipe* ast_argpipe_new(lex_ctx_t ctx, ast_expression *index);
388
389 /* Store
390  *
391  * Stores left<-right and returns left.
392  * Specialized binary expression node
393  */
394 struct ast_store
395 {
396     ast_expression expression;
397     int op;
398     ast_expression *dest;
399     ast_expression *source;
400 };
401 ast_store* ast_store_new(lex_ctx_t ctx, int op,
402                          ast_expression *d, ast_expression *s);
403
404 /* If
405  *
406  * A general 'if then else' statement, either side can be nullptr and will
407  * thus be omitted. It is an error for *both* cases to be nullptr at once.
408  *
409  * During its 'codegen' it'll be changing the ast_function's block.
410  *
411  * An if is also an "expression". Its codegen will put nullptr into the
412  * output field though. For ternary expressions an ast_ternary will be
413  * added.
414  */
415 struct ast_ifthen
416 {
417     ast_expression expression;
418     ast_expression *cond;
419     /* It's all just 'expressions', since an ast_block is one too. */
420     ast_expression *on_true;
421     ast_expression *on_false;
422 };
423 ast_ifthen* ast_ifthen_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
424
425 /* Ternary expressions...
426  *
427  * Contrary to 'if-then-else' nodes, ternary expressions actually
428  * return a value, otherwise they behave the very same way.
429  * The difference in 'codegen' is that it'll return the value of
430  * a PHI node.
431  *
432  * The other difference is that in an ast_ternary, NEITHER side
433  * must be nullptr, there's ALWAYS an else branch.
434  *
435  * This is the only ast_node beside ast_value which contains
436  * an ir_value. Theoretically we don't need to remember it though.
437  */
438 struct ast_ternary
439 {
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;
445 };
446 ast_ternary* ast_ternary_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
447
448 /* A general loop node
449  *
450  * For convenience it contains 4 parts:
451  * -) (ini) = initializing expression
452  * -) (pre) = pre-loop condition
453  * -) (pst) = post-loop condition
454  * -) (inc) = "increment" expression
455  * The following is a psudo-representation of this loop
456  * note that '=>' bears the logical meaning of "implies".
457  * (a => b) equals (!a || b)
458
459 {ini};
460 while (has_pre => {pre})
461 {
462     {body};
463
464 continue:      // a 'continue' will jump here
465     if (has_pst => {pst})
466         break;
467
468     {inc};
469 }
470  */
471 struct ast_loop
472 {
473     ast_expression expression;
474     ast_expression *initexpr;
475     ast_expression *precond;
476     ast_expression *postcond;
477     ast_expression *increment;
478     ast_expression *body;
479     /* For now we allow a seperate flag on whether or not the condition
480      * is supposed to be true or false.
481      * That way, the parser can generate a 'while not(!x)' for `while(x)`
482      * if desired, which is useful for the new -f{true,false}-empty-strings
483      * flag.
484      */
485     bool pre_not;
486     bool post_not;
487 };
488 ast_loop* ast_loop_new(lex_ctx_t ctx,
489                        ast_expression *initexpr,
490                        ast_expression *precond, bool pre_not,
491                        ast_expression *postcond, bool post_not,
492                        ast_expression *increment,
493                        ast_expression *body);
494
495 /* Break/Continue
496  */
497 struct ast_breakcont
498 {
499     ast_expression expression;
500     bool is_continue;
501     unsigned int levels;
502 };
503 ast_breakcont* ast_breakcont_new(lex_ctx_t ctx, bool iscont, unsigned int levels);
504
505 /* Switch Statements
506  *
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.
513  * TODO: Ticket #20
514  */
515 struct ast_switch_case {
516     ast_expression *value; /* #20 will replace this */
517     ast_expression *code;
518 };
519
520 struct ast_switch
521 {
522     ast_expression expression;
523     ast_expression *operand;
524     std::vector<ast_switch_case> cases;
525 };
526
527 ast_switch* ast_switch_new(lex_ctx_t ctx, ast_expression *op);
528
529 /* Label nodes
530  *
531  * Introduce a label which can be used together with 'goto'
532  */
533 struct ast_label
534 {
535     ast_expression expression;
536     const char *name;
537     ir_block *irblock;
538     std::vector<ast_goto*> gotos;
539
540     /* means it has not yet been defined */
541     bool undefined;
542 };
543
544 ast_label* ast_label_new(lex_ctx_t ctx, const char *name, bool undefined);
545
546 /* GOTO nodes
547  *
548  * Go to a label, the label node is filled in at a later point!
549  */
550 struct ast_goto
551 {
552     ast_expression expression;
553     const char *name;
554     ast_label *target;
555     ir_block *irblock_from;
556 };
557
558 ast_goto* ast_goto_new(lex_ctx_t ctx, const char *name);
559 void ast_goto_set_label(ast_goto*, ast_label*);
560
561 /* STATE node
562  *
563  * For frame/think state updates: void foo() [framenum, nextthink] {}
564  */
565 struct ast_state
566 {
567     ast_expression expression;
568     ast_expression *framenum;
569     ast_expression *nextthink;
570 };
571 ast_state* ast_state_new(lex_ctx_t ctx, ast_expression *frame, ast_expression *think);
572 void ast_state_delete(ast_state*);
573
574 /* CALL node
575  *
576  * Contains an ast_expression as target, rather than an ast_function/value.
577  * Since it's how QC works, every ast_function has an ast_value
578  * associated anyway - in other words, the VM contains function
579  * pointers for every function anyway. Thus, this node will call
580  * expression.
581  * Additionally it contains a list of ast_expressions as parameters.
582  * Since calls can return values, an ast_call is also an ast_expression.
583  */
584 struct ast_call
585 {
586     ast_expression expression;
587     ast_expression *func;
588     std::vector<ast_expression *> params;
589     ast_expression *va_count;
590 };
591 ast_call* ast_call_new(lex_ctx_t ctx,
592                        ast_expression *funcexpr);
593 bool ast_call_check_types(ast_call*, ast_expression *this_func_va_type);
594
595 /* Blocks
596  *
597  */
598 struct ast_block
599 {
600     ast_expression expression;
601
602     std::vector<ast_value*> locals;
603     std::vector<ast_expression*> exprs;
604     std::vector<ast_expression*> collect;
605 };
606 ast_block* ast_block_new(lex_ctx_t ctx);
607 void ast_block_delete(ast_block*);
608 void ast_block_set_type(ast_block*, ast_expression *from);
609 void ast_block_collect(ast_block*, ast_expression*);
610
611 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
612
613 /* Function
614  *
615  * Contains a list of blocks... at least in theory.
616  * Usually there's just the main block, other blocks are inside that.
617  *
618  * Technically, functions don't need to be an AST node, since we have
619  * neither functions inside functions, nor lambdas, and function
620  * pointers could just work with a name. However, this way could be
621  * more flexible, and adds no real complexity.
622  */
623 struct ast_function
624 {
625     ast_node node;
626
627     ast_value *vtype;
628     const char *name;
629
630     int builtin;
631
632     /* list of used-up names for statics without the count suffix */
633     std::vector<char*> static_names;
634     /* number of static variables, by convention this includes the
635      * ones without the count-suffix - remember this when dealing
636      * with savegames. uint instead of size_t as %zu in printf is
637      * C99, so no windows support. */
638     unsigned int static_count;
639
640     ir_function *ir_func;
641     ir_block *curblock;
642     std::vector<ir_block*> breakblocks;
643     std::vector<ir_block*> continueblocks;
644
645     size_t labelcount;
646     /* in order for thread safety - for the optional
647      * channel abesed multithreading... keeping a buffer
648      * here to use in ast_function_label.
649      */
650     char labelbuf[64];
651     std::vector<ast_block*> blocks;
652     ast_value *varargs;
653     ast_value *argc;
654     ast_value *fixedparams;
655     ast_value *return_value;
656 };
657 ast_function* ast_function_new(lex_ctx_t ctx, const char *name, ast_value *vtype);
658 /* This will NOT delete the underlying ast_value */
659 void ast_function_delete(ast_function*);
660 /* For "optimized" builds this can just keep returning "foo"...
661  * or whatever...
662  */
663 const char* ast_function_label(ast_function*, const char *prefix);
664
665 bool ast_function_codegen(ast_function *self, ir_builder *builder);
666 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
667
668 /*
669  * If the condition creates a situation where this becomes -1 size it means there are
670  * more AST_FLAGs than the type ast_flag_t is capable of holding. So either eliminate
671  * the AST flag count or change the ast_flag_t typedef to a type large enough to accomodate
672  * all the flags.
673  */
674 typedef int static_assert_is_ast_flag_safe [((AST_FLAG_LAST) <= (ast_flag_t)(-1)) ? 1 : -1];
675 #endif