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