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