Remove license headers. The LICENSE file is sufficent
[xonotic/gmqcc.git] / ast.h
1 #ifndef GMQCC_AST_HDR
2 #define GMQCC_AST_HDR
3 #include "ir.h"
4
5 typedef uint16_t ast_flag_t;
6
7 /* Note: I will not be using a _t suffix for the
8  * "main" ast node types for now.
9  */
10
11 typedef struct ast_node_common       ast_node;
12 typedef struct ast_expression_common ast_expression;
13
14 typedef struct ast_value_s       ast_value;
15 typedef struct ast_function_s    ast_function;
16 typedef struct ast_block_s       ast_block;
17 typedef struct ast_binary_s      ast_binary;
18 typedef struct ast_store_s       ast_store;
19 typedef struct ast_binstore_s    ast_binstore;
20 typedef struct ast_entfield_s    ast_entfield;
21 typedef struct ast_ifthen_s      ast_ifthen;
22 typedef struct ast_ternary_s     ast_ternary;
23 typedef struct ast_loop_s        ast_loop;
24 typedef struct ast_call_s        ast_call;
25 typedef struct ast_unary_s       ast_unary;
26 typedef struct ast_return_s      ast_return;
27 typedef struct ast_member_s      ast_member;
28 typedef struct ast_array_index_s ast_array_index;
29 typedef struct ast_breakcont_s   ast_breakcont;
30 typedef struct ast_switch_s      ast_switch;
31 typedef struct ast_label_s       ast_label;
32 typedef struct ast_goto_s        ast_goto;
33 typedef struct ast_argpipe_s     ast_argpipe;
34 typedef struct ast_state_s       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)->nodetype == (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 struct ast_node_common
104 {
105     lex_ctx_t          context;
106     /* I don't feel comfortable using keywords like 'delete' as names... */
107     ast_node_delete *destroy;
108     int              nodetype;
109     /* keep: if a node contains this node, 'keep'
110      * prevents its dtor from destroying this node as well.
111      */
112     bool             keep;
113     bool             side_effects;
114 };
115
116 #define ast_delete(x) (*( ((ast_node*)(x))->destroy ))((ast_node*)(x))
117 #define ast_unref(x) do                \
118 {                                      \
119     if (! (((ast_node*)(x))->keep) ) { \
120         ast_delete(x);                 \
121     }                                  \
122 } while(0)
123
124 /* Expression interface
125  *
126  * Any expression or block returns an ir_value, and needs
127  * to know the current function.
128  */
129 typedef bool ast_expression_codegen(ast_expression*,
130                                     ast_function*,
131                                     bool lvalue,
132                                     ir_value**);
133 /* TODO: the codegen function should take an output-type parameter
134  * indicating whether a variable, type, label etc. is expected, and
135  * an environment!
136  * Then later an ast_ident could have a codegen using this to figure
137  * out what to look for.
138  * eg. in code which uses a not-yet defined variable, the expression
139  * would take an ast_ident, and the codegen would be called with
140  * type `expression`, so the ast_ident's codegen would search for
141  * variables through the environment (or functions, constants...).
142  */
143 struct ast_expression_common
144 {
145     ast_node                node;
146     ast_expression_codegen *codegen;
147     int                     vtype;
148     ast_expression         *next;
149     /* arrays get a member-count */
150     size_t                  count;
151     ast_value*             *params;
152     ast_flag_t              flags;
153     /* void foo(string...) gets varparam set as a restriction
154      * for variadic parameters
155      */
156     ast_expression         *varparam;
157     /* The codegen functions should store their output values
158      * so we can call it multiple times without re-evaluating.
159      * Store lvalue and rvalue seperately though. So that
160      * ast_entfield for example can generate both if required.
161      */
162     ir_value               *outl;
163     ir_value               *outr;
164 };
165
166 /* Value
167  *
168  * Types are also values, both have a type and a name.
169  * especially considering possible constructs like typedefs.
170  * typedef float foo;
171  * is like creating a 'float foo', foo serving as the type's name.
172  */
173 typedef union {
174     qcfloat_t     vfloat;
175     int           vint;
176     vec3_t        vvec;
177     const char   *vstring;
178     int           ventity;
179     ast_function *vfunc;
180     ast_value    *vfield;
181 } basic_value_t;
182
183 struct ast_value_s
184 {
185     ast_expression        expression;
186
187     const char *name;
188     const char *desc;
189
190     const char *argcounter;
191
192     int  cvq;     /* const/var qualifier */
193     bool isfield; /* this declares a field */
194     bool isimm;   /* an immediate, not just const */
195     bool hasvalue;
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
200      * was provided.
201      */
202     basic_value_t *initlist;
203
204     /* usecount for the parser */
205     size_t uses;
206
207     ir_value *ir_v;
208     ir_value **ir_values;
209     size_t   ir_value_count;
210
211     /* ONLY for arrays in progs version up to 6 */
212     ast_value *setter;
213     ast_value *getter;
214
215
216     bool      intrinsic; /* true if associated with intrinsic */
217 };
218
219 ast_value* ast_value_new(lex_ctx_t ctx, const char *name, int 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*);
223
224 bool ast_value_set_name(ast_value*, const char *name);
225
226 /*
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);
229 */
230
231 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
232
233 void ast_value_params_add(ast_value*, ast_value*);
234
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);
240
241 typedef enum ast_binary_ref_s {
242     AST_REF_NONE  = 0,
243     AST_REF_LEFT  = 1 << 1,
244     AST_REF_RIGHT = 1 << 2,
245     AST_REF_ALL   = (AST_REF_LEFT | AST_REF_RIGHT)
246 } ast_binary_ref;
247
248
249 /* Binary
250  *
251  * A value-returning binary expression.
252  */
253 struct ast_binary_s
254 {
255     ast_expression        expression;
256
257     int             op;
258     ast_expression *left;
259     ast_expression *right;
260     ast_binary_ref  refs;
261     bool            right_first;
262 };
263 ast_binary* ast_binary_new(lex_ctx_t    ctx,
264                            int        op,
265                            ast_expression *left,
266                            ast_expression *right);
267
268 /* Binstore
269  *
270  * An assignment including a binary expression with the source as left operand.
271  * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
272  */
273 struct ast_binstore_s
274 {
275     ast_expression        expression;
276
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_s
295 {
296     ast_expression        expression;
297
298     int             op;
299     ast_expression *operand;
300 };
301 ast_unary* ast_unary_new(lex_ctx_t    ctx,
302                          int        op,
303                          ast_expression *expr);
304
305 /* Return
306  *
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.
310  */
311 struct ast_return_s
312 {
313     ast_expression        expression;
314     ast_expression *operand;
315 };
316 ast_return* ast_return_new(lex_ctx_t    ctx,
317                            ast_expression *expr);
318
319 /* Entity-field
320  *
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)
324  * The problem:
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
328  * the field.
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.
331  */
332 struct ast_entfield_s
333 {
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;
339 };
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);
342
343 /* Member access:
344  *
345  * For now used for vectors. If we get structs or unions
346  * we can have them handled here as well.
347  */
348 struct ast_member_s
349 {
350     ast_expression  expression;
351     ast_expression *owner;
352     unsigned int    field;
353     const char     *name;
354     bool            rvalue;
355 };
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);
359
360
361 /* Array index access:
362  *
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
366  * what we need.
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.
370  */
371 struct ast_array_index_s
372 {
373     ast_expression  expression;
374     ast_expression *array;
375     ast_expression *index;
376 };
377 ast_array_index* ast_array_index_new(lex_ctx_t ctx, ast_expression *array, ast_expression *index);
378
379 /* Vararg pipe node:
380  *
381  * copy all varargs starting from a specific index
382  */
383 struct ast_argpipe_s
384 {
385     ast_expression  expression;
386     ast_expression *index;
387 };
388 ast_argpipe* ast_argpipe_new(lex_ctx_t ctx, ast_expression *index);
389
390 /* Store
391  *
392  * Stores left<-right and returns left.
393  * Specialized binary expression node
394  */
395 struct ast_store_s
396 {
397     ast_expression  expression;
398     int             op;
399     ast_expression *dest;
400     ast_expression *source;
401 };
402 ast_store* ast_store_new(lex_ctx_t ctx, int op,
403                          ast_expression *d, ast_expression *s);
404
405 /* If
406  *
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.
409  *
410  * During its 'codegen' it'll be changing the ast_function's block.
411  *
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
414  * added.
415  */
416 struct ast_ifthen_s
417 {
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;
423 };
424 ast_ifthen* ast_ifthen_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
425
426 /* Ternary expressions...
427  *
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
431  * a PHI node.
432  *
433  * The other difference is that in an ast_ternary, NEITHER side
434  * must be NULL, there's ALWAYS an else branch.
435  *
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.
438  */
439 struct ast_ternary_s
440 {
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;
446 };
447 ast_ternary* ast_ternary_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
448
449 /* A general loop node
450  *
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)
459
460 {ini};
461 while (has_pre => {pre})
462 {
463     {body};
464
465 continue:      // a 'continue' will jump here
466     if (has_pst => {pst})
467         break;
468
469     {inc};
470 }
471  */
472 struct ast_loop_s
473 {
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
484      * flag.
485      */
486     bool pre_not;
487     bool post_not;
488 };
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);
495
496 /* Break/Continue
497  */
498 struct ast_breakcont_s
499 {
500     ast_expression expression;
501     bool           is_continue;
502     unsigned int   levels;
503 };
504 ast_breakcont* ast_breakcont_new(lex_ctx_t ctx, bool iscont, unsigned int levels);
505
506 /* Switch Statements
507  *
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.
514  * TODO: Ticket #20
515  */
516 typedef struct {
517     ast_expression *value; /* #20 will replace this */
518     ast_expression *code;
519 } ast_switch_case;
520 struct ast_switch_s
521 {
522     ast_expression   expression;
523
524     ast_expression  *operand;
525     ast_switch_case *cases;
526 };
527
528 ast_switch* ast_switch_new(lex_ctx_t ctx, ast_expression *op);
529
530 /* Label nodes
531  *
532  * Introduce a label which can be used together with 'goto'
533  */
534 struct ast_label_s
535 {
536     ast_expression  expression;
537     const char     *name;
538     ir_block       *irblock;
539     ast_goto      **gotos;
540
541     /* means it has not yet been defined */
542     bool           undefined;
543 };
544
545 ast_label* ast_label_new(lex_ctx_t ctx, const char *name, bool undefined);
546
547 /* GOTO nodes
548  *
549  * Go to a label, the label node is filled in at a later point!
550  */
551 struct ast_goto_s
552 {
553     ast_expression expression;
554     const char    *name;
555     ast_label     *target;
556     ir_block      *irblock_from;
557 };
558
559 ast_goto* ast_goto_new(lex_ctx_t ctx, const char *name);
560 void ast_goto_set_label(ast_goto*, ast_label*);
561
562 /* STATE node
563  *
564  * For frame/think state updates: void foo() [framenum, nextthink] {}
565  */
566 struct ast_state_s
567 {
568     ast_expression  expression;
569     ast_expression *framenum;
570     ast_expression *nextthink;
571 };
572 ast_state* ast_state_new(lex_ctx_t ctx, ast_expression *frame, ast_expression *think);
573 void ast_state_delete(ast_state*);
574
575 /* CALL node
576  *
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
581  * expression.
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.
584  */
585 struct ast_call_s
586 {
587     ast_expression  expression;
588     ast_expression *func;
589     ast_expression **params;
590     ast_expression *va_count;
591 };
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);
595
596 /* Blocks
597  *
598  */
599 struct ast_block_s
600 {
601     ast_expression   expression;
602
603     ast_value*      *locals;
604     ast_expression* *exprs;
605     ast_expression* *collect;
606 };
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*);
611
612 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
613
614 /* Function
615  *
616  * Contains a list of blocks... at least in theory.
617  * Usually there's just the main block, other blocks are inside that.
618  *
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.
623  */
624 struct ast_function_s
625 {
626     ast_node    node;
627
628     ast_value  *vtype;
629     const char *name;
630
631     int builtin;
632
633     /* list of used-up names for statics without the count suffix */
634     char       **static_names;
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;
640
641     ir_function *ir_func;
642     ir_block    *curblock;
643     ir_block    **breakblocks;
644     ir_block    **continueblocks;
645
646     size_t       labelcount;
647     /* in order for thread safety - for the optional
648      * channel abesed multithreading... keeping a buffer
649      * here to use in ast_function_label.
650      */
651     char         labelbuf[64];
652
653     ast_block* *blocks;
654
655     ast_value   *varargs;
656     ast_value   *argc;
657     ast_value   *fixedparams;
658     ast_value   *return_value;
659 };
660 ast_function* ast_function_new(lex_ctx_t ctx, const char *name, ast_value *vtype);
661 /* This will NOT delete the underlying ast_value */
662 void ast_function_delete(ast_function*);
663 /* For "optimized" builds this can just keep returning "foo"...
664  * or whatever...
665  */
666 const char* ast_function_label(ast_function*, const char *prefix);
667
668 bool ast_function_codegen(ast_function *self, ir_builder *builder);
669 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
670
671 /*
672  * If the condition creates a situation where this becomes -1 size it means there are
673  * more AST_FLAGs than the type ast_flag_t is capable of holding. So either eliminate
674  * the AST flag count or change the ast_flag_t typedef to a type large enough to accomodate
675  * all the flags.
676  */
677 typedef int static_assert_is_ast_flag_safe [((AST_FLAG_LAST) <= (ast_flag_t)(-1)) ? 1 : -1];
678 #endif