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