]> git.xonotic.org Git - xonotic/gmqcc.git/blob - ast.c
it's not the IR's job to fail when a local of the same name is created twice...
[xonotic/gmqcc.git] / ast.c
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 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26
27 #include "gmqcc.h"
28 #include "ast.h"
29
30 #define ast_instantiate(T, ctx, destroyfn)                          \
31     T* self = (T*)mem_a(sizeof(T));                                 \
32     if (!self) {                                                    \
33         return NULL;                                                \
34     }                                                               \
35     ast_node_init((ast_node*)self, ctx, TYPE_##T);                  \
36     ( (ast_node*)self )->node.destroy = (ast_node_delete*)destroyfn
37
38 /* error handling */
39 static void asterror(lex_ctx ctx, const char *msg, ...)
40 {
41     va_list ap;
42     va_start(ap, msg);
43     cvprintmsg(ctx, LVL_ERROR, "error", msg, ap);
44     va_end(ap);
45 }
46
47 /* It must not be possible to get here. */
48 static GMQCC_NORETURN void _ast_node_destroy(ast_node *self)
49 {
50     fprintf(stderr, "ast node missing destroy()\n");
51     abort();
52 }
53
54 /* Initialize main ast node aprts */
55 static void ast_node_init(ast_node *self, lex_ctx ctx, int nodetype)
56 {
57     self->node.context = ctx;
58     self->node.destroy = &_ast_node_destroy;
59     self->node.keep    = false;
60     self->node.nodetype = nodetype;
61 }
62
63 /* General expression initialization */
64 static void ast_expression_init(ast_expression *self,
65                                 ast_expression_codegen *codegen)
66 {
67     self->expression.codegen  = codegen;
68     self->expression.vtype    = TYPE_VOID;
69     self->expression.next     = NULL;
70     self->expression.outl     = NULL;
71     self->expression.outr     = NULL;
72     self->expression.variadic = false;
73     MEM_VECTOR_INIT(&self->expression, params);
74 }
75
76 static void ast_expression_delete(ast_expression *self)
77 {
78     size_t i;
79     if (self->expression.next)
80         ast_delete(self->expression.next);
81     for (i = 0; i < self->expression.params_count; ++i) {
82         ast_delete(self->expression.params[i]);
83     }
84     MEM_VECTOR_CLEAR(&self->expression, params);
85 }
86
87 static void ast_expression_delete_full(ast_expression *self)
88 {
89     ast_expression_delete(self);
90     mem_d(self);
91 }
92
93 MEM_VEC_FUNCTIONS(ast_expression_common, ast_value*, params)
94
95 ast_value* ast_value_copy(const ast_value *self)
96 {
97     size_t i;
98     const ast_expression_common *fromex;
99     ast_expression_common *selfex;
100     ast_value *cp = ast_value_new(self->expression.node.context, self->name, self->expression.vtype);
101     if (self->expression.next) {
102         cp->expression.next = ast_type_copy(self->expression.node.context, self->expression.next);
103         if (!cp->expression.next) {
104             ast_value_delete(cp);
105             return NULL;
106         }
107     }
108     fromex   = &self->expression;
109     selfex = &cp->expression;
110     selfex->variadic = fromex->variadic;
111     for (i = 0; i < fromex->params_count; ++i) {
112         ast_value *v = ast_value_copy(fromex->params[i]);
113         if (!v || !ast_expression_common_params_add(selfex, v)) {
114             ast_value_delete(cp);
115             return NULL;
116         }
117     }
118     return cp;
119 }
120
121 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other)
122 {
123     size_t i;
124     const ast_expression_common *fromex;
125     ast_expression_common *selfex;
126     self->expression.vtype = other->expression.vtype;
127     if (other->expression.next) {
128         self->expression.next = (ast_expression*)ast_type_copy(ast_ctx(self), other->expression.next);
129         if (!self->expression.next)
130             return false;
131     }
132     fromex   = &other->expression;
133     selfex = &self->expression;
134     selfex->variadic = fromex->variadic;
135     for (i = 0; i < fromex->params_count; ++i) {
136         ast_value *v = ast_value_copy(fromex->params[i]);
137         if (!v || !ast_expression_common_params_add(selfex, v))
138             return false;
139     }
140     return true;
141 }
142
143 static ast_expression* ast_shallow_type(lex_ctx ctx, int vtype)
144 {
145     ast_instantiate(ast_expression, ctx, ast_expression_delete_full);
146     ast_expression_init(self, NULL);
147     self->expression.codegen = NULL;
148     self->expression.next    = NULL;
149     self->expression.vtype   = vtype;
150     return self;
151 }
152
153 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex)
154 {
155     size_t i;
156     const ast_expression_common *fromex;
157     ast_expression_common *selfex;
158
159     if (!ex)
160         return NULL;
161     else
162     {
163         ast_instantiate(ast_expression, ctx, ast_expression_delete_full);
164         ast_expression_init(self, NULL);
165
166         fromex   = &ex->expression;
167         selfex = &self->expression;
168
169         /* This may never be codegen()d */
170         selfex->codegen = NULL;
171
172         selfex->vtype = fromex->vtype;
173         if (fromex->next)
174         {
175             selfex->next = ast_type_copy(ctx, fromex->next);
176             if (!selfex->next) {
177                 ast_expression_delete_full(self);
178                 return NULL;
179             }
180         }
181         else
182             selfex->next = NULL;
183
184         selfex->variadic = fromex->variadic;
185         for (i = 0; i < fromex->params_count; ++i) {
186             ast_value *v = ast_value_copy(fromex->params[i]);
187             if (!v || !ast_expression_common_params_add(selfex, v)) {
188                 ast_expression_delete_full(self);
189                 return NULL;
190             }
191         }
192
193         return self;
194     }
195 }
196
197 bool ast_compare_type(ast_expression *a, ast_expression *b)
198 {
199     if (a->expression.vtype != b->expression.vtype)
200         return false;
201     if (!a->expression.next != !b->expression.next)
202         return false;
203     if (a->expression.params_count != b->expression.params_count)
204         return false;
205     if (a->expression.variadic != b->expression.variadic)
206         return false;
207     if (a->expression.params_count) {
208         size_t i;
209         for (i = 0; i < a->expression.params_count; ++i) {
210             if (!ast_compare_type((ast_expression*)a->expression.params[i],
211                                   (ast_expression*)b->expression.params[i]))
212                 return false;
213         }
214     }
215     if (a->expression.next)
216         return ast_compare_type(a->expression.next, b->expression.next);
217     return true;
218 }
219
220 ast_value* ast_value_new(lex_ctx ctx, const char *name, int t)
221 {
222     ast_instantiate(ast_value, ctx, ast_value_delete);
223     ast_expression_init((ast_expression*)self,
224                         (ast_expression_codegen*)&ast_value_codegen);
225     self->expression.node.keep = true; /* keep */
226
227     self->name = name ? util_strdup(name) : NULL;
228     self->expression.vtype = t;
229     self->expression.next  = NULL;
230     self->isconst = false;
231     memset(&self->constval, 0, sizeof(self->constval));
232
233     self->ir_v    = NULL;
234
235     return self;
236 }
237
238 void ast_value_delete(ast_value* self)
239 {
240     if (self->name)
241         mem_d((void*)self->name);
242     if (self->isconst) {
243         switch (self->expression.vtype)
244         {
245         case TYPE_STRING:
246             mem_d((void*)self->constval.vstring);
247             break;
248         case TYPE_FUNCTION:
249             /* unlink us from the function node */
250             self->constval.vfunc->vtype = NULL;
251             break;
252         /* NOTE: delete function? currently collected in
253          * the parser structure
254          */
255         default:
256             break;
257         }
258     }
259     ast_expression_delete((ast_expression*)self);
260     mem_d(self);
261 }
262
263 bool GMQCC_WARN ast_value_params_add(ast_value *self, ast_value *p)
264 {
265     return ast_expression_common_params_add(&self->expression, p);
266 }
267
268 bool ast_value_set_name(ast_value *self, const char *name)
269 {
270     if (self->name)
271         mem_d((void*)self->name);
272     self->name = util_strdup(name);
273     return !!self->name;
274 }
275
276 ast_binary* ast_binary_new(lex_ctx ctx, int op,
277                            ast_expression* left, ast_expression* right)
278 {
279     ast_instantiate(ast_binary, ctx, ast_binary_delete);
280     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_binary_codegen);
281
282     self->op = op;
283     self->left = left;
284     self->right = right;
285
286     if (op >= INSTR_EQ_F && op <= INSTR_GT)
287         self->expression.vtype = TYPE_FLOAT;
288     else if (op == INSTR_AND || op == INSTR_OR ||
289              op == INSTR_BITAND || op == INSTR_BITOR)
290         self->expression.vtype = TYPE_FLOAT;
291     else if (op == INSTR_MUL_VF || op == INSTR_MUL_FV)
292         self->expression.vtype = TYPE_VECTOR;
293     else if (op == INSTR_MUL_V)
294         self->expression.vtype = TYPE_FLOAT;
295     else
296         self->expression.vtype = left->expression.vtype;
297
298     return self;
299 }
300
301 void ast_binary_delete(ast_binary *self)
302 {
303     ast_unref(self->left);
304     ast_unref(self->right);
305     ast_expression_delete((ast_expression*)self);
306     mem_d(self);
307 }
308
309 ast_binstore* ast_binstore_new(lex_ctx ctx, int storop, int op,
310                                ast_expression* left, ast_expression* right)
311 {
312     ast_instantiate(ast_binstore, ctx, ast_binstore_delete);
313     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_binstore_codegen);
314
315     self->opstore = storop;
316     self->opbin   = op;
317     self->dest    = left;
318     self->source  = right;
319
320     self->expression.vtype = left->expression.vtype;
321     if (left->expression.next) {
322         self->expression.next = ast_type_copy(ctx, left);
323         if (!self->expression.next) {
324             ast_delete(self);
325             return NULL;
326         }
327     }
328     else
329         self->expression.next = NULL;
330
331     return self;
332 }
333
334 void ast_binstore_delete(ast_binstore *self)
335 {
336     ast_unref(self->dest);
337     ast_unref(self->source);
338     ast_expression_delete((ast_expression*)self);
339     mem_d(self);
340 }
341
342 ast_unary* ast_unary_new(lex_ctx ctx, int op,
343                          ast_expression *expr)
344 {
345     ast_instantiate(ast_unary, ctx, ast_unary_delete);
346     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_unary_codegen);
347
348     self->op = op;
349     self->operand = expr;
350
351     if (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) {
352         self->expression.vtype = TYPE_FLOAT;
353     } else
354         asterror(ctx, "cannot determine type of unary operation %s", asm_instr[op].m);
355
356     return self;
357 }
358
359 void ast_unary_delete(ast_unary *self)
360 {
361     ast_unref(self->operand);
362     ast_expression_delete((ast_expression*)self);
363     mem_d(self);
364 }
365
366 ast_return* ast_return_new(lex_ctx ctx, ast_expression *expr)
367 {
368     ast_instantiate(ast_return, ctx, ast_return_delete);
369     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_return_codegen);
370
371     self->operand = expr;
372
373     return self;
374 }
375
376 void ast_return_delete(ast_return *self)
377 {
378     if (self->operand)
379         ast_unref(self->operand);
380     ast_expression_delete((ast_expression*)self);
381     mem_d(self);
382 }
383
384 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field)
385 {
386     const ast_expression *outtype;
387
388     ast_instantiate(ast_entfield, ctx, ast_entfield_delete);
389
390     if (field->expression.vtype != TYPE_FIELD) {
391         mem_d(self);
392         return NULL;
393     }
394
395     outtype = field->expression.next;
396     if (!outtype) {
397         mem_d(self);
398         /* Error: field has no type... */
399         return NULL;
400     }
401
402     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_entfield_codegen);
403
404     self->entity = entity;
405     self->field  = field;
406
407     if (!ast_type_adopt(self, outtype)) {
408         ast_entfield_delete(self);
409         return NULL;
410     }
411
412     return self;
413 }
414
415 void ast_entfield_delete(ast_entfield *self)
416 {
417     ast_unref(self->entity);
418     ast_unref(self->field);
419     ast_expression_delete((ast_expression*)self);
420     mem_d(self);
421 }
422
423 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field)
424 {
425     ast_instantiate(ast_member, ctx, ast_member_delete);
426     if (field >= 3) {
427         mem_d(self);
428         return NULL;
429     }
430
431     if (owner->expression.vtype != TYPE_VECTOR &&
432         owner->expression.vtype != TYPE_FIELD) {
433         asterror(ctx, "member-access on an invalid owner of type %s", type_name[owner->expression.vtype]);
434         mem_d(self);
435         return NULL;
436     }
437
438     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_member_codegen);
439     self->expression.node.keep = true; /* keep */
440
441     if (owner->expression.vtype == TYPE_VECTOR) {
442         self->expression.vtype = TYPE_FLOAT;
443         self->expression.next  = NULL;
444     } else {
445         self->expression.vtype = TYPE_FIELD;
446         self->expression.next = ast_shallow_type(ctx, TYPE_FLOAT);
447     }
448
449     self->owner = owner;
450     self->field = field;
451
452     return self;
453 }
454
455 void ast_member_delete(ast_member *self)
456 {
457     /* The owner is always an ast_value, which has .keep=true,
458      * also: ast_members are usually deleted after the owner, thus
459      * this will cause invalid access
460     ast_unref(self->owner);
461      * once we allow (expression).x to access a vector-member, we need
462      * to change this: preferably by creating an alternate ast node for this
463      * purpose that is not garbage-collected.
464     */
465     ast_expression_delete((ast_expression*)self);
466     mem_d(self);
467 }
468
469 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse)
470 {
471     ast_instantiate(ast_ifthen, ctx, ast_ifthen_delete);
472     if (!ontrue && !onfalse) {
473         /* because it is invalid */
474         mem_d(self);
475         return NULL;
476     }
477     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_ifthen_codegen);
478
479     self->cond     = cond;
480     self->on_true  = ontrue;
481     self->on_false = onfalse;
482
483     return self;
484 }
485
486 void ast_ifthen_delete(ast_ifthen *self)
487 {
488     ast_unref(self->cond);
489     if (self->on_true)
490         ast_unref(self->on_true);
491     if (self->on_false)
492         ast_unref(self->on_false);
493     ast_expression_delete((ast_expression*)self);
494     mem_d(self);
495 }
496
497 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse)
498 {
499     ast_instantiate(ast_ternary, ctx, ast_ternary_delete);
500     /* This time NEITHER must be NULL */
501     if (!ontrue || !onfalse) {
502         mem_d(self);
503         return NULL;
504     }
505     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_ternary_codegen);
506
507     self->cond     = cond;
508     self->on_true  = ontrue;
509     self->on_false = onfalse;
510     self->phi_out  = NULL;
511
512     return self;
513 }
514
515 void ast_ternary_delete(ast_ternary *self)
516 {
517     ast_unref(self->cond);
518     ast_unref(self->on_true);
519     ast_unref(self->on_false);
520     ast_expression_delete((ast_expression*)self);
521     mem_d(self);
522 }
523
524 ast_loop* ast_loop_new(lex_ctx ctx,
525                        ast_expression *initexpr,
526                        ast_expression *precond,
527                        ast_expression *postcond,
528                        ast_expression *increment,
529                        ast_expression *body)
530 {
531     ast_instantiate(ast_loop, ctx, ast_loop_delete);
532     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_loop_codegen);
533
534     self->initexpr  = initexpr;
535     self->precond   = precond;
536     self->postcond  = postcond;
537     self->increment = increment;
538     self->body      = body;
539
540     return self;
541 }
542
543 void ast_loop_delete(ast_loop *self)
544 {
545     if (self->initexpr)
546         ast_unref(self->initexpr);
547     if (self->precond)
548         ast_unref(self->precond);
549     if (self->postcond)
550         ast_unref(self->postcond);
551     if (self->increment)
552         ast_unref(self->increment);
553     if (self->body)
554         ast_unref(self->body);
555     ast_expression_delete((ast_expression*)self);
556     mem_d(self);
557 }
558
559 ast_call* ast_call_new(lex_ctx ctx,
560                        ast_expression *funcexpr)
561 {
562     ast_instantiate(ast_call, ctx, ast_call_delete);
563     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_call_codegen);
564
565     MEM_VECTOR_INIT(self, params);
566
567     self->func = funcexpr;
568
569     self->expression.vtype = funcexpr->expression.next->expression.vtype;
570     if (funcexpr->expression.next->expression.next)
571         self->expression.next = ast_type_copy(ctx, funcexpr->expression.next->expression.next);
572
573     return self;
574 }
575 MEM_VEC_FUNCTIONS(ast_call, ast_expression*, params)
576
577 void ast_call_delete(ast_call *self)
578 {
579     size_t i;
580     for (i = 0; i < self->params_count; ++i)
581         ast_unref(self->params[i]);
582     MEM_VECTOR_CLEAR(self, params);
583
584     if (self->func)
585         ast_unref(self->func);
586
587     ast_expression_delete((ast_expression*)self);
588     mem_d(self);
589 }
590
591 ast_store* ast_store_new(lex_ctx ctx, int op,
592                          ast_expression *dest, ast_expression *source)
593 {
594     ast_instantiate(ast_store, ctx, ast_store_delete);
595     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_store_codegen);
596
597     self->op = op;
598     self->dest = dest;
599     self->source = source;
600
601     return self;
602 }
603
604 void ast_store_delete(ast_store *self)
605 {
606     ast_unref(self->dest);
607     ast_unref(self->source);
608     ast_expression_delete((ast_expression*)self);
609     mem_d(self);
610 }
611
612 ast_block* ast_block_new(lex_ctx ctx)
613 {
614     ast_instantiate(ast_block, ctx, ast_block_delete);
615     ast_expression_init((ast_expression*)self,
616                         (ast_expression_codegen*)&ast_block_codegen);
617
618     MEM_VECTOR_INIT(self, locals);
619     MEM_VECTOR_INIT(self, exprs);
620     MEM_VECTOR_INIT(self, collect);
621
622     return self;
623 }
624 MEM_VEC_FUNCTIONS(ast_block, ast_value*, locals)
625 MEM_VEC_FUNCTIONS(ast_block, ast_expression*, exprs)
626 MEM_VEC_FUNCTIONS(ast_block, ast_expression*, collect)
627
628 bool ast_block_collect(ast_block *self, ast_expression *expr)
629 {
630     if (!ast_block_collect_add(self, expr))
631         return false;
632     expr->expression.node.keep = true;
633     return true;
634 }
635
636 void ast_block_delete(ast_block *self)
637 {
638     size_t i;
639     for (i = 0; i < self->exprs_count; ++i)
640         ast_unref(self->exprs[i]);
641     MEM_VECTOR_CLEAR(self, exprs);
642     for (i = 0; i < self->locals_count; ++i)
643         ast_delete(self->locals[i]);
644     MEM_VECTOR_CLEAR(self, locals);
645     for (i = 0; i < self->collect_count; ++i)
646         ast_delete(self->collect[i]);
647     MEM_VECTOR_CLEAR(self, collect);
648     ast_expression_delete((ast_expression*)self);
649     mem_d(self);
650 }
651
652 bool ast_block_set_type(ast_block *self, ast_expression *from)
653 {
654     if (self->expression.next)
655         ast_delete(self->expression.next);
656     self->expression.vtype = from->expression.vtype;
657     if (from->expression.next) {
658         self->expression.next = ast_type_copy(self->expression.node.context, from->expression.next);
659         if (!self->expression.next)
660             return false;
661     }
662     else
663         self->expression.next = NULL;
664     return true;
665 }
666
667 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype)
668 {
669     ast_instantiate(ast_function, ctx, ast_function_delete);
670
671     if (!vtype ||
672         vtype->isconst ||
673         vtype->expression.vtype != TYPE_FUNCTION)
674     {
675         mem_d(self);
676         return NULL;
677     }
678
679     self->vtype = vtype;
680     self->name = name ? util_strdup(name) : NULL;
681     MEM_VECTOR_INIT(self, blocks);
682
683     self->labelcount = 0;
684     self->builtin = 0;
685
686     self->ir_func = NULL;
687     self->curblock = NULL;
688
689     self->breakblock    = NULL;
690     self->continueblock = NULL;
691
692     vtype->isconst = true;
693     vtype->constval.vfunc = self;
694
695     return self;
696 }
697
698 MEM_VEC_FUNCTIONS(ast_function, ast_block*, blocks)
699
700 void ast_function_delete(ast_function *self)
701 {
702     size_t i;
703     if (self->name)
704         mem_d((void*)self->name);
705     if (self->vtype) {
706         /* ast_value_delete(self->vtype); */
707         self->vtype->isconst = false;
708         self->vtype->constval.vfunc = NULL;
709         /* We use unref - if it was stored in a global table it is supposed
710          * to be deleted from *there*
711          */
712         ast_unref(self->vtype);
713     }
714     for (i = 0; i < self->blocks_count; ++i)
715         ast_delete(self->blocks[i]);
716     MEM_VECTOR_CLEAR(self, blocks);
717     mem_d(self);
718 }
719
720 static void ast_util_hexitoa(char *buf, size_t size, unsigned int num)
721 {
722     unsigned int base = 10;
723 #define checknul() do { if (size == 1) { *buf = 0; return; } } while (0)
724 #define addch(x) do { *buf++ = (x); --size; checknul(); } while (0)
725     if (size < 1)
726         return;
727     checknul();
728     if (!num)
729         addch('0');
730     else {
731         while (num)
732         {
733             int digit = num % base;
734             num /= base;
735             addch('0' + digit);
736         }
737     }
738
739     *buf = 0;
740 #undef addch
741 #undef checknul
742 }
743
744 const char* ast_function_label(ast_function *self, const char *prefix)
745 {
746     size_t id = (self->labelcount++);
747     size_t len = strlen(prefix);
748     strncpy(self->labelbuf, prefix, sizeof(self->labelbuf));
749     ast_util_hexitoa(self->labelbuf + len, sizeof(self->labelbuf)-len, id);
750     return self->labelbuf;
751 }
752
753 /*********************************************************************/
754 /* AST codegen part
755  * by convention you must never pass NULL to the 'ir_value **out'
756  * parameter. If you really don't care about the output, pass a dummy.
757  * But I can't imagine a pituation where the output is truly unnecessary.
758  */
759
760 bool ast_value_codegen(ast_value *self, ast_function *func, bool lvalue, ir_value **out)
761 {
762     /* NOTE: This is the codegen for a variable used in an expression.
763      * It is not the codegen to generate the value. For this purpose,
764      * ast_local_codegen and ast_global_codegen are to be used before this
765      * is executed. ast_function_codegen should take care of its locals,
766      * and the ast-user should take care of ast_global_codegen to be used
767      * on all the globals.
768      */
769     if (!self->ir_v) {
770         asterror(ast_ctx(self), "ast_value used before generated (%s)", self->name);
771         return false;
772     }
773     *out = self->ir_v;
774     return true;
775 }
776
777 bool ast_global_codegen(ast_value *self, ir_builder *ir)
778 {
779     ir_value *v = NULL;
780     if (self->isconst && self->expression.vtype == TYPE_FUNCTION)
781     {
782         ir_function *func = ir_builder_create_function(ir, self->name, self->expression.next->expression.vtype);
783         if (!func)
784             return false;
785         func->context = ast_ctx(self);
786
787         self->constval.vfunc->ir_func = func;
788         self->ir_v = func->value;
789         /* The function is filled later on ast_function_codegen... */
790         return true;
791     }
792
793     if (self->expression.vtype == TYPE_FIELD) {
794         v = ir_builder_create_field(ir, self->name, self->expression.next->expression.vtype);
795         if (!v)
796             return false;
797         v->context = ast_ctx(self);
798         if (self->isconst) {
799             asterror(ast_ctx(self), "TODO: constant field pointers with value");
800             goto error;
801         }
802         self->ir_v = v;
803         return true;
804     }
805
806     v = ir_builder_create_global(ir, self->name, self->expression.vtype);
807     if (!v) {
808         asterror(ast_ctx(self), "ir_builder_create_global failed");
809         return false;
810     }
811     v->context = ast_ctx(self);
812
813     if (self->isconst) {
814         switch (self->expression.vtype)
815         {
816             case TYPE_FLOAT:
817                 if (!ir_value_set_float(v, self->constval.vfloat))
818                     goto error;
819                 break;
820             case TYPE_VECTOR:
821                 if (!ir_value_set_vector(v, self->constval.vvec))
822                     goto error;
823                 break;
824             case TYPE_STRING:
825                 if (!ir_value_set_string(v, self->constval.vstring))
826                     goto error;
827                 break;
828             case TYPE_FUNCTION:
829                 asterror(ast_ctx(self), "global of type function not properly generated");
830                 goto error;
831                 /* Cannot generate an IR value for a function,
832                  * need a pointer pointing to a function rather.
833                  */
834             default:
835                 asterror(ast_ctx(self), "TODO: global constant type %i", self->expression.vtype);
836                 break;
837         }
838     }
839
840     /* link us to the ir_value */
841     self->ir_v = v;
842     return true;
843
844 error: /* clean up */
845     ir_value_delete(v);
846     return false;
847 }
848
849 bool ast_local_codegen(ast_value *self, ir_function *func, bool param)
850 {
851     ir_value *v = NULL;
852     if (self->isconst && self->expression.vtype == TYPE_FUNCTION)
853     {
854         /* Do we allow local functions? I think not...
855          * this is NOT a function pointer atm.
856          */
857         return false;
858     }
859
860     v = ir_function_create_local(func, self->name, self->expression.vtype, param);
861     if (!v)
862         return false;
863     v->context = ast_ctx(self);
864
865     /* A constant local... hmmm...
866      * I suppose the IR will have to deal with this
867      */
868     if (self->isconst) {
869         switch (self->expression.vtype)
870         {
871             case TYPE_FLOAT:
872                 if (!ir_value_set_float(v, self->constval.vfloat))
873                     goto error;
874                 break;
875             case TYPE_VECTOR:
876                 if (!ir_value_set_vector(v, self->constval.vvec))
877                     goto error;
878                 break;
879             case TYPE_STRING:
880                 if (!ir_value_set_string(v, self->constval.vstring))
881                     goto error;
882                 break;
883             default:
884                 asterror(ast_ctx(self), "TODO: global constant type %i", self->expression.vtype);
885                 break;
886         }
887     }
888
889     /* link us to the ir_value */
890     self->ir_v = v;
891     return true;
892
893 error: /* clean up */
894     ir_value_delete(v);
895     return false;
896 }
897
898 bool ast_function_codegen(ast_function *self, ir_builder *ir)
899 {
900     ir_function *irf;
901     ir_value    *dummy;
902     ast_expression_common *ec;
903     size_t    i;
904
905     irf = self->ir_func;
906     if (!irf) {
907         asterror(ast_ctx(self), "ast_function's related ast_value was not generated yet");
908         return false;
909     }
910
911     /* fill the parameter list */
912     ec = &self->vtype->expression;
913     for (i = 0; i < ec->params_count; ++i)
914     {
915         if (!ir_function_params_add(irf, ec->params[i]->expression.vtype))
916             return false;
917         if (!self->builtin) {
918             if (!ast_local_codegen(ec->params[i], self->ir_func, true))
919                 return false;
920         }
921     }
922
923     if (self->builtin) {
924         irf->builtin = self->builtin;
925         return true;
926     }
927
928     if (!self->blocks_count) {
929         asterror(ast_ctx(self), "function `%s` has no body", self->name);
930         return false;
931     }
932
933     self->curblock = ir_function_create_block(irf, "entry");
934     if (!self->curblock) {
935         asterror(ast_ctx(self), "failed to allocate entry block for `%s`", self->name);
936         return false;
937     }
938
939     for (i = 0; i < self->blocks_count; ++i) {
940         ast_expression_codegen *gen = self->blocks[i]->expression.codegen;
941         if (!(*gen)((ast_expression*)self->blocks[i], self, false, &dummy))
942             return false;
943     }
944
945     /* TODO: check return types */
946     if (!self->curblock->is_return)
947     {
948         return ir_block_create_return(self->curblock, NULL);
949         /* From now on the parser has to handle this situation */
950 #if 0
951         if (!self->vtype->expression.next ||
952             self->vtype->expression.next->expression.vtype == TYPE_VOID)
953         {
954             return ir_block_create_return(self->curblock, NULL);
955         }
956         else
957         {
958             /* error("missing return"); */
959             asterror(ast_ctx(self), "function `%s` missing return value", self->name);
960             return false;
961         }
962 #endif
963     }
964     return true;
965 }
966
967 /* Note, you will not see ast_block_codegen generate ir_blocks.
968  * To the AST and the IR, blocks are 2 different things.
969  * In the AST it represents a block of code, usually enclosed in
970  * curly braces {...}.
971  * While in the IR it represents a block in terms of control-flow.
972  */
973 bool ast_block_codegen(ast_block *self, ast_function *func, bool lvalue, ir_value **out)
974 {
975     size_t i;
976
977     /* We don't use this
978      * Note: an ast-representation using the comma-operator
979      * of the form: (a, b, c) = x should not assign to c...
980      */
981     (void)lvalue;
982     if (self->expression.outr) {
983         *out = self->expression.outr;
984         return true;
985     }
986
987     /* output is NULL at first, we'll have each expression
988      * assign to out output, thus, a comma-operator represention
989      * using an ast_block will return the last generated value,
990      * so: (b, c) + a  executed both b and c, and returns c,
991      * which is then added to a.
992      */
993     *out = NULL;
994
995     /* generate locals */
996     for (i = 0; i < self->locals_count; ++i)
997     {
998         if (!ast_local_codegen(self->locals[i], func->ir_func, false)) {
999             if (opts_debug)
1000                 asterror(ast_ctx(self), "failed to generate local `%s`", self->locals[i]->name);
1001             return false;
1002         }
1003     }
1004
1005     for (i = 0; i < self->exprs_count; ++i)
1006     {
1007         ast_expression_codegen *gen = self->exprs[i]->expression.codegen;
1008         if (!(*gen)(self->exprs[i], func, false, out))
1009             return false;
1010     }
1011
1012     self->expression.outr = *out;
1013
1014     return true;
1015 }
1016
1017 bool ast_store_codegen(ast_store *self, ast_function *func, bool lvalue, ir_value **out)
1018 {
1019     ast_expression_codegen *cgen;
1020     ir_value *left, *right;
1021
1022     if (lvalue && self->expression.outl) {
1023         *out = self->expression.outl;
1024         return true;
1025     }
1026
1027     if (!lvalue && self->expression.outr) {
1028         *out = self->expression.outr;
1029         return true;
1030     }
1031
1032     cgen = self->dest->expression.codegen;
1033     /* lvalue! */
1034     if (!(*cgen)((ast_expression*)(self->dest), func, true, &left))
1035         return false;
1036     self->expression.outl = left;
1037
1038     cgen = self->source->expression.codegen;
1039     /* rvalue! */
1040     if (!(*cgen)((ast_expression*)(self->source), func, false, &right))
1041         return false;
1042
1043     if (!ir_block_create_store_op(func->curblock, self->op, left, right))
1044         return false;
1045     self->expression.outr = right;
1046
1047     /* Theoretically, an assinment returns its left side as an
1048      * lvalue, if we don't need an lvalue though, we return
1049      * the right side as an rvalue, otherwise we have to
1050      * somehow know whether or not we need to dereference the pointer
1051      * on the left side - that is: OP_LOAD if it was an address.
1052      * Also: in original QC we cannot OP_LOADP *anyway*.
1053      */
1054     *out = (lvalue ? left : right);
1055
1056     return true;
1057 }
1058
1059 bool ast_binary_codegen(ast_binary *self, ast_function *func, bool lvalue, ir_value **out)
1060 {
1061     ast_expression_codegen *cgen;
1062     ir_value *left, *right;
1063
1064     /* In the context of a binary operation, we can disregard
1065      * the lvalue flag.
1066      */
1067     (void)lvalue;
1068     if (self->expression.outr) {
1069         *out = self->expression.outr;
1070         return true;
1071     }
1072
1073     cgen = self->left->expression.codegen;
1074     /* lvalue! */
1075     if (!(*cgen)((ast_expression*)(self->left), func, false, &left))
1076         return false;
1077
1078     cgen = self->right->expression.codegen;
1079     /* rvalue! */
1080     if (!(*cgen)((ast_expression*)(self->right), func, false, &right))
1081         return false;
1082
1083     *out = ir_block_create_binop(func->curblock, ast_function_label(func, "bin"),
1084                                  self->op, left, right);
1085     if (!*out)
1086         return false;
1087     self->expression.outr = *out;
1088
1089     return true;
1090 }
1091
1092 bool ast_binstore_codegen(ast_binstore *self, ast_function *func, bool lvalue, ir_value **out)
1093 {
1094     ast_expression_codegen *cgen;
1095     ir_value *leftl, *leftr, *right, *bin;
1096
1097     if (lvalue && self->expression.outl) {
1098         *out = self->expression.outl;
1099         return true;
1100     }
1101
1102     if (!lvalue && self->expression.outr) {
1103         *out = self->expression.outr;
1104         return true;
1105     }
1106
1107     /* for a binstore we need both an lvalue and an rvalue for the left side */
1108     /* rvalue of destination! */
1109     cgen = self->dest->expression.codegen;
1110     if (!(*cgen)((ast_expression*)(self->dest), func, false, &leftr))
1111         return false;
1112
1113     /* source as rvalue only */
1114     cgen = self->source->expression.codegen;
1115     if (!(*cgen)((ast_expression*)(self->source), func, false, &right))
1116         return false;
1117
1118     /* now the binary */
1119     bin = ir_block_create_binop(func->curblock, ast_function_label(func, "binst"),
1120                                 self->opbin, leftr, right);
1121     self->expression.outr = bin;
1122
1123     /* now store them */
1124     cgen = self->dest->expression.codegen;
1125     /* lvalue of destination */
1126     if (!(*cgen)((ast_expression*)(self->dest), func, true, &leftl))
1127         return false;
1128     self->expression.outl = leftl;
1129
1130     if (!ir_block_create_store_op(func->curblock, self->opstore, leftl, bin))
1131         return false;
1132     self->expression.outr = bin;
1133
1134     /* Theoretically, an assinment returns its left side as an
1135      * lvalue, if we don't need an lvalue though, we return
1136      * the right side as an rvalue, otherwise we have to
1137      * somehow know whether or not we need to dereference the pointer
1138      * on the left side - that is: OP_LOAD if it was an address.
1139      * Also: in original QC we cannot OP_LOADP *anyway*.
1140      */
1141     *out = (lvalue ? leftl : bin);
1142
1143     return true;
1144 }
1145
1146 bool ast_unary_codegen(ast_unary *self, ast_function *func, bool lvalue, ir_value **out)
1147 {
1148     ast_expression_codegen *cgen;
1149     ir_value *operand;
1150
1151     /* In the context of a unary operation, we can disregard
1152      * the lvalue flag.
1153      */
1154     (void)lvalue;
1155     if (self->expression.outr) {
1156         *out = self->expression.outr;
1157         return true;
1158     }
1159
1160     cgen = self->operand->expression.codegen;
1161     /* lvalue! */
1162     if (!(*cgen)((ast_expression*)(self->operand), func, false, &operand))
1163         return false;
1164
1165     *out = ir_block_create_unary(func->curblock, ast_function_label(func, "unary"),
1166                                  self->op, operand);
1167     if (!*out)
1168         return false;
1169     self->expression.outr = *out;
1170
1171     return true;
1172 }
1173
1174 bool ast_return_codegen(ast_return *self, ast_function *func, bool lvalue, ir_value **out)
1175 {
1176     ast_expression_codegen *cgen;
1177     ir_value *operand;
1178
1179     /* In the context of a return operation, we can disregard
1180      * the lvalue flag.
1181      */
1182     (void)lvalue;
1183     if (self->expression.outr) {
1184         asterror(ast_ctx(self), "internal error: ast_return cannot be reused, it bears no result!");
1185         return false;
1186     }
1187     self->expression.outr = (ir_value*)1;
1188
1189     if (self->operand) {
1190         cgen = self->operand->expression.codegen;
1191         /* lvalue! */
1192         if (!(*cgen)((ast_expression*)(self->operand), func, false, &operand))
1193             return false;
1194
1195         if (!ir_block_create_return(func->curblock, operand))
1196             return false;
1197     } else {
1198         if (!ir_block_create_return(func->curblock, NULL))
1199             return false;
1200     }
1201
1202     return true;
1203 }
1204
1205 bool ast_entfield_codegen(ast_entfield *self, ast_function *func, bool lvalue, ir_value **out)
1206 {
1207     ast_expression_codegen *cgen;
1208     ir_value *ent, *field;
1209
1210     /* This function needs to take the 'lvalue' flag into account!
1211      * As lvalue we provide a field-pointer, as rvalue we provide the
1212      * value in a temp.
1213      */
1214
1215     if (lvalue && self->expression.outl) {
1216         *out = self->expression.outl;
1217         return true;
1218     }
1219
1220     if (!lvalue && self->expression.outr) {
1221         *out = self->expression.outr;
1222         return true;
1223     }
1224
1225     cgen = self->entity->expression.codegen;
1226     if (!(*cgen)((ast_expression*)(self->entity), func, false, &ent))
1227         return false;
1228
1229     cgen = self->field->expression.codegen;
1230     if (!(*cgen)((ast_expression*)(self->field), func, false, &field))
1231         return false;
1232
1233     if (lvalue) {
1234         /* address! */
1235         *out = ir_block_create_fieldaddress(func->curblock, ast_function_label(func, "efa"),
1236                                             ent, field);
1237     } else {
1238         *out = ir_block_create_load_from_ent(func->curblock, ast_function_label(func, "efv"),
1239                                              ent, field, self->expression.vtype);
1240     }
1241     if (!*out) {
1242         asterror(ast_ctx(self), "failed to create %s instruction (output type %s)",
1243                  (lvalue ? "ADDRESS" : "FIELD"),
1244                  type_name[self->expression.vtype]);
1245         return false;
1246     }
1247
1248     if (lvalue)
1249         self->expression.outl = *out;
1250     else
1251         self->expression.outr = *out;
1252
1253     /* Hm that should be it... */
1254     return true;
1255 }
1256
1257 bool ast_member_codegen(ast_member *self, ast_function *func, bool lvalue, ir_value **out)
1258 {
1259     ast_expression_codegen *cgen;
1260     ir_value *vec;
1261
1262     /* in QC this is always an lvalue */
1263     (void)lvalue;
1264     if (self->expression.outl) {
1265         *out = self->expression.outl;
1266         return true;
1267     }
1268
1269     cgen = self->owner->expression.codegen;
1270     if (!(*cgen)((ast_expression*)(self->owner), func, true, &vec))
1271         return false;
1272
1273     if (vec->vtype != TYPE_VECTOR &&
1274         !(vec->vtype == TYPE_FIELD && self->owner->expression.next->expression.vtype == TYPE_VECTOR))
1275     {
1276         return false;
1277     }
1278
1279     *out = ir_value_vector_member(vec, self->field);
1280     self->expression.outl = *out;
1281
1282     return (*out != NULL);
1283 }
1284
1285 bool ast_ifthen_codegen(ast_ifthen *self, ast_function *func, bool lvalue, ir_value **out)
1286 {
1287     ast_expression_codegen *cgen;
1288
1289     ir_value *condval;
1290     ir_value *dummy;
1291
1292     ir_block *cond = func->curblock;
1293     ir_block *ontrue;
1294     ir_block *onfalse;
1295     ir_block *ontrue_endblock;
1296     ir_block *onfalse_endblock;
1297     ir_block *merge;
1298
1299     /* We don't output any value, thus also don't care about r/lvalue */
1300     (void)out;
1301     (void)lvalue;
1302
1303     if (self->expression.outr) {
1304         asterror(ast_ctx(self), "internal error: ast_ifthen cannot be reused, it bears no result!");
1305         return false;
1306     }
1307     self->expression.outr = (ir_value*)1;
1308
1309     /* generate the condition */
1310     func->curblock = cond;
1311     cgen = self->cond->expression.codegen;
1312     if (!(*cgen)((ast_expression*)(self->cond), func, false, &condval))
1313         return false;
1314
1315     /* on-true path */
1316
1317     if (self->on_true) {
1318         /* create on-true block */
1319         ontrue = ir_function_create_block(func->ir_func, ast_function_label(func, "ontrue"));
1320         if (!ontrue)
1321             return false;
1322
1323         /* enter the block */
1324         func->curblock = ontrue;
1325
1326         /* generate */
1327         cgen = self->on_true->expression.codegen;
1328         if (!(*cgen)((ast_expression*)(self->on_true), func, false, &dummy))
1329             return false;
1330
1331         /* we now need to work from the current endpoint */
1332         ontrue_endblock = func->curblock;
1333     } else
1334         ontrue = NULL;
1335
1336     /* on-false path */
1337     if (self->on_false) {
1338         /* create on-false block */
1339         onfalse = ir_function_create_block(func->ir_func, ast_function_label(func, "onfalse"));
1340         if (!onfalse)
1341             return false;
1342
1343         /* enter the block */
1344         func->curblock = onfalse;
1345
1346         /* generate */
1347         cgen = self->on_false->expression.codegen;
1348         if (!(*cgen)((ast_expression*)(self->on_false), func, false, &dummy))
1349             return false;
1350
1351         /* we now need to work from the current endpoint */
1352         onfalse_endblock = func->curblock;
1353     } else
1354         onfalse = NULL;
1355
1356     /* Merge block were they all merge in to */
1357     merge = ir_function_create_block(func->ir_func, ast_function_label(func, "endif"));
1358     if (!merge)
1359         return false;
1360
1361     /* add jumps ot the merge block */
1362     if (ontrue && !ontrue_endblock->final && !ir_block_create_jump(ontrue_endblock, merge))
1363         return false;
1364     if (onfalse && !onfalse_endblock->final && !ir_block_create_jump(onfalse_endblock, merge))
1365         return false;
1366
1367     /* we create the if here, that way all blocks are ordered :)
1368      */
1369     if (!ir_block_create_if(cond, condval,
1370                             (ontrue  ? ontrue  : merge),
1371                             (onfalse ? onfalse : merge)))
1372     {
1373         return false;
1374     }
1375
1376     /* Now enter the merge block */
1377     func->curblock = merge;
1378
1379     return true;
1380 }
1381
1382 bool ast_ternary_codegen(ast_ternary *self, ast_function *func, bool lvalue, ir_value **out)
1383 {
1384     ast_expression_codegen *cgen;
1385
1386     ir_value *condval;
1387     ir_value *trueval, *falseval;
1388     ir_instr *phi;
1389
1390     ir_block *cond = func->curblock;
1391     ir_block *ontrue;
1392     ir_block *onfalse;
1393     ir_block *merge;
1394
1395     /* Ternary can never create an lvalue... */
1396     if (lvalue)
1397         return false;
1398
1399     /* In theory it shouldn't be possible to pass through a node twice, but
1400      * in case we add any kind of optimization pass for the AST itself, it
1401      * may still happen, thus we remember a created ir_value and simply return one
1402      * if it already exists.
1403      */
1404     if (self->phi_out) {
1405         *out = self->phi_out;
1406         return true;
1407     }
1408
1409     /* In the following, contraty to ast_ifthen, we assume both paths exist. */
1410
1411     /* generate the condition */
1412     func->curblock = cond;
1413     cgen = self->cond->expression.codegen;
1414     if (!(*cgen)((ast_expression*)(self->cond), func, false, &condval))
1415         return false;
1416
1417     /* create on-true block */
1418     ontrue = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_T"));
1419     if (!ontrue)
1420         return false;
1421     else
1422     {
1423         /* enter the block */
1424         func->curblock = ontrue;
1425
1426         /* generate */
1427         cgen = self->on_true->expression.codegen;
1428         if (!(*cgen)((ast_expression*)(self->on_true), func, false, &trueval))
1429             return false;
1430     }
1431
1432     /* create on-false block */
1433     onfalse = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_F"));
1434     if (!onfalse)
1435         return false;
1436     else
1437     {
1438         /* enter the block */
1439         func->curblock = onfalse;
1440
1441         /* generate */
1442         cgen = self->on_false->expression.codegen;
1443         if (!(*cgen)((ast_expression*)(self->on_false), func, false, &falseval))
1444             return false;
1445     }
1446
1447     /* create merge block */
1448     merge = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_out"));
1449     if (!merge)
1450         return false;
1451     /* jump to merge block */
1452     if (!ir_block_create_jump(ontrue, merge))
1453         return false;
1454     if (!ir_block_create_jump(onfalse, merge))
1455         return false;
1456
1457     /* create if instruction */
1458     if (!ir_block_create_if(cond, condval, ontrue, onfalse))
1459         return false;
1460
1461     /* Now enter the merge block */
1462     func->curblock = merge;
1463
1464     /* Here, now, we need a PHI node
1465      * but first some sanity checking...
1466      */
1467     if (trueval->vtype != falseval->vtype) {
1468         /* error("ternary with different types on the two sides"); */
1469         return false;
1470     }
1471
1472     /* create PHI */
1473     phi = ir_block_create_phi(merge, ast_function_label(func, "phi"), trueval->vtype);
1474     if (!phi ||
1475         !ir_phi_add(phi, ontrue,  trueval) ||
1476         !ir_phi_add(phi, onfalse, falseval))
1477     {
1478         return false;
1479     }
1480
1481     self->phi_out = ir_phi_value(phi);
1482     *out = self->phi_out;
1483
1484     return true;
1485 }
1486
1487 bool ast_loop_codegen(ast_loop *self, ast_function *func, bool lvalue, ir_value **out)
1488 {
1489     ast_expression_codegen *cgen;
1490
1491     ir_value *dummy      = NULL;
1492     ir_value *precond    = NULL;
1493     ir_value *postcond   = NULL;
1494
1495     /* Since we insert some jumps "late" so we have blocks
1496      * ordered "nicely", we need to keep track of the actual end-blocks
1497      * of expressions to add the jumps to.
1498      */
1499     ir_block *bbody      = NULL, *end_bbody      = NULL;
1500     ir_block *bprecond   = NULL, *end_bprecond   = NULL;
1501     ir_block *bpostcond  = NULL, *end_bpostcond  = NULL;
1502     ir_block *bincrement = NULL, *end_bincrement = NULL;
1503     ir_block *bout       = NULL, *bin            = NULL;
1504
1505     /* let's at least move the outgoing block to the end */
1506     size_t    bout_id;
1507
1508     /* 'break' and 'continue' need to be able to find the right blocks */
1509     ir_block *bcontinue     = NULL;
1510     ir_block *bbreak        = NULL;
1511
1512     ir_block *old_bcontinue = NULL;
1513     ir_block *old_bbreak    = NULL;
1514
1515     ir_block *tmpblock      = NULL;
1516
1517     (void)lvalue;
1518     (void)out;
1519
1520     if (self->expression.outr) {
1521         asterror(ast_ctx(self), "internal error: ast_loop cannot be reused, it bears no result!");
1522         return false;
1523     }
1524     self->expression.outr = (ir_value*)1;
1525
1526     /* NOTE:
1527      * Should we ever need some kind of block ordering, better make this function
1528      * move blocks around than write a block ordering algorithm later... after all
1529      * the ast and ir should work together, not against each other.
1530      */
1531
1532     /* initexpr doesn't get its own block, it's pointless, it could create more blocks
1533      * anyway if for example it contains a ternary.
1534      */
1535     if (self->initexpr)
1536     {
1537         cgen = self->initexpr->expression.codegen;
1538         if (!(*cgen)((ast_expression*)(self->initexpr), func, false, &dummy))
1539             return false;
1540     }
1541
1542     /* Store the block from which we enter this chaos */
1543     bin = func->curblock;
1544
1545     /* The pre-loop condition needs its own block since we
1546      * need to be able to jump to the start of that expression.
1547      */
1548     if (self->precond)
1549     {
1550         bprecond = ir_function_create_block(func->ir_func, ast_function_label(func, "pre_loop_cond"));
1551         if (!bprecond)
1552             return false;
1553
1554         /* the pre-loop-condition the least important place to 'continue' at */
1555         bcontinue = bprecond;
1556
1557         /* enter */
1558         func->curblock = bprecond;
1559
1560         /* generate */
1561         cgen = self->precond->expression.codegen;
1562         if (!(*cgen)((ast_expression*)(self->precond), func, false, &precond))
1563             return false;
1564
1565         end_bprecond = func->curblock;
1566     } else {
1567         bprecond = end_bprecond = NULL;
1568     }
1569
1570     /* Now the next blocks won't be ordered nicely, but we need to
1571      * generate them this early for 'break' and 'continue'.
1572      */
1573     if (self->increment) {
1574         bincrement = ir_function_create_block(func->ir_func, ast_function_label(func, "loop_increment"));
1575         if (!bincrement)
1576             return false;
1577         bcontinue = bincrement; /* increment comes before the pre-loop-condition */
1578     } else {
1579         bincrement = end_bincrement = NULL;
1580     }
1581
1582     if (self->postcond) {
1583         bpostcond = ir_function_create_block(func->ir_func, ast_function_label(func, "post_loop_cond"));
1584         if (!bpostcond)
1585             return false;
1586         bcontinue = bpostcond; /* postcond comes before the increment */
1587     } else {
1588         bpostcond = end_bpostcond = NULL;
1589     }
1590
1591     bout_id = func->ir_func->blocks_count;
1592     bout = ir_function_create_block(func->ir_func, ast_function_label(func, "after_loop"));
1593     if (!bout)
1594         return false;
1595     bbreak = bout;
1596
1597     /* The loop body... */
1598     if (self->body)
1599     {
1600         bbody = ir_function_create_block(func->ir_func, ast_function_label(func, "loop_body"));
1601         if (!bbody)
1602             return false;
1603
1604         /* enter */
1605         func->curblock = bbody;
1606
1607         old_bbreak          = func->breakblock;
1608         old_bcontinue       = func->continueblock;
1609         func->breakblock    = bbreak;
1610         func->continueblock = bcontinue;
1611
1612         /* generate */
1613         cgen = self->body->expression.codegen;
1614         if (!(*cgen)((ast_expression*)(self->body), func, false, &dummy))
1615             return false;
1616
1617         end_bbody = func->curblock;
1618         func->breakblock    = old_bbreak;
1619         func->continueblock = old_bcontinue;
1620     }
1621
1622     /* post-loop-condition */
1623     if (self->postcond)
1624     {
1625         /* enter */
1626         func->curblock = bpostcond;
1627
1628         /* generate */
1629         cgen = self->postcond->expression.codegen;
1630         if (!(*cgen)((ast_expression*)(self->postcond), func, false, &postcond))
1631             return false;
1632
1633         end_bpostcond = func->curblock;
1634     }
1635
1636     /* The incrementor */
1637     if (self->increment)
1638     {
1639         /* enter */
1640         func->curblock = bincrement;
1641
1642         /* generate */
1643         cgen = self->increment->expression.codegen;
1644         if (!(*cgen)((ast_expression*)(self->increment), func, false, &dummy))
1645             return false;
1646
1647         end_bincrement = func->curblock;
1648     }
1649
1650     /* In any case now, we continue from the outgoing block */
1651     func->curblock = bout;
1652
1653     /* Now all blocks are in place */
1654     /* From 'bin' we jump to whatever comes first */
1655     if      (bprecond)   tmpblock = bprecond;
1656     else if (bbody)      tmpblock = bbody;
1657     else if (bpostcond)  tmpblock = bpostcond;
1658     else                 tmpblock = bout;
1659     if (!ir_block_create_jump(bin, tmpblock))
1660         return false;
1661
1662     /* From precond */
1663     if (bprecond)
1664     {
1665         ir_block *ontrue, *onfalse;
1666         if      (bbody)      ontrue = bbody;
1667         else if (bincrement) ontrue = bincrement;
1668         else if (bpostcond)  ontrue = bpostcond;
1669         else                 ontrue = bprecond;
1670         onfalse = bout;
1671         if (!ir_block_create_if(end_bprecond, precond, ontrue, onfalse))
1672             return false;
1673     }
1674
1675     /* from body */
1676     if (bbody)
1677     {
1678         if      (bincrement) tmpblock = bincrement;
1679         else if (bpostcond)  tmpblock = bpostcond;
1680         else if (bprecond)   tmpblock = bprecond;
1681         else                 tmpblock = bout;
1682         if (!end_bbody->final && !ir_block_create_jump(end_bbody, tmpblock))
1683             return false;
1684     }
1685
1686     /* from increment */
1687     if (bincrement)
1688     {
1689         if      (bpostcond)  tmpblock = bpostcond;
1690         else if (bprecond)   tmpblock = bprecond;
1691         else if (bbody)      tmpblock = bbody;
1692         else                 tmpblock = bout;
1693         if (!ir_block_create_jump(end_bincrement, tmpblock))
1694             return false;
1695     }
1696
1697     /* from postcond */
1698     if (bpostcond)
1699     {
1700         ir_block *ontrue, *onfalse;
1701         if      (bprecond)   ontrue = bprecond;
1702         else if (bbody)      ontrue = bbody;
1703         else if (bincrement) ontrue = bincrement;
1704         else                 ontrue = bpostcond;
1705         onfalse = bout;
1706         if (!ir_block_create_if(end_bpostcond, postcond, ontrue, onfalse))
1707             return false;
1708     }
1709
1710     /* Move 'bout' to the end */
1711     if (!ir_function_blocks_remove(func->ir_func, bout_id) ||
1712         !ir_function_blocks_add(func->ir_func, bout))
1713     {
1714         ir_block_delete(bout);
1715         return false;
1716     }
1717
1718     return true;
1719 }
1720
1721 bool ast_call_codegen(ast_call *self, ast_function *func, bool lvalue, ir_value **out)
1722 {
1723     ast_expression_codegen *cgen;
1724     ir_value_vector         params;
1725     ir_instr               *callinstr;
1726     size_t i;
1727
1728     ir_value *funval = NULL;
1729
1730     /* return values are never lvalues */
1731     (void)lvalue;
1732
1733     if (self->expression.outr) {
1734         *out = self->expression.outr;
1735         return true;
1736     }
1737
1738     cgen = self->func->expression.codegen;
1739     if (!(*cgen)((ast_expression*)(self->func), func, false, &funval))
1740         return false;
1741     if (!funval)
1742         return false;
1743
1744     MEM_VECTOR_INIT(&params, v);
1745
1746     /* parameters */
1747     for (i = 0; i < self->params_count; ++i)
1748     {
1749         ir_value *param;
1750         ast_expression *expr = self->params[i];
1751
1752         cgen = expr->expression.codegen;
1753         if (!(*cgen)(expr, func, false, &param))
1754             goto error;
1755         if (!param)
1756             goto error;
1757         if (!ir_value_vector_v_add(&params, param))
1758             goto error;
1759     }
1760
1761     callinstr = ir_block_create_call(func->curblock, ast_function_label(func, "call"), funval);
1762     if (!callinstr)
1763         goto error;
1764
1765     for (i = 0; i < params.v_count; ++i) {
1766         if (!ir_call_param(callinstr, params.v[i]))
1767             goto error;
1768     }
1769
1770     *out = ir_call_value(callinstr);
1771     self->expression.outr = *out;
1772
1773     MEM_VECTOR_CLEAR(&params, v);
1774     return true;
1775 error:
1776     MEM_VECTOR_CLEAR(&params, v);
1777     return false;
1778 }