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