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