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