Add back that splint flag
[xonotic/gmqcc.git] / ast.h
1 /*
2  * Copyright (C) 2012, 2013
3  *     Wolfgang Bumiller
4  *     Dale Weiler
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy of
7  * this software and associated documentation files (the "Software"), to deal in
8  * the Software without restriction, including without limitation the rights to
9  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10  * of the Software, and to permit persons to whom the Software is furnished to do
11  * so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef GMQCC_AST_HDR
25 #define GMQCC_AST_HDR
26 #include "ir.h"
27
28 /* Note: I will not be using a _t suffix for the
29  * "main" ast node types for now.
30  */
31
32 typedef union ast_node_u ast_node;
33 typedef union ast_expression_u ast_expression;
34
35 typedef struct ast_value_s       ast_value;
36 typedef struct ast_function_s    ast_function;
37 typedef struct ast_block_s       ast_block;
38 typedef struct ast_binary_s      ast_binary;
39 typedef struct ast_store_s       ast_store;
40 typedef struct ast_binstore_s    ast_binstore;
41 typedef struct ast_entfield_s    ast_entfield;
42 typedef struct ast_ifthen_s      ast_ifthen;
43 typedef struct ast_ternary_s     ast_ternary;
44 typedef struct ast_loop_s        ast_loop;
45 typedef struct ast_call_s        ast_call;
46 typedef struct ast_unary_s       ast_unary;
47 typedef struct ast_return_s      ast_return;
48 typedef struct ast_member_s      ast_member;
49 typedef struct ast_array_index_s ast_array_index;
50 typedef struct ast_breakcont_s   ast_breakcont;
51 typedef struct ast_switch_s      ast_switch;
52 typedef struct ast_label_s       ast_label;
53 typedef struct ast_goto_s        ast_goto;
54
55 enum {
56     TYPE_ast_node,        /*  0 */
57     TYPE_ast_expression,  /*  1 */
58     TYPE_ast_value,       /*  2 */
59     TYPE_ast_function,    /*  3 */
60     TYPE_ast_block,       /*  4 */
61     TYPE_ast_binary,      /*  5 */
62     TYPE_ast_store,       /*  6 */
63     TYPE_ast_binstore,    /*  7 */
64     TYPE_ast_entfield,    /*  8 */
65     TYPE_ast_ifthen,      /*  9 */
66     TYPE_ast_ternary,     /* 10 */
67     TYPE_ast_loop,        /* 11 */
68     TYPE_ast_call,        /* 12 */
69     TYPE_ast_unary,       /* 13 */
70     TYPE_ast_return,      /* 14 */
71     TYPE_ast_member,      /* 15 */
72     TYPE_ast_array_index, /* 16 */
73     TYPE_ast_breakcont,   /* 17 */
74     TYPE_ast_switch,      /* 18 */
75     TYPE_ast_label,       /* 19 */
76     TYPE_ast_goto         /* 20 */
77 };
78
79 #define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
80 #define ast_ctx(node) (((ast_node_common*)(node))->context)
81 #define ast_side_effects(node) (((ast_node_common*)(node))->side_effects)
82
83 /* Node interface with common components
84  */
85 typedef void ast_node_delete(ast_node*);
86 typedef struct
87 {
88     lex_ctx          context;
89     /* I don't feel comfortable using keywords like 'delete' as names... */
90     ast_node_delete *destroy;
91     int              nodetype;
92     /* keep: if a node contains this node, 'keep'
93      * prevents its dtor from destroying this node as well.
94      */
95     bool             keep;
96     bool             side_effects;
97 } ast_node_common;
98
99 #define ast_delete(x) (*( ((ast_node*)(x))->node.destroy ))((ast_node*)(x))
100 #define ast_unref(x) do                     \
101 {                                           \
102     if (! (((ast_node*)(x))->node.keep) ) { \
103         ast_delete(x);                      \
104     }                                       \
105 } while(0)
106
107 /* Expression interface
108  *
109  * Any expression or block returns an ir_value, and needs
110  * to know the current function.
111  */
112 typedef bool ast_expression_codegen(ast_expression*,
113                                     ast_function*,
114                                     bool lvalue,
115                                     ir_value**);
116 /* TODO: the codegen function should take an output-type parameter
117  * indicating whether a variable, type, label etc. is expected, and
118  * an environment!
119  * Then later an ast_ident could have a codegen using this to figure
120  * out what to look for.
121  * eg. in code which uses a not-yet defined variable, the expression
122  * would take an ast_ident, and the codegen would be called with
123  * type `expression`, so the ast_ident's codegen would search for
124  * variables through the environment (or functions, constants...).
125  */
126 typedef struct
127 {
128     ast_node_common         node;
129     ast_expression_codegen *codegen;
130     int                     vtype;
131     ast_expression         *next;
132     /* arrays get a member-count */
133     size_t                  count;
134     ast_value*             *params;
135     uint32_t                flags;
136     /* void foo(string...) gets varparam set as a restriction
137      * for variadic parameters
138      */
139     ast_expression         *varparam;
140     /* The codegen functions should store their output values
141      * so we can call it multiple times without re-evaluating.
142      * Store lvalue and rvalue seperately though. So that
143      * ast_entfield for example can generate both if required.
144      */
145     ir_value               *outl;
146     ir_value               *outr;
147 } ast_expression_common;
148 #define AST_FLAG_VARIADIC     (1<<0)
149 #define AST_FLAG_NORETURN     (1<<1)
150 #define AST_FLAG_INLINE       (1<<2)
151 #define AST_FLAG_INITIALIZED  (1<<3)
152 #define AST_FLAG_DEPRECATED   (1<<4)
153 #define AST_FLAG_INCLUDE_DEF  (1<<5)
154 #define AST_FLAG_IS_VARARG    (1<<6)
155 #define AST_FLAG_ALIAS        (1<<7)
156 #define AST_FLAG_TYPE_MASK (AST_FLAG_VARIADIC | AST_FLAG_NORETURN)
157
158 /* Value
159  *
160  * Types are also values, both have a type and a name.
161  * especially considering possible constructs like typedefs.
162  * typedef float foo;
163  * is like creating a 'float foo', foo serving as the type's name.
164  */
165 typedef union {
166     double        vfloat;
167     int           vint;
168     vector        vvec;
169     const char   *vstring;
170     int           ventity;
171     ast_function *vfunc;
172     ast_value    *vfield;
173 } basic_value_t;
174 struct ast_value_s
175 {
176     ast_expression_common expression;
177
178     const char *name;
179     const char *desc;
180
181     const char *argcounter;
182
183     /*
184     int         vtype;
185     ast_value  *next;
186     */
187
188     int  cvq;     /* const/var qualifier */
189     bool isfield; /* this declares a field */
190     bool isimm;   /* an immediate, not just const */
191     bool hasvalue;
192     basic_value_t constval;
193     /* for TYPE_ARRAY we have an optional vector
194      * of constants when an initializer list
195      * was provided.
196      */
197     basic_value_t *initlist;
198
199     /* usecount for the parser */
200     size_t uses;
201
202     ir_value *ir_v;
203     ir_value **ir_values;
204     size_t   ir_value_count;
205
206     /* ONLY for arrays in progs version up to 6 */
207     ast_value *setter;
208     ast_value *getter;
209 };
210
211 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
212 ast_value* ast_value_copy(const ast_value *self);
213 /* This will NOT delete an underlying ast_function */
214 void ast_value_delete(ast_value*);
215
216 bool ast_value_set_name(ast_value*, const char *name);
217
218 /*
219 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
220 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
221 */
222
223 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
224
225 void ast_value_params_add(ast_value*, ast_value*);
226
227 bool ast_compare_type(ast_expression *a, ast_expression *b);
228 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
229 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
230 void ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
231 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
232
233 typedef enum ast_binary_ref_s {
234     AST_REF_LEFT  = 1 << 1,
235     AST_REF_RIGHT = 1 << 2,
236     AST_REF_ALL   = (AST_REF_LEFT | AST_REF_RIGHT)
237 } ast_binary_ref;
238
239
240 /* Binary
241  *
242  * A value-returning binary expression.
243  */
244 struct ast_binary_s
245 {
246     ast_expression_common expression;
247
248     int             op;
249     ast_expression *left;
250     ast_expression *right;
251     ast_binary_ref  refs;
252
253 };
254 ast_binary* ast_binary_new(lex_ctx    ctx,
255                            int        op,
256                            ast_expression *left,
257                            ast_expression *right);
258
259 /* Binstore
260  *
261  * An assignment including a binary expression with the source as left operand.
262  * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
263  */
264 struct ast_binstore_s
265 {
266     ast_expression_common expression;
267
268     int             opstore;
269     int             opbin;
270     ast_expression *dest;
271     ast_expression *source;
272     /* for &~= which uses the destination in a binary in source we can use this */
273     bool            keep_dest;
274 };
275 ast_binstore* ast_binstore_new(lex_ctx    ctx,
276                                int        storeop,
277                                int        op,
278                                ast_expression *left,
279                                ast_expression *right);
280
281 /* Unary
282  *
283  * Regular unary expressions: not,neg
284  */
285 struct ast_unary_s
286 {
287     ast_expression_common expression;
288
289     int             op;
290     ast_expression *operand;
291 };
292 ast_unary* ast_unary_new(lex_ctx    ctx,
293                          int        op,
294                          ast_expression *expr);
295
296 /* Return
297  *
298  * Make sure 'return' only happens at the end of a block, otherwise the IR
299  * will refuse to create further instructions.
300  * This should be honored by the parser.
301  */
302 struct ast_return_s
303 {
304     ast_expression_common expression;
305     ast_expression *operand;
306 };
307 ast_return* ast_return_new(lex_ctx    ctx,
308                            ast_expression *expr);
309
310 /* Entity-field
311  *
312  * This must do 2 things:
313  * -) Provide a way to fetch an entity field value. (Rvalue)
314  * -) Provide a pointer to an entity field. (Lvalue)
315  * The problem:
316  * In original QC, there's only a STORE via pointer, but
317  * no LOAD via pointer.
318  * So we must know beforehand if we are going to read or assign
319  * the field.
320  * For this we will have to extend the codegen() functions with
321  * a flag saying whether or not we need an L or an R-value.
322  */
323 struct ast_entfield_s
324 {
325     ast_expression_common expression;
326     /* The entity can come from an expression of course. */
327     ast_expression *entity;
328     /* As can the field, it just must result in a value of TYPE_FIELD */
329     ast_expression *field;
330 };
331 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
332 ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
333
334 /* Member access:
335  *
336  * For now used for vectors. If we get structs or unions
337  * we can have them handled here as well.
338  */
339 struct ast_member_s
340 {
341     ast_expression_common expression;
342     ast_expression *owner;
343     unsigned int    field;
344     const char     *name;
345     bool            rvalue;
346 };
347 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field, const char *name);
348 void ast_member_delete(ast_member*);
349 bool ast_member_set_name(ast_member*, const char *name);
350
351
352 /* Array index access:
353  *
354  * QC forces us to take special action on arrays:
355  * an ast_store on an ast_array_index must not codegen the index,
356  * but call its setter - unless we have an instruction set which supports
357  * what we need.
358  * Any other array index access will be codegened to a call to the getter.
359  * In any case, accessing an element via a compiletime-constant index will
360  * result in quick access to that variable.
361  */
362 struct ast_array_index_s
363 {
364     ast_expression_common expression;
365     ast_expression *array;
366     ast_expression *index;
367 };
368 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
369
370 /* Store
371  *
372  * Stores left<-right and returns left.
373  * Specialized binary expression node
374  */
375 struct ast_store_s
376 {
377     ast_expression_common expression;
378     int             op;
379     ast_expression *dest;
380     ast_expression *source;
381 };
382 ast_store* ast_store_new(lex_ctx ctx, int op,
383                          ast_expression *d, ast_expression *s);
384
385 /* If
386  *
387  * A general 'if then else' statement, either side can be NULL and will
388  * thus be omitted. It is an error for *both* cases to be NULL at once.
389  *
390  * During its 'codegen' it'll be changing the ast_function's block.
391  *
392  * An if is also an "expression". Its codegen will put NULL into the
393  * output field though. For ternary expressions an ast_ternary will be
394  * added.
395  */
396 struct ast_ifthen_s
397 {
398     ast_expression_common expression;
399     ast_expression *cond;
400     /* It's all just 'expressions', since an ast_block is one too. */
401     ast_expression *on_true;
402     ast_expression *on_false;
403 };
404 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
405
406 /* Ternary expressions...
407  *
408  * Contrary to 'if-then-else' nodes, ternary expressions actually
409  * return a value, otherwise they behave the very same way.
410  * The difference in 'codegen' is that it'll return the value of
411  * a PHI node.
412  *
413  * The other difference is that in an ast_ternary, NEITHER side
414  * must be NULL, there's ALWAYS an else branch.
415  *
416  * This is the only ast_node beside ast_value which contains
417  * an ir_value. Theoretically we don't need to remember it though.
418  */
419 struct ast_ternary_s
420 {
421     ast_expression_common expression;
422     ast_expression *cond;
423     /* It's all just 'expressions', since an ast_block is one too. */
424     ast_expression *on_true;
425     ast_expression *on_false;
426 };
427 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
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
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
486 /* Switch Statements
487  *
488  * A few notes about this: with the original QCVM, no real optimization
489  * is possible. The SWITCH instruction set isn't really helping a lot, since
490  * it only collapes the EQ and IF instructions into one.
491  * Note: Declaring local variables inside caseblocks is normal.
492  * Since we don't have to deal with a stack there's no unnatural behaviour to
493  * be expected from it.
494  * TODO: Ticket #20
495  */
496 typedef struct {
497     ast_expression *value; /* #20 will replace this */
498     ast_expression *code;
499 } ast_switch_case;
500 struct ast_switch_s
501 {
502     ast_expression_common expression;
503
504     ast_expression  *operand;
505     ast_switch_case *cases;
506 };
507
508 ast_switch* ast_switch_new(lex_ctx ctx, ast_expression *op);
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     /* means it has not yet been defined */
521     bool        undefined;
522 };
523
524 ast_label* ast_label_new(lex_ctx ctx, const char *name, bool undefined);
525
526 /* GOTO nodes
527  *
528  * Go to a label, the label node is filled in at a later point!
529  */
530 struct ast_goto_s
531 {
532     ast_expression_common expression;
533     const char *name;
534     ast_label  *target;
535     ir_block   *irblock_from;
536 };
537
538 ast_goto* ast_goto_new(lex_ctx ctx, const char *name);
539 void ast_goto_set_label(ast_goto*, ast_label*);
540
541 /* CALL node
542  *
543  * Contains an ast_expression as target, rather than an ast_function/value.
544  * Since it's how QC works, every ast_function has an ast_value
545  * associated anyway - in other words, the VM contains function
546  * pointers for every function anyway. Thus, this node will call
547  * expression.
548  * Additionally it contains a list of ast_expressions as parameters.
549  * Since calls can return values, an ast_call is also an ast_expression.
550  */
551 struct ast_call_s
552 {
553     ast_expression_common expression;
554     ast_expression *func;
555     ast_expression* *params;
556     ast_expression *va_count;
557 };
558 ast_call* ast_call_new(lex_ctx ctx,
559                        ast_expression *funcexpr);
560 bool ast_call_check_types(ast_call*);
561
562 /* Blocks
563  *
564  */
565 struct ast_block_s
566 {
567     ast_expression_common expression;
568
569     ast_value*      *locals;
570     ast_expression* *exprs;
571     ast_expression* *collect;
572 };
573 ast_block* ast_block_new(lex_ctx ctx);
574 void ast_block_delete(ast_block*);
575 void ast_block_set_type(ast_block*, ast_expression *from);
576 void ast_block_collect(ast_block*, ast_expression*);
577
578 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
579
580 /* Function
581  *
582  * Contains a list of blocks... at least in theory.
583  * Usually there's just the main block, other blocks are inside that.
584  *
585  * Technically, functions don't need to be an AST node, since we have
586  * neither functions inside functions, nor lambdas, and function
587  * pointers could just work with a name. However, this way could be
588  * more flexible, and adds no real complexity.
589  */
590 struct ast_function_s
591 {
592     ast_node_common node;
593
594     ast_value  *vtype;
595     const char *name;
596
597     int builtin;
598
599     ir_function *ir_func;
600     ir_block    *curblock;
601     ir_block    **breakblocks;
602     ir_block    **continueblocks;
603
604 #if 0
605     /* In order for early-out logic not to go over
606      * excessive jumps, we remember their target
607      * blocks...
608      */
609     ir_block    *iftrue;
610     ir_block    *iffalse;
611 #endif
612
613     size_t       labelcount;
614     /* in order for thread safety - for the optional
615      * channel abesed multithreading... keeping a buffer
616      * here to use in ast_function_label.
617      */
618     char         labelbuf[64];
619
620     ast_block* *blocks;
621
622     ast_value   *varargs;
623     ast_value   *argc;
624     ast_value   *fixedparams;
625 };
626 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
627 /* This will NOT delete the underlying ast_value */
628 void ast_function_delete(ast_function*);
629 /* For "optimized" builds this can just keep returning "foo"...
630  * or whatever...
631  */
632 /*const char* ast_function_label(ast_function*, const char *prefix);*/
633
634 bool ast_function_codegen(ast_function *self, ir_builder *builder);
635 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
636
637 /* Expression union
638  */
639 union ast_expression_u
640 {
641     ast_expression_common expression;
642 };
643
644 /* Node union
645  */
646 union ast_node_u
647 {
648     ast_node_common node;
649 };
650
651 #endif