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