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