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