Grrrr
[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 union ast_node_u ast_node;
32 typedef union ast_expression_u 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_common*)x)->nodetype == (TYPE_##t) )
79 #define ast_ctx(node) (((ast_node_common*)(node))->context)
80 #define ast_side_effects(node) (((ast_node_common*)(node))->side_effects)
81
82 /* Node interface with common components
83  */
84 typedef void ast_node_delete(ast_node*);
85 typedef struct
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 } ast_node_common;
97
98 #define ast_delete(x) (*( ((ast_node*)(x))->node.destroy ))((ast_node*)(x))
99 #define ast_unref(x) do                     \
100 {                                           \
101     if (! (((ast_node*)(x))->node.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 typedef struct
126 {
127     ast_node_common         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 } ast_expression_common;
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 struct ast_value_s
165 {
166     ast_expression_common expression;
167
168     const char *name;
169     const char *desc;
170
171     const char *argcounter;
172
173     /*
174     int         vtype;
175     ast_value  *next;
176     */
177
178     int  cvq;     /* const/var qualifier */
179     bool isfield; /* this declares a field */
180     bool isimm;   /* an immediate, not just const */
181     bool hasvalue;
182     union {
183         double        vfloat;
184         int           vint;
185         vector        vvec;
186         const char   *vstring;
187         int           ventity;
188         ast_function *vfunc;
189         ast_value    *vfield;
190     } constval;
191
192     /* usecount for the parser */
193     size_t uses;
194
195     ir_value *ir_v;
196     ir_value **ir_values;
197     size_t   ir_value_count;
198
199     /* ONLY for arrays in progs version up to 6 */
200     ast_value *setter;
201     ast_value *getter;
202 };
203
204 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
205 ast_value* ast_value_copy(const ast_value *self);
206 /* This will NOT delete an underlying ast_function */
207 void ast_value_delete(ast_value*);
208
209 bool ast_value_set_name(ast_value*, const char *name);
210
211 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
212 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
213 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
214
215 void ast_value_params_add(ast_value*, ast_value*);
216
217 bool ast_compare_type(ast_expression *a, ast_expression *b);
218 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
219 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
220 void ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
221 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
222
223 typedef enum ast_binary_ref_s {
224     AST_REF_LEFT  = 1 << 1,
225     AST_REF_RIGHT = 1 << 2,
226     AST_REF_ALL   = (AST_REF_LEFT | AST_REF_RIGHT)
227 } ast_binary_ref;
228
229
230 /* Binary
231  *
232  * A value-returning binary expression.
233  */
234 struct ast_binary_s
235 {
236     ast_expression_common expression;
237
238     int             op;
239     ast_expression *left;
240     ast_expression *right;
241     ast_binary_ref  refs;
242
243 };
244 ast_binary* ast_binary_new(lex_ctx    ctx,
245                            int        op,
246                            ast_expression *left,
247                            ast_expression *right);
248 void ast_binary_delete(ast_binary*);
249
250 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
251
252 /* Binstore
253  *
254  * An assignment including a binary expression with the source as left operand.
255  * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
256  */
257 struct ast_binstore_s
258 {
259     ast_expression_common expression;
260
261     int             opstore;
262     int             opbin;
263     ast_expression *dest;
264     ast_expression *source;
265     /* for &~= which uses the destination in a binary in source we can use this */
266     bool            keep_dest;
267 };
268 ast_binstore* ast_binstore_new(lex_ctx    ctx,
269                                int        storeop,
270                                int        op,
271                                ast_expression *left,
272                                ast_expression *right);
273 void ast_binstore_delete(ast_binstore*);
274
275 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
276
277 /* Unary
278  *
279  * Regular unary expressions: not,neg
280  */
281 struct ast_unary_s
282 {
283     ast_expression_common expression;
284
285     int             op;
286     ast_expression *operand;
287 };
288 ast_unary* ast_unary_new(lex_ctx    ctx,
289                          int        op,
290                          ast_expression *expr);
291 void ast_unary_delete(ast_unary*);
292
293 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
294
295 /* Return
296  *
297  * Make sure 'return' only happens at the end of a block, otherwise the IR
298  * will refuse to create further instructions.
299  * This should be honored by the parser.
300  */
301 struct ast_return_s
302 {
303     ast_expression_common expression;
304     ast_expression *operand;
305 };
306 ast_return* ast_return_new(lex_ctx    ctx,
307                            ast_expression *expr);
308 void ast_return_delete(ast_return*);
309
310 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
311
312 /* Entity-field
313  *
314  * This must do 2 things:
315  * -) Provide a way to fetch an entity field value. (Rvalue)
316  * -) Provide a pointer to an entity field. (Lvalue)
317  * The problem:
318  * In original QC, there's only a STORE via pointer, but
319  * no LOAD via pointer.
320  * So we must know beforehand if we are going to read or assign
321  * the field.
322  * For this we will have to extend the codegen() functions with
323  * a flag saying whether or not we need an L or an R-value.
324  */
325 struct ast_entfield_s
326 {
327     ast_expression_common expression;
328     /* The entity can come from an expression of course. */
329     ast_expression *entity;
330     /* As can the field, it just must result in a value of TYPE_FIELD */
331     ast_expression *field;
332 };
333 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
334 ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
335 void ast_entfield_delete(ast_entfield*);
336
337 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
338
339 /* Member access:
340  *
341  * For now used for vectors. If we get structs or unions
342  * we can have them handled here as well.
343  */
344 struct ast_member_s
345 {
346     ast_expression_common expression;
347     ast_expression *owner;
348     unsigned int    field;
349     const char     *name;
350     bool            rvalue;
351 };
352 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field, const char *name);
353 void ast_member_delete(ast_member*);
354 bool ast_member_set_name(ast_member*, const char *name);
355
356 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
357
358 /* Array index access:
359  *
360  * QC forces us to take special action on arrays:
361  * an ast_store on an ast_array_index must not codegen the index,
362  * but call its setter - unless we have an instruction set which supports
363  * what we need.
364  * Any other array index access will be codegened to a call to the getter.
365  * In any case, accessing an element via a compiletime-constant index will
366  * result in quick access to that variable.
367  */
368 struct ast_array_index_s
369 {
370     ast_expression_common expression;
371     ast_expression *array;
372     ast_expression *index;
373 };
374 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
375 void ast_array_index_delete(ast_array_index*);
376
377 bool ast_array_index_codegen(ast_array_index*, ast_function*, bool lvalue, ir_value**);
378
379 /* Store
380  *
381  * Stores left<-right and returns left.
382  * Specialized binary expression node
383  */
384 struct ast_store_s
385 {
386     ast_expression_common expression;
387     int             op;
388     ast_expression *dest;
389     ast_expression *source;
390 };
391 ast_store* ast_store_new(lex_ctx ctx, int op,
392                          ast_expression *d, ast_expression *s);
393 void ast_store_delete(ast_store*);
394
395 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
396
397 /* If
398  *
399  * A general 'if then else' statement, either side can be NULL and will
400  * thus be omitted. It is an error for *both* cases to be NULL at once.
401  *
402  * During its 'codegen' it'll be changing the ast_function's block.
403  *
404  * An if is also an "expression". Its codegen will put NULL into the
405  * output field though. For ternary expressions an ast_ternary will be
406  * added.
407  */
408 struct ast_ifthen_s
409 {
410     ast_expression_common expression;
411     ast_expression *cond;
412     /* It's all just 'expressions', since an ast_block is one too. */
413     ast_expression *on_true;
414     ast_expression *on_false;
415 };
416 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
417 void ast_ifthen_delete(ast_ifthen*);
418
419 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
420
421 /* Ternary expressions...
422  *
423  * Contrary to 'if-then-else' nodes, ternary expressions actually
424  * return a value, otherwise they behave the very same way.
425  * The difference in 'codegen' is that it'll return the value of
426  * a PHI node.
427  *
428  * The other difference is that in an ast_ternary, NEITHER side
429  * must be NULL, there's ALWAYS an else branch.
430  *
431  * This is the only ast_node beside ast_value which contains
432  * an ir_value. Theoretically we don't need to remember it though.
433  */
434 struct ast_ternary_s
435 {
436     ast_expression_common expression;
437     ast_expression *cond;
438     /* It's all just 'expressions', since an ast_block is one too. */
439     ast_expression *on_true;
440     ast_expression *on_false;
441 };
442 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
443 void ast_ternary_delete(ast_ternary*);
444
445 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
446
447 /* A general loop node
448  *
449  * For convenience it contains 4 parts:
450  * -) (ini) = initializing expression
451  * -) (pre) = pre-loop condition
452  * -) (pst) = post-loop condition
453  * -) (inc) = "increment" expression
454  * The following is a psudo-representation of this loop
455  * note that '=>' bears the logical meaning of "implies".
456  * (a => b) equals (!a || b)
457
458 {ini};
459 while (has_pre => {pre})
460 {
461     {body};
462
463 continue:      // a 'continue' will jump here
464     if (has_pst => {pst})
465         break;
466
467     {inc};
468 }
469  */
470 struct ast_loop_s
471 {
472     ast_expression_common expression;
473     ast_expression *initexpr;
474     ast_expression *precond;
475     ast_expression *postcond;
476     ast_expression *increment;
477     ast_expression *body;
478     /* For now we allow a seperate flag on whether or not the condition
479      * is supposed to be true or false.
480      * That way, the parser can generate a 'while not(!x)' for `while(x)`
481      * if desired, which is useful for the new -f{true,false}-empty-strings
482      * flag.
483      */
484     bool pre_not;
485     bool post_not;
486 };
487 ast_loop* ast_loop_new(lex_ctx ctx,
488                        ast_expression *initexpr,
489                        ast_expression *precond, bool pre_not,
490                        ast_expression *postcond, bool post_not,
491                        ast_expression *increment,
492                        ast_expression *body);
493 void ast_loop_delete(ast_loop*);
494
495 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
496
497 /* Break/Continue
498  */
499 struct ast_breakcont_s
500 {
501     ast_expression_common expression;
502     bool         is_continue;
503     unsigned int levels;
504 };
505 ast_breakcont* ast_breakcont_new(lex_ctx ctx, bool iscont, unsigned int levels);
506 void ast_breakcont_delete(ast_breakcont*);
507
508 bool ast_breakcont_codegen(ast_breakcont*, ast_function*, bool lvalue, ir_value**);
509
510 /* Switch Statements
511  *
512  * A few notes about this: with the original QCVM, no real optimization
513  * is possible. The SWITCH instruction set isn't really helping a lot, since
514  * it only collapes the EQ and IF instructions into one.
515  * Note: Declaring local variables inside caseblocks is normal.
516  * Since we don't have to deal with a stack there's no unnatural behaviour to
517  * be expected from it.
518  * TODO: Ticket #20
519  */
520 typedef struct {
521     ast_expression *value; /* #20 will replace this */
522     ast_expression *code;
523 } ast_switch_case;
524 struct ast_switch_s
525 {
526     ast_expression_common expression;
527
528     ast_expression  *operand;
529     ast_switch_case *cases;
530 };
531
532 ast_switch* ast_switch_new(lex_ctx ctx, ast_expression *op);
533 void ast_switch_delete(ast_switch*);
534
535 bool ast_switch_codegen(ast_switch*, ast_function*, bool lvalue, ir_value**);
536
537 /* Label nodes
538  *
539  * Introduce a label which can be used together with 'goto'
540  */
541 struct ast_label_s
542 {
543     ast_expression_common expression;
544     const char *name;
545     ir_block   *irblock;
546     ast_goto  **gotos;
547     /* means it has not yet been defined */
548     bool        undefined;
549 };
550
551 ast_label* ast_label_new(lex_ctx ctx, const char *name, bool undefined);
552 void ast_label_delete(ast_label*);
553 void ast_label_register_goto(ast_label*, ast_goto*);
554
555 bool ast_label_codegen(ast_label*, ast_function*, bool lvalue, ir_value**);
556
557 /* GOTO nodes
558  *
559  * Go to a label, the label node is filled in at a later point!
560  */
561 struct ast_goto_s
562 {
563     ast_expression_common expression;
564     const char *name;
565     ast_label  *target;
566     ir_block   *irblock_from;
567 };
568
569 ast_goto* ast_goto_new(lex_ctx ctx, const char *name);
570 void ast_goto_delete(ast_goto*);
571 void ast_goto_set_label(ast_goto*, ast_label*);
572
573 bool ast_goto_codegen(ast_goto*, ast_function*, bool lvalue, ir_value**);
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_common expression;
588     ast_expression *func;
589     ast_expression* *params;
590     ast_expression *va_count;
591 };
592 ast_call* ast_call_new(lex_ctx ctx,
593                        ast_expression *funcexpr);
594 void ast_call_delete(ast_call*);
595 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
596 bool ast_call_check_types(ast_call*);
597
598 /* Blocks
599  *
600  */
601 struct ast_block_s
602 {
603     ast_expression_common expression;
604
605     ast_value*      *locals;
606     ast_expression* *exprs;
607     ast_expression* *collect;
608 };
609 ast_block* ast_block_new(lex_ctx ctx);
610 void ast_block_delete(ast_block*);
611 void ast_block_set_type(ast_block*, ast_expression *from);
612
613 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
614 void ast_block_collect(ast_block*, ast_expression*);
615
616 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
617
618 /* Function
619  *
620  * Contains a list of blocks... at least in theory.
621  * Usually there's just the main block, other blocks are inside that.
622  *
623  * Technically, functions don't need to be an AST node, since we have
624  * neither functions inside functions, nor lambdas, and function
625  * pointers could just work with a name. However, this way could be
626  * more flexible, and adds no real complexity.
627  */
628 struct ast_function_s
629 {
630     ast_node_common node;
631
632     ast_value  *vtype;
633     const char *name;
634
635     int builtin;
636
637     ir_function *ir_func;
638     ir_block    *curblock;
639     ir_block    **breakblocks;
640     ir_block    **continueblocks;
641
642 #if 0
643     /* In order for early-out logic not to go over
644      * excessive jumps, we remember their target
645      * blocks...
646      */
647     ir_block    *iftrue;
648     ir_block    *iffalse;
649 #endif
650
651     size_t       labelcount;
652     /* in order for thread safety - for the optional
653      * channel abesed multithreading... keeping a buffer
654      * here to use in ast_function_label.
655      */
656     char         labelbuf[64];
657
658     ast_block* *blocks;
659
660     ast_value   *varargs;
661     ast_value   *argc;
662     ast_value   *fixedparams;
663 };
664 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
665 /* This will NOT delete the underlying ast_value */
666 void ast_function_delete(ast_function*);
667 /* For "optimized" builds this can just keep returning "foo"...
668  * or whatever...
669  */
670 const char* ast_function_label(ast_function*, const char *prefix);
671
672 bool ast_function_codegen(ast_function *self, ir_builder *builder);
673 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
674
675 /* Expression union
676  */
677 union ast_expression_u
678 {
679     ast_expression_common expression;
680
681     ast_value    value;
682     ast_binary   binary;
683     ast_block    block;
684     ast_ternary  ternary;
685     ast_ifthen   ifthen;
686     ast_store    store;
687     ast_entfield entfield;
688 };
689
690 /* Node union
691  */
692 union ast_node_u
693 {
694     ast_node_common node;
695     ast_expression  expression;
696 };
697
698 #endif