Added test for variadic arguments
[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
50 enum {
51     TYPE_ast_node,
52     TYPE_ast_expression,
53     TYPE_ast_value,
54     TYPE_ast_function,
55     TYPE_ast_block,
56     TYPE_ast_binary,
57     TYPE_ast_store,
58     TYPE_ast_binstore,
59     TYPE_ast_entfield,
60     TYPE_ast_ifthen,
61     TYPE_ast_ternary,
62     TYPE_ast_loop,
63     TYPE_ast_call,
64     TYPE_ast_unary,
65     TYPE_ast_return,
66     TYPE_ast_member,
67     TYPE_ast_array_index
68 };
69
70 #define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
71 #define ast_ctx(node) (((ast_node_common*)(node))->context)
72
73 /* Node interface with common components
74  */
75 typedef void ast_node_delete(ast_node*);
76 typedef struct
77 {
78     lex_ctx          context;
79     /* I don't feel comfortable using keywords like 'delete' as names... */
80     ast_node_delete *destroy;
81     int              nodetype;
82     /* keep: if a node contains this node, 'keep'
83      * prevents its dtor from destroying this node as well.
84      */
85     bool             keep;
86 } ast_node_common;
87
88 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
89 #define ast_unref(x) do                     \
90 {                                           \
91     if (! (((ast_node*)(x))->node.keep) ) { \
92         ast_delete(x);                      \
93     }                                       \
94 } while(0)
95
96 /* Expression interface
97  *
98  * Any expression or block returns an ir_value, and needs
99  * to know the current function.
100  */
101 typedef bool ast_expression_codegen(ast_expression*,
102                                     ast_function*,
103                                     bool lvalue,
104                                     ir_value**);
105 /* TODO: the codegen function should take an output-type parameter
106  * indicating whether a variable, type, label etc. is expected, and
107  * an environment!
108  * Then later an ast_ident could have a codegen using this to figure
109  * out what to look for.
110  * eg. in code which uses a not-yet defined variable, the expression
111  * would take an ast_ident, and the codegen would be called with
112  * type `expression`, so the ast_ident's codegen would search for
113  * variables through the environment (or functions, constants...).
114  */
115 typedef struct
116 {
117     ast_node_common         node;
118     ast_expression_codegen *codegen;
119     int                     vtype;
120     ast_expression         *next;
121     /* arrays get a member-count */
122     size_t                  count;
123     ast_value*             *params;
124     bool                    variadic;
125     /* The codegen functions should store their output values
126      * so we can call it multiple times without re-evaluating.
127      * Store lvalue and rvalue seperately though. So that
128      * ast_entfield for example can generate both if required.
129      */
130     ir_value               *outl;
131     ir_value               *outr;
132 } ast_expression_common;
133
134 /* Value
135  *
136  * Types are also values, both have a type and a name.
137  * especially considering possible constructs like typedefs.
138  * typedef float foo;
139  * is like creating a 'float foo', foo serving as the type's name.
140  */
141 struct ast_value_s
142 {
143     ast_expression_common expression;
144
145     const char *name;
146
147     /*
148     int         vtype;
149     ast_value  *next;
150     */
151
152     bool isconst;
153     union {
154         double        vfloat;
155         int           vint;
156         vector        vvec;
157         const char   *vstring;
158         int           ventity;
159         ast_function *vfunc;
160     } constval;
161
162     /* usecount for the parser */
163     size_t uses;
164
165     ir_value *ir_v;
166     ir_value **ir_values;
167     size_t   ir_value_count;
168
169     /* ONLY for arrays in progs version up to 6 */
170     ast_value *setter;
171     ast_value *getter;
172 };
173
174 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
175 ast_value* ast_value_copy(const ast_value *self);
176 /* This will NOT delete an underlying ast_function */
177 void ast_value_delete(ast_value*);
178
179 bool ast_value_set_name(ast_value*, const char *name);
180
181 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
182 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
183 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
184
185 void ast_value_params_add(ast_value*, ast_value*);
186
187 bool ast_compare_type(ast_expression *a, ast_expression *b);
188 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
189 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
190 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
191 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
192
193 /* Binary
194  *
195  * A value-returning binary expression.
196  */
197 struct ast_binary_s
198 {
199     ast_expression_common expression;
200
201     int             op;
202     ast_expression *left;
203     ast_expression *right;
204 };
205 ast_binary* ast_binary_new(lex_ctx    ctx,
206                            int        op,
207                            ast_expression *left,
208                            ast_expression *right);
209 void ast_binary_delete(ast_binary*);
210
211 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
212
213 /* Binstore
214  *
215  * An assignment including a binary expression with the source as left operand.
216  * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
217  */
218 struct ast_binstore_s
219 {
220     ast_expression_common expression;
221
222     int             opstore;
223     int             opbin;
224     ast_expression *dest;
225     ast_expression *source;
226 };
227 ast_binstore* ast_binstore_new(lex_ctx    ctx,
228                                int        storeop,
229                                int        op,
230                                ast_expression *left,
231                                ast_expression *right);
232 void ast_binstore_delete(ast_binstore*);
233
234 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
235
236 /* Unary
237  *
238  * Regular unary expressions: not,neg
239  */
240 struct ast_unary_s
241 {
242     ast_expression_common expression;
243
244     int             op;
245     ast_expression *operand;
246 };
247 ast_unary* ast_unary_new(lex_ctx    ctx,
248                          int        op,
249                          ast_expression *expr);
250 void ast_unary_delete(ast_unary*);
251
252 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
253
254 /* Return
255  *
256  * Make sure 'return' only happens at the end of a block, otherwise the IR
257  * will refuse to create further instructions.
258  * This should be honored by the parser.
259  */
260 struct ast_return_s
261 {
262     ast_expression_common expression;
263     ast_expression *operand;
264 };
265 ast_return* ast_return_new(lex_ctx    ctx,
266                            ast_expression *expr);
267 void ast_return_delete(ast_return*);
268
269 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
270
271 /* Entity-field
272  *
273  * This must do 2 things:
274  * -) Provide a way to fetch an entity field value. (Rvalue)
275  * -) Provide a pointer to an entity field. (Lvalue)
276  * The problem:
277  * In original QC, there's only a STORE via pointer, but
278  * no LOAD via pointer.
279  * So we must know beforehand if we are going to read or assign
280  * the field.
281  * For this we will have to extend the codegen() functions with
282  * a flag saying whether or not we need an L or an R-value.
283  */
284 struct ast_entfield_s
285 {
286     ast_expression_common expression;
287     /* The entity can come from an expression of course. */
288     ast_expression *entity;
289     /* As can the field, it just must result in a value of TYPE_FIELD */
290     ast_expression *field;
291 };
292 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
293 ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
294 void ast_entfield_delete(ast_entfield*);
295
296 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
297
298 /* Member access:
299  *
300  * For now used for vectors. If we get structs or unions
301  * we can have them handled here as well.
302  */
303 struct ast_member_s
304 {
305     ast_expression_common expression;
306     ast_expression *owner;
307     unsigned int    field;
308 };
309 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field);
310 void ast_member_delete(ast_member*);
311
312 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
313
314 /* Array index access:
315  *
316  * QC forces us to take special action on arrays:
317  * an ast_store on an ast_array_index must not codegen the index,
318  * but call its setter - unless we have an instruction set which supports
319  * what we need.
320  * Any other array index access will be codegened to a call to the getter.
321  * In any case, accessing an element via a compiletime-constant index will
322  * result in quick access to that variable.
323  */
324 struct ast_array_index_s
325 {
326     ast_expression_common expression;
327     ast_expression *array;
328     ast_expression *index;
329 };
330 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
331 void ast_array_index_delete(ast_array_index*);
332
333 bool ast_array_index_codegen(ast_array_index*, ast_function*, bool lvalue, ir_value**);
334
335 /* Store
336  *
337  * Stores left<-right and returns left.
338  * Specialized binary expression node
339  */
340 struct ast_store_s
341 {
342     ast_expression_common expression;
343     int             op;
344     ast_expression *dest;
345     ast_expression *source;
346 };
347 ast_store* ast_store_new(lex_ctx ctx, int op,
348                          ast_expression *d, ast_expression *s);
349 void ast_store_delete(ast_store*);
350
351 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
352
353 /* If
354  *
355  * A general 'if then else' statement, either side can be NULL and will
356  * thus be omitted. It is an error for *both* cases to be NULL at once.
357  *
358  * During its 'codegen' it'll be changing the ast_function's block.
359  *
360  * An if is also an "expression". Its codegen will put NULL into the
361  * output field though. For ternary expressions an ast_ternary will be
362  * added.
363  */
364 struct ast_ifthen_s
365 {
366     ast_expression_common expression;
367     ast_expression *cond;
368     /* It's all just 'expressions', since an ast_block is one too. */
369     ast_expression *on_true;
370     ast_expression *on_false;
371 };
372 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
373 void ast_ifthen_delete(ast_ifthen*);
374
375 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
376
377 /* Ternary expressions...
378  *
379  * Contrary to 'if-then-else' nodes, ternary expressions actually
380  * return a value, otherwise they behave the very same way.
381  * The difference in 'codegen' is that it'll return the value of
382  * a PHI node.
383  *
384  * The other difference is that in an ast_ternary, NEITHER side
385  * must be NULL, there's ALWAYS an else branch.
386  *
387  * This is the only ast_node beside ast_value which contains
388  * an ir_value. Theoretically we don't need to remember it though.
389  */
390 struct ast_ternary_s
391 {
392     ast_expression_common expression;
393     ast_expression *cond;
394     /* It's all just 'expressions', since an ast_block is one too. */
395     ast_expression *on_true;
396     ast_expression *on_false;
397     /* After a ternary expression we find ourselves in a new IR block
398      * and start with a PHI node */
399     ir_value       *phi_out;
400 };
401 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
402 void ast_ternary_delete(ast_ternary*);
403
404 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
405
406 /* A general loop node
407  *
408  * For convenience it contains 4 parts:
409  * -) (ini) = initializing expression
410  * -) (pre) = pre-loop condition
411  * -) (pst) = post-loop condition
412  * -) (inc) = "increment" expression
413  * The following is a psudo-representation of this loop
414  * note that '=>' bears the logical meaning of "implies".
415  * (a => b) equals (!a || b)
416
417 {ini};
418 while (has_pre => {pre})
419 {
420     {body};
421
422 continue:      // a 'continue' will jump here
423     if (has_pst => {pst})
424         break;
425
426     {inc};
427 }
428  */
429 struct ast_loop_s
430 {
431     ast_expression_common expression;
432     ast_expression *initexpr;
433     ast_expression *precond;
434     ast_expression *postcond;
435     ast_expression *increment;
436     ast_expression *body;
437 };
438 ast_loop* ast_loop_new(lex_ctx ctx,
439                        ast_expression *initexpr,
440                        ast_expression *precond,
441                        ast_expression *postcond,
442                        ast_expression *increment,
443                        ast_expression *body);
444 void ast_loop_delete(ast_loop*);
445
446 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
447
448 /* CALL node
449  *
450  * Contains an ast_expression as target, rather than an ast_function/value.
451  * Since it's how QC works, every ast_function has an ast_value
452  * associated anyway - in other words, the VM contains function
453  * pointers for every function anyway. Thus, this node will call
454  * expression.
455  * Additionally it contains a list of ast_expressions as parameters.
456  * Since calls can return values, an ast_call is also an ast_expression.
457  */
458 struct ast_call_s
459 {
460     ast_expression_common expression;
461     ast_expression *func;
462     ast_expression* *params;
463 };
464 ast_call* ast_call_new(lex_ctx ctx,
465                        ast_expression *funcexpr);
466 void ast_call_delete(ast_call*);
467 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
468 bool ast_call_check_types(ast_call*);
469
470 /* Blocks
471  *
472  */
473 struct ast_block_s
474 {
475     ast_expression_common expression;
476
477     ast_value*      *locals;
478     ast_expression* *exprs;
479     ast_expression* *collect;
480 };
481 ast_block* ast_block_new(lex_ctx ctx);
482 void ast_block_delete(ast_block*);
483 bool ast_block_set_type(ast_block*, ast_expression *from);
484
485 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
486 void ast_block_collect(ast_block*, ast_expression*);
487
488 /* Function
489  *
490  * Contains a list of blocks... at least in theory.
491  * Usually there's just the main block, other blocks are inside that.
492  *
493  * Technically, functions don't need to be an AST node, since we have
494  * neither functions inside functions, nor lambdas, and function
495  * pointers could just work with a name. However, this way could be
496  * more flexible, and adds no real complexity.
497  */
498 struct ast_function_s
499 {
500     ast_node_common node;
501
502     ast_value  *vtype;
503     const char *name;
504
505     int builtin;
506
507     ir_function *ir_func;
508     ir_block    *curblock;
509     ir_block    *breakblock;
510     ir_block    *continueblock;
511
512     size_t       labelcount;
513     /* in order for thread safety - for the optional
514      * channel abesed multithreading... keeping a buffer
515      * here to use in ast_function_label.
516      */
517     char         labelbuf[64];
518
519     ast_block* *blocks;
520 };
521 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
522 /* This will NOT delete the underlying ast_value */
523 void ast_function_delete(ast_function*);
524 /* For "optimized" builds this can just keep returning "foo"...
525  * or whatever...
526  */
527 const char* ast_function_label(ast_function*, const char *prefix);
528
529 bool ast_function_codegen(ast_function *self, ir_builder *builder);
530
531 /* Expression union
532  */
533 union ast_expression_u
534 {
535     ast_expression_common expression;
536
537     ast_value    value;
538     ast_binary   binary;
539     ast_block    block;
540     ast_ternary  ternary;
541     ast_ifthen   ifthen;
542     ast_store    store;
543     ast_entfield entfield;
544 };
545
546 /* Node union
547  */
548 union ast_node_u
549 {
550     ast_node_common node;
551     ast_expression  expression;
552 };
553
554 #endif