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