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:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
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
30 #define ast_instantiate(T, ctx, destroyfn) \
31 T* self = (T*)mem_a(sizeof(T)); \
35 ast_node_init((ast_node*)self, ctx, TYPE_##T); \
36 ( (ast_node*)self )->node.destroy = (ast_node_delete*)destroyfn
40 static void asterror(lex_ctx ctx, const char *msg, ...)
44 con_cvprintmsg((void*)&ctx, LVL_ERROR, "error", msg, ap);
48 /* It must not be possible to get here. */
49 static GMQCC_NORETURN void _ast_node_destroy(ast_node *self)
52 con_err("ast node missing destroy()\n");
56 /* Initialize main ast node aprts */
57 static void ast_node_init(ast_node *self, lex_ctx ctx, int nodetype)
59 self->node.context = ctx;
60 self->node.destroy = &_ast_node_destroy;
61 self->node.keep = false;
62 self->node.nodetype = nodetype;
63 self->node.side_effects = false;
66 /* weight and side effects */
67 static void _ast_propagate_effects(ast_node *self, ast_node *other)
69 if (ast_side_effects(other))
70 ast_side_effects(self) = true;
72 #define ast_propagate_effects(s,o) _ast_propagate_effects(((ast_node*)(s)), ((ast_node*)(o)))
74 /* General expression initialization */
75 static void ast_expression_init(ast_expression *self,
76 ast_expression_codegen *codegen)
78 self->expression.codegen = codegen;
79 self->expression.vtype = TYPE_VOID;
80 self->expression.next = NULL;
81 self->expression.outl = NULL;
82 self->expression.outr = NULL;
83 self->expression.variadic = false;
84 self->expression.params = NULL;
87 static void ast_expression_delete(ast_expression *self)
90 if (self->expression.next)
91 ast_delete(self->expression.next);
92 for (i = 0; i < vec_size(self->expression.params); ++i) {
93 ast_delete(self->expression.params[i]);
95 vec_free(self->expression.params);
98 static void ast_expression_delete_full(ast_expression *self)
100 ast_expression_delete(self);
104 ast_value* ast_value_copy(const ast_value *self)
107 const ast_expression_common *fromex;
108 ast_expression_common *selfex;
109 ast_value *cp = ast_value_new(self->expression.node.context, self->name, self->expression.vtype);
110 if (self->expression.next) {
111 cp->expression.next = ast_type_copy(self->expression.node.context, self->expression.next);
112 if (!cp->expression.next) {
113 ast_value_delete(cp);
117 fromex = &self->expression;
118 selfex = &cp->expression;
119 selfex->variadic = fromex->variadic;
120 for (i = 0; i < vec_size(fromex->params); ++i) {
121 ast_value *v = ast_value_copy(fromex->params[i]);
123 ast_value_delete(cp);
126 vec_push(selfex->params, v);
131 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other)
134 const ast_expression_common *fromex;
135 ast_expression_common *selfex;
136 self->expression.vtype = other->expression.vtype;
137 if (other->expression.next) {
138 self->expression.next = (ast_expression*)ast_type_copy(ast_ctx(self), other->expression.next);
139 if (!self->expression.next)
142 fromex = &other->expression;
143 selfex = &self->expression;
144 selfex->variadic = fromex->variadic;
145 for (i = 0; i < vec_size(fromex->params); ++i) {
146 ast_value *v = ast_value_copy(fromex->params[i]);
149 vec_push(selfex->params, v);
154 static ast_expression* ast_shallow_type(lex_ctx ctx, int vtype)
156 ast_instantiate(ast_expression, ctx, ast_expression_delete_full);
157 ast_expression_init(self, NULL);
158 self->expression.codegen = NULL;
159 self->expression.next = NULL;
160 self->expression.vtype = vtype;
164 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex)
167 const ast_expression_common *fromex;
168 ast_expression_common *selfex;
174 ast_instantiate(ast_expression, ctx, ast_expression_delete_full);
175 ast_expression_init(self, NULL);
177 fromex = &ex->expression;
178 selfex = &self->expression;
180 /* This may never be codegen()d */
181 selfex->codegen = NULL;
183 selfex->vtype = fromex->vtype;
186 selfex->next = ast_type_copy(ctx, fromex->next);
188 ast_expression_delete_full(self);
195 selfex->variadic = fromex->variadic;
196 for (i = 0; i < vec_size(fromex->params); ++i) {
197 ast_value *v = ast_value_copy(fromex->params[i]);
199 ast_expression_delete_full(self);
202 vec_push(selfex->params, v);
209 bool ast_compare_type(ast_expression *a, ast_expression *b)
211 if (a->expression.vtype != b->expression.vtype)
213 if (!a->expression.next != !b->expression.next)
215 if (vec_size(a->expression.params) != vec_size(b->expression.params))
217 if (a->expression.variadic != b->expression.variadic)
219 if (vec_size(a->expression.params)) {
221 for (i = 0; i < vec_size(a->expression.params); ++i) {
222 if (!ast_compare_type((ast_expression*)a->expression.params[i],
223 (ast_expression*)b->expression.params[i]))
227 if (a->expression.next)
228 return ast_compare_type(a->expression.next, b->expression.next);
232 static size_t ast_type_to_string_impl(ast_expression *e, char *buf, size_t bufsize, size_t pos)
239 if (pos + 6 >= bufsize)
241 strcpy(buf + pos, "(null)");
245 if (pos + 1 >= bufsize)
248 switch (e->expression.vtype) {
250 strcpy(buf + pos, "(variant)");
255 return ast_type_to_string_impl(e->expression.next, buf, bufsize, pos);
258 if (pos + 3 >= bufsize)
262 pos = ast_type_to_string_impl(e->expression.next, buf, bufsize, pos);
263 if (pos + 1 >= bufsize)
269 pos = ast_type_to_string_impl(e->expression.next, buf, bufsize, pos);
270 if (pos + 2 >= bufsize)
272 if (!vec_size(e->expression.params)) {
278 pos = ast_type_to_string_impl((ast_expression*)(e->expression.params[0]), buf, bufsize, pos);
279 for (i = 1; i < vec_size(e->expression.params); ++i) {
280 if (pos + 2 >= bufsize)
284 pos = ast_type_to_string_impl((ast_expression*)(e->expression.params[i]), buf, bufsize, pos);
286 if (pos + 1 >= bufsize)
292 pos = ast_type_to_string_impl(e->expression.next, buf, bufsize, pos);
293 if (pos + 1 >= bufsize)
296 pos += snprintf(buf + pos, bufsize - pos - 1, "%i", (int)e->expression.count);
297 if (pos + 1 >= bufsize)
303 typestr = type_name[e->expression.vtype];
304 typelen = strlen(typestr);
305 if (pos + typelen >= bufsize)
307 strcpy(buf + pos, typestr);
308 return pos + typelen;
312 buf[bufsize-3] = '.';
313 buf[bufsize-2] = '.';
314 buf[bufsize-1] = '.';
318 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize)
320 size_t pos = ast_type_to_string_impl(e, buf, bufsize-1, 0);
324 ast_value* ast_value_new(lex_ctx ctx, const char *name, int t)
326 ast_instantiate(ast_value, ctx, ast_value_delete);
327 ast_expression_init((ast_expression*)self,
328 (ast_expression_codegen*)&ast_value_codegen);
329 self->expression.node.keep = true; /* keep */
331 self->name = name ? util_strdup(name) : NULL;
332 self->expression.vtype = t;
333 self->expression.next = NULL;
334 self->constant = false;
335 self->hasvalue = false;
337 memset(&self->constval, 0, sizeof(self->constval));
340 self->ir_values = NULL;
341 self->ir_value_count = 0;
349 void ast_value_delete(ast_value* self)
352 mem_d((void*)self->name);
353 if (self->hasvalue) {
354 switch (self->expression.vtype)
357 mem_d((void*)self->constval.vstring);
360 /* unlink us from the function node */
361 self->constval.vfunc->vtype = NULL;
363 /* NOTE: delete function? currently collected in
364 * the parser structure
371 mem_d(self->ir_values);
372 ast_expression_delete((ast_expression*)self);
376 void ast_value_params_add(ast_value *self, ast_value *p)
378 vec_push(self->expression.params, p);
381 bool ast_value_set_name(ast_value *self, const char *name)
384 mem_d((void*)self->name);
385 self->name = util_strdup(name);
389 ast_binary* ast_binary_new(lex_ctx ctx, int op,
390 ast_expression* left, ast_expression* right)
392 ast_instantiate(ast_binary, ctx, ast_binary_delete);
393 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_binary_codegen);
399 ast_propagate_effects(self, left);
400 ast_propagate_effects(self, right);
402 if (op >= INSTR_EQ_F && op <= INSTR_GT)
403 self->expression.vtype = TYPE_FLOAT;
404 else if (op == INSTR_AND || op == INSTR_OR ||
405 op == INSTR_BITAND || op == INSTR_BITOR)
406 self->expression.vtype = TYPE_FLOAT;
407 else if (op == INSTR_MUL_VF || op == INSTR_MUL_FV)
408 self->expression.vtype = TYPE_VECTOR;
409 else if (op == INSTR_MUL_V)
410 self->expression.vtype = TYPE_FLOAT;
412 self->expression.vtype = left->expression.vtype;
417 void ast_binary_delete(ast_binary *self)
419 ast_unref(self->left);
420 ast_unref(self->right);
421 ast_expression_delete((ast_expression*)self);
425 ast_binstore* ast_binstore_new(lex_ctx ctx, int storop, int op,
426 ast_expression* left, ast_expression* right)
428 ast_instantiate(ast_binstore, ctx, ast_binstore_delete);
429 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_binstore_codegen);
431 ast_side_effects(self) = true;
433 self->opstore = storop;
436 self->source = right;
438 self->expression.vtype = left->expression.vtype;
439 if (left->expression.next) {
440 self->expression.next = ast_type_copy(ctx, left);
441 if (!self->expression.next) {
447 self->expression.next = NULL;
452 void ast_binstore_delete(ast_binstore *self)
454 ast_unref(self->dest);
455 ast_unref(self->source);
456 ast_expression_delete((ast_expression*)self);
460 ast_unary* ast_unary_new(lex_ctx ctx, int op,
461 ast_expression *expr)
463 ast_instantiate(ast_unary, ctx, ast_unary_delete);
464 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_unary_codegen);
467 self->operand = expr;
469 ast_propagate_effects(self, expr);
471 if (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) {
472 self->expression.vtype = TYPE_FLOAT;
474 asterror(ctx, "cannot determine type of unary operation %s", asm_instr[op].m);
479 void ast_unary_delete(ast_unary *self)
481 ast_unref(self->operand);
482 ast_expression_delete((ast_expression*)self);
486 ast_return* ast_return_new(lex_ctx ctx, ast_expression *expr)
488 ast_instantiate(ast_return, ctx, ast_return_delete);
489 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_return_codegen);
491 self->operand = expr;
494 ast_propagate_effects(self, expr);
499 void ast_return_delete(ast_return *self)
502 ast_unref(self->operand);
503 ast_expression_delete((ast_expression*)self);
507 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field)
509 if (field->expression.vtype != TYPE_FIELD) {
510 asterror(ctx, "ast_entfield_new with expression not of type field");
513 return ast_entfield_new_force(ctx, entity, field, field->expression.next);
516 ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype)
518 ast_instantiate(ast_entfield, ctx, ast_entfield_delete);
522 /* Error: field has no type... */
526 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_entfield_codegen);
528 self->entity = entity;
530 ast_propagate_effects(self, entity);
531 ast_propagate_effects(self, field);
533 if (!ast_type_adopt(self, outtype)) {
534 ast_entfield_delete(self);
541 void ast_entfield_delete(ast_entfield *self)
543 ast_unref(self->entity);
544 ast_unref(self->field);
545 ast_expression_delete((ast_expression*)self);
549 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field, const char *name)
551 ast_instantiate(ast_member, ctx, ast_member_delete);
557 if (owner->expression.vtype != TYPE_VECTOR &&
558 owner->expression.vtype != TYPE_FIELD) {
559 asterror(ctx, "member-access on an invalid owner of type %s", type_name[owner->expression.vtype]);
564 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_member_codegen);
565 self->expression.node.keep = true; /* keep */
567 if (owner->expression.vtype == TYPE_VECTOR) {
568 self->expression.vtype = TYPE_FLOAT;
569 self->expression.next = NULL;
571 self->expression.vtype = TYPE_FIELD;
572 self->expression.next = ast_shallow_type(ctx, TYPE_FLOAT);
576 ast_propagate_effects(self, owner);
580 self->name = util_strdup(name);
587 void ast_member_delete(ast_member *self)
589 /* The owner is always an ast_value, which has .keep=true,
590 * also: ast_members are usually deleted after the owner, thus
591 * this will cause invalid access
592 ast_unref(self->owner);
593 * once we allow (expression).x to access a vector-member, we need
594 * to change this: preferably by creating an alternate ast node for this
595 * purpose that is not garbage-collected.
597 ast_expression_delete((ast_expression*)self);
601 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index)
603 ast_expression *outtype;
604 ast_instantiate(ast_array_index, ctx, ast_array_index_delete);
606 outtype = array->expression.next;
609 /* Error: field has no type... */
613 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_array_index_codegen);
617 ast_propagate_effects(self, array);
618 ast_propagate_effects(self, index);
620 if (!ast_type_adopt(self, outtype)) {
621 ast_array_index_delete(self);
624 if (array->expression.vtype == TYPE_FIELD && outtype->expression.vtype == TYPE_ARRAY) {
625 if (self->expression.vtype != TYPE_ARRAY) {
626 asterror(ast_ctx(self), "array_index node on type");
627 ast_array_index_delete(self);
630 self->array = outtype;
631 self->expression.vtype = TYPE_FIELD;
637 void ast_array_index_delete(ast_array_index *self)
639 ast_unref(self->array);
640 ast_unref(self->index);
641 ast_expression_delete((ast_expression*)self);
645 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse)
647 ast_instantiate(ast_ifthen, ctx, ast_ifthen_delete);
648 if (!ontrue && !onfalse) {
649 /* because it is invalid */
653 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_ifthen_codegen);
656 self->on_true = ontrue;
657 self->on_false = onfalse;
658 ast_propagate_effects(self, cond);
660 ast_propagate_effects(self, ontrue);
662 ast_propagate_effects(self, onfalse);
667 void ast_ifthen_delete(ast_ifthen *self)
669 ast_unref(self->cond);
671 ast_unref(self->on_true);
673 ast_unref(self->on_false);
674 ast_expression_delete((ast_expression*)self);
678 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse)
680 ast_instantiate(ast_ternary, ctx, ast_ternary_delete);
681 /* This time NEITHER must be NULL */
682 if (!ontrue || !onfalse) {
686 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_ternary_codegen);
689 self->on_true = ontrue;
690 self->on_false = onfalse;
691 ast_propagate_effects(self, cond);
692 ast_propagate_effects(self, ontrue);
693 ast_propagate_effects(self, onfalse);
695 if (!ast_type_adopt(self, ontrue)) {
696 ast_ternary_delete(self);
703 void ast_ternary_delete(ast_ternary *self)
705 ast_unref(self->cond);
706 ast_unref(self->on_true);
707 ast_unref(self->on_false);
708 ast_expression_delete((ast_expression*)self);
712 ast_loop* ast_loop_new(lex_ctx ctx,
713 ast_expression *initexpr,
714 ast_expression *precond,
715 ast_expression *postcond,
716 ast_expression *increment,
717 ast_expression *body)
719 ast_instantiate(ast_loop, ctx, ast_loop_delete);
720 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_loop_codegen);
722 self->initexpr = initexpr;
723 self->precond = precond;
724 self->postcond = postcond;
725 self->increment = increment;
729 ast_propagate_effects(self, initexpr);
731 ast_propagate_effects(self, precond);
733 ast_propagate_effects(self, postcond);
735 ast_propagate_effects(self, increment);
737 ast_propagate_effects(self, body);
742 void ast_loop_delete(ast_loop *self)
745 ast_unref(self->initexpr);
747 ast_unref(self->precond);
749 ast_unref(self->postcond);
751 ast_unref(self->increment);
753 ast_unref(self->body);
754 ast_expression_delete((ast_expression*)self);
758 ast_breakcont* ast_breakcont_new(lex_ctx ctx, bool iscont)
760 ast_instantiate(ast_breakcont, ctx, ast_breakcont_delete);
761 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_breakcont_codegen);
763 self->is_continue = iscont;
768 void ast_breakcont_delete(ast_breakcont *self)
770 ast_expression_delete((ast_expression*)self);
774 ast_switch* ast_switch_new(lex_ctx ctx, ast_expression *op)
776 ast_instantiate(ast_switch, ctx, ast_switch_delete);
777 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_switch_codegen);
782 ast_propagate_effects(self, op);
787 void ast_switch_delete(ast_switch *self)
790 ast_unref(self->operand);
792 for (i = 0; i < vec_size(self->cases); ++i) {
793 if (self->cases[i].value)
794 ast_unref(self->cases[i].value);
795 ast_unref(self->cases[i].code);
797 vec_free(self->cases);
799 ast_expression_delete((ast_expression*)self);
803 ast_label* ast_label_new(lex_ctx ctx, const char *name)
805 ast_instantiate(ast_label, ctx, ast_label_delete);
806 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_label_codegen);
808 self->name = util_strdup(name);
809 self->irblock = NULL;
815 void ast_label_delete(ast_label *self)
817 mem_d((void*)self->name);
818 vec_free(self->gotos);
819 ast_expression_delete((ast_expression*)self);
823 void ast_label_register_goto(ast_label *self, ast_goto *g)
825 vec_push(self->gotos, g);
828 ast_goto* ast_goto_new(lex_ctx ctx, const char *name)
830 ast_instantiate(ast_goto, ctx, ast_goto_delete);
831 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_goto_codegen);
833 self->name = util_strdup(name);
835 self->irblock_from = NULL;
840 void ast_goto_delete(ast_goto *self)
842 mem_d((void*)self->name);
843 ast_expression_delete((ast_expression*)self);
847 ast_call* ast_call_new(lex_ctx ctx,
848 ast_expression *funcexpr)
850 ast_instantiate(ast_call, ctx, ast_call_delete);
851 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_call_codegen);
853 ast_side_effects(self) = true;
856 self->func = funcexpr;
858 self->expression.vtype = funcexpr->expression.next->expression.vtype;
859 if (funcexpr->expression.next->expression.next)
860 self->expression.next = ast_type_copy(ctx, funcexpr->expression.next->expression.next);
865 void ast_call_delete(ast_call *self)
868 for (i = 0; i < vec_size(self->params); ++i)
869 ast_unref(self->params[i]);
870 vec_free(self->params);
873 ast_unref(self->func);
875 ast_expression_delete((ast_expression*)self);
879 bool ast_call_check_types(ast_call *self)
883 const ast_expression *func = self->func;
884 size_t count = vec_size(self->params);
885 if (count > vec_size(func->expression.params))
886 count = vec_size(func->expression.params);
888 for (i = 0; i < count; ++i) {
889 if (!ast_compare_type(self->params[i], (ast_expression*)(func->expression.params[i]))) {
892 ast_type_to_string(self->params[i], tgot, sizeof(tgot));
893 ast_type_to_string((ast_expression*)func->expression.params[i], texp, sizeof(texp));
894 asterror(ast_ctx(self), "invalid type for parameter %u in function call: expected %s, got %s",
895 (unsigned int)(i+1), texp, tgot);
896 /* we don't immediately return */
903 ast_store* ast_store_new(lex_ctx ctx, int op,
904 ast_expression *dest, ast_expression *source)
906 ast_instantiate(ast_store, ctx, ast_store_delete);
907 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_store_codegen);
909 ast_side_effects(self) = true;
913 self->source = source;
915 self->expression.vtype = dest->expression.vtype;
916 if (dest->expression.next) {
917 self->expression.next = ast_type_copy(ctx, dest);
918 if (!self->expression.next) {
924 self->expression.next = NULL;
929 void ast_store_delete(ast_store *self)
931 ast_unref(self->dest);
932 ast_unref(self->source);
933 ast_expression_delete((ast_expression*)self);
937 ast_block* ast_block_new(lex_ctx ctx)
939 ast_instantiate(ast_block, ctx, ast_block_delete);
940 ast_expression_init((ast_expression*)self,
941 (ast_expression_codegen*)&ast_block_codegen);
945 self->collect = NULL;
950 void ast_block_add_expr(ast_block *self, ast_expression *e)
952 ast_propagate_effects(self, e);
953 vec_push(self->exprs, e);
956 void ast_block_collect(ast_block *self, ast_expression *expr)
958 vec_push(self->collect, expr);
959 expr->expression.node.keep = true;
962 void ast_block_delete(ast_block *self)
965 for (i = 0; i < vec_size(self->exprs); ++i)
966 ast_unref(self->exprs[i]);
967 vec_free(self->exprs);
968 for (i = 0; i < vec_size(self->locals); ++i)
969 ast_delete(self->locals[i]);
970 vec_free(self->locals);
971 for (i = 0; i < vec_size(self->collect); ++i)
972 ast_delete(self->collect[i]);
973 vec_free(self->collect);
974 ast_expression_delete((ast_expression*)self);
978 bool ast_block_set_type(ast_block *self, ast_expression *from)
980 if (self->expression.next)
981 ast_delete(self->expression.next);
982 self->expression.vtype = from->expression.vtype;
983 if (from->expression.next) {
984 self->expression.next = ast_type_copy(self->expression.node.context, from->expression.next);
985 if (!self->expression.next)
989 self->expression.next = NULL;
993 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype)
995 ast_instantiate(ast_function, ctx, ast_function_delete);
999 vtype->expression.vtype != TYPE_FUNCTION)
1001 asterror(ast_ctx(self), "internal error: ast_function_new condition %i %i type=%i",
1003 (int)vtype->hasvalue,
1004 vtype->expression.vtype);
1009 self->vtype = vtype;
1010 self->name = name ? util_strdup(name) : NULL;
1011 self->blocks = NULL;
1013 self->labelcount = 0;
1016 self->ir_func = NULL;
1017 self->curblock = NULL;
1019 self->breakblock = NULL;
1020 self->continueblock = NULL;
1022 vtype->hasvalue = true;
1023 vtype->constval.vfunc = self;
1028 void ast_function_delete(ast_function *self)
1032 mem_d((void*)self->name);
1034 /* ast_value_delete(self->vtype); */
1035 self->vtype->hasvalue = false;
1036 self->vtype->constval.vfunc = NULL;
1037 /* We use unref - if it was stored in a global table it is supposed
1038 * to be deleted from *there*
1040 ast_unref(self->vtype);
1042 for (i = 0; i < vec_size(self->blocks); ++i)
1043 ast_delete(self->blocks[i]);
1044 vec_free(self->blocks);
1048 const char* ast_function_label(ast_function *self, const char *prefix)
1054 if (!opts_dump && !opts_dumpfin)
1057 id = (self->labelcount++);
1058 len = strlen(prefix);
1060 from = self->labelbuf + sizeof(self->labelbuf)-1;
1063 unsigned int digit = id % 10;
1064 *from = digit + '0';
1067 memcpy(from - len, prefix, len);
1071 /*********************************************************************/
1073 * by convention you must never pass NULL to the 'ir_value **out'
1074 * parameter. If you really don't care about the output, pass a dummy.
1075 * But I can't imagine a pituation where the output is truly unnecessary.
1078 bool ast_value_codegen(ast_value *self, ast_function *func, bool lvalue, ir_value **out)
1082 /* NOTE: This is the codegen for a variable used in an expression.
1083 * It is not the codegen to generate the value. For this purpose,
1084 * ast_local_codegen and ast_global_codegen are to be used before this
1085 * is executed. ast_function_codegen should take care of its locals,
1086 * and the ast-user should take care of ast_global_codegen to be used
1087 * on all the globals.
1090 char typename[1024];
1091 ast_type_to_string((ast_expression*)self, typename, sizeof(typename));
1092 asterror(ast_ctx(self), "ast_value used before generated %s %s", typename, self->name);
1099 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield)
1103 if (self->hasvalue && self->expression.vtype == TYPE_FUNCTION)
1105 ir_function *func = ir_builder_create_function(ir, self->name, self->expression.next->expression.vtype);
1108 func->context = ast_ctx(self);
1109 func->value->context = ast_ctx(self);
1111 self->constval.vfunc->ir_func = func;
1112 self->ir_v = func->value;
1113 /* The function is filled later on ast_function_codegen... */
1117 if (isfield && self->expression.vtype == TYPE_FIELD) {
1118 ast_expression *fieldtype = self->expression.next;
1120 if (self->hasvalue) {
1121 asterror(ast_ctx(self), "TODO: constant field pointers with value");
1125 if (fieldtype->expression.vtype == TYPE_ARRAY) {
1130 ast_expression_common *elemtype;
1132 ast_value *array = (ast_value*)fieldtype;
1134 if (!ast_istype(fieldtype, ast_value)) {
1135 asterror(ast_ctx(self), "internal error: ast_value required");
1139 /* we are lame now - considering the way QC works we won't tolerate arrays > 1024 elements */
1140 if (!array->expression.count || array->expression.count > opts_max_array_size)
1141 asterror(ast_ctx(self), "Invalid array of size %lu", (unsigned long)array->expression.count);
1143 elemtype = &array->expression.next->expression;
1144 vtype = elemtype->vtype;
1146 v = ir_builder_create_field(ir, self->name, vtype);
1148 asterror(ast_ctx(self), "ir_builder_create_global failed");
1151 if (vtype == TYPE_FIELD)
1152 v->fieldtype = elemtype->next->expression.vtype;
1153 v->context = ast_ctx(self);
1154 array->ir_v = self->ir_v = v;
1156 namelen = strlen(self->name);
1157 name = (char*)mem_a(namelen + 16);
1158 strcpy(name, self->name);
1160 array->ir_values = (ir_value**)mem_a(sizeof(array->ir_values[0]) * array->expression.count);
1161 array->ir_values[0] = v;
1162 for (ai = 1; ai < array->expression.count; ++ai) {
1163 snprintf(name + namelen, 16, "[%u]", (unsigned int)ai);
1164 array->ir_values[ai] = ir_builder_create_field(ir, name, vtype);
1165 if (!array->ir_values[ai]) {
1167 asterror(ast_ctx(self), "ir_builder_create_global failed");
1170 if (vtype == TYPE_FIELD)
1171 array->ir_values[ai]->fieldtype = elemtype->next->expression.vtype;
1172 array->ir_values[ai]->context = ast_ctx(self);
1178 v = ir_builder_create_field(ir, self->name, self->expression.next->expression.vtype);
1181 v->context = ast_ctx(self);
1187 if (self->expression.vtype == TYPE_ARRAY) {
1192 ast_expression_common *elemtype = &self->expression.next->expression;
1193 int vtype = elemtype->vtype;
1195 /* same as with field arrays */
1196 if (!self->expression.count || self->expression.count > opts_max_array_size)
1197 asterror(ast_ctx(self), "Invalid array of size %lu", (unsigned long)self->expression.count);
1199 v = ir_builder_create_global(ir, self->name, vtype);
1201 asterror(ast_ctx(self), "ir_builder_create_global failed");
1204 if (vtype == TYPE_FIELD)
1205 v->fieldtype = elemtype->next->expression.vtype;
1206 v->context = ast_ctx(self);
1208 namelen = strlen(self->name);
1209 name = (char*)mem_a(namelen + 16);
1210 strcpy(name, self->name);
1212 self->ir_values = (ir_value**)mem_a(sizeof(self->ir_values[0]) * self->expression.count);
1213 self->ir_values[0] = v;
1214 for (ai = 1; ai < self->expression.count; ++ai) {
1215 snprintf(name + namelen, 16, "[%u]", (unsigned int)ai);
1216 self->ir_values[ai] = ir_builder_create_global(ir, name, vtype);
1217 if (!self->ir_values[ai]) {
1219 asterror(ast_ctx(self), "ir_builder_create_global failed");
1222 if (vtype == TYPE_FIELD)
1223 self->ir_values[ai]->fieldtype = elemtype->next->expression.vtype;
1224 self->ir_values[ai]->context = ast_ctx(self);
1230 /* Arrays don't do this since there's no "array" value which spans across the
1233 v = ir_builder_create_global(ir, self->name, self->expression.vtype);
1235 asterror(ast_ctx(self), "ir_builder_create_global failed");
1238 if (self->expression.vtype == TYPE_FIELD)
1239 v->fieldtype = self->expression.next->expression.vtype;
1240 v->context = ast_ctx(self);
1243 if (self->hasvalue) {
1244 switch (self->expression.vtype)
1247 if (!ir_value_set_float(v, self->constval.vfloat))
1251 if (!ir_value_set_vector(v, self->constval.vvec))
1255 if (!ir_value_set_string(v, self->constval.vstring))
1259 asterror(ast_ctx(self), "TODO: global constant array");
1262 asterror(ast_ctx(self), "global of type function not properly generated");
1264 /* Cannot generate an IR value for a function,
1265 * need a pointer pointing to a function rather.
1268 asterror(ast_ctx(self), "TODO: global constant type %i", self->expression.vtype);
1273 /* link us to the ir_value */
1277 error: /* clean up */
1282 bool ast_local_codegen(ast_value *self, ir_function *func, bool param)
1285 if (self->hasvalue && self->expression.vtype == TYPE_FUNCTION)
1287 /* Do we allow local functions? I think not...
1288 * this is NOT a function pointer atm.
1293 if (self->expression.vtype == TYPE_ARRAY) {
1298 ast_expression_common *elemtype = &self->expression.next->expression;
1299 int vtype = elemtype->vtype;
1302 asterror(ast_ctx(self), "array-parameters are not supported");
1306 /* we are lame now - considering the way QC works we won't tolerate arrays > 1024 elements */
1307 if (!self->expression.count || self->expression.count > opts_max_array_size) {
1308 asterror(ast_ctx(self), "Invalid array of size %lu", (unsigned long)self->expression.count);
1311 self->ir_values = (ir_value**)mem_a(sizeof(self->ir_values[0]) * self->expression.count);
1312 if (!self->ir_values) {
1313 asterror(ast_ctx(self), "failed to allocate array values");
1317 v = ir_function_create_local(func, self->name, vtype, param);
1319 asterror(ast_ctx(self), "ir_function_create_local failed");
1322 if (vtype == TYPE_FIELD)
1323 v->fieldtype = elemtype->next->expression.vtype;
1324 v->context = ast_ctx(self);
1326 namelen = strlen(self->name);
1327 name = (char*)mem_a(namelen + 16);
1328 strcpy(name, self->name);
1330 self->ir_values[0] = v;
1331 for (ai = 1; ai < self->expression.count; ++ai) {
1332 snprintf(name + namelen, 16, "[%u]", (unsigned int)ai);
1333 self->ir_values[ai] = ir_function_create_local(func, name, vtype, param);
1334 if (!self->ir_values[ai]) {
1335 asterror(ast_ctx(self), "ir_builder_create_global failed");
1338 if (vtype == TYPE_FIELD)
1339 self->ir_values[ai]->fieldtype = elemtype->next->expression.vtype;
1340 self->ir_values[ai]->context = ast_ctx(self);
1345 v = ir_function_create_local(func, self->name, self->expression.vtype, param);
1348 if (self->expression.vtype == TYPE_FIELD)
1349 v->fieldtype = self->expression.next->expression.vtype;
1350 v->context = ast_ctx(self);
1353 /* A constant local... hmmm...
1354 * I suppose the IR will have to deal with this
1356 if (self->hasvalue) {
1357 switch (self->expression.vtype)
1360 if (!ir_value_set_float(v, self->constval.vfloat))
1364 if (!ir_value_set_vector(v, self->constval.vvec))
1368 if (!ir_value_set_string(v, self->constval.vstring))
1372 asterror(ast_ctx(self), "TODO: global constant type %i", self->expression.vtype);
1377 /* link us to the ir_value */
1381 if (!ast_global_codegen(self->setter, func->owner, false) ||
1382 !ast_function_codegen(self->setter->constval.vfunc, func->owner) ||
1383 !ir_function_finalize(self->setter->constval.vfunc->ir_func))
1387 if (!ast_global_codegen(self->getter, func->owner, false) ||
1388 !ast_function_codegen(self->getter->constval.vfunc, func->owner) ||
1389 !ir_function_finalize(self->getter->constval.vfunc->ir_func))
1394 error: /* clean up */
1399 bool ast_function_codegen(ast_function *self, ir_builder *ir)
1403 ast_expression_common *ec;
1408 irf = self->ir_func;
1410 asterror(ast_ctx(self), "ast_function's related ast_value was not generated yet");
1414 /* fill the parameter list */
1415 ec = &self->vtype->expression;
1416 for (i = 0; i < vec_size(ec->params); ++i)
1418 vec_push(irf->params, ec->params[i]->expression.vtype);
1419 if (!self->builtin) {
1420 if (!ast_local_codegen(ec->params[i], self->ir_func, true))
1425 if (self->builtin) {
1426 irf->builtin = self->builtin;
1430 if (!vec_size(self->blocks)) {
1431 asterror(ast_ctx(self), "function `%s` has no body", self->name);
1435 self->curblock = ir_function_create_block(irf, "entry");
1436 if (!self->curblock) {
1437 asterror(ast_ctx(self), "failed to allocate entry block for `%s`", self->name);
1441 for (i = 0; i < vec_size(self->blocks); ++i) {
1442 ast_expression_codegen *gen = self->blocks[i]->expression.codegen;
1443 if (!(*gen)((ast_expression*)self->blocks[i], self, false, &dummy))
1447 /* TODO: check return types */
1448 if (!self->curblock->is_return)
1450 return ir_block_create_return(self->curblock, NULL);
1451 /* From now on the parser has to handle this situation */
1453 if (!self->vtype->expression.next ||
1454 self->vtype->expression.next->expression.vtype == TYPE_VOID)
1456 return ir_block_create_return(self->curblock, NULL);
1460 /* error("missing return"); */
1461 asterror(ast_ctx(self), "function `%s` missing return value", self->name);
1469 /* Note, you will not see ast_block_codegen generate ir_blocks.
1470 * To the AST and the IR, blocks are 2 different things.
1471 * In the AST it represents a block of code, usually enclosed in
1472 * curly braces {...}.
1473 * While in the IR it represents a block in terms of control-flow.
1475 bool ast_block_codegen(ast_block *self, ast_function *func, bool lvalue, ir_value **out)
1479 /* We don't use this
1480 * Note: an ast-representation using the comma-operator
1481 * of the form: (a, b, c) = x should not assign to c...
1484 asterror(ast_ctx(self), "not an l-value (code-block)");
1488 if (self->expression.outr) {
1489 *out = self->expression.outr;
1493 /* output is NULL at first, we'll have each expression
1494 * assign to out output, thus, a comma-operator represention
1495 * using an ast_block will return the last generated value,
1496 * so: (b, c) + a executed both b and c, and returns c,
1497 * which is then added to a.
1501 /* generate locals */
1502 for (i = 0; i < vec_size(self->locals); ++i)
1504 if (!ast_local_codegen(self->locals[i], func->ir_func, false)) {
1506 asterror(ast_ctx(self), "failed to generate local `%s`", self->locals[i]->name);
1511 for (i = 0; i < vec_size(self->exprs); ++i)
1513 ast_expression_codegen *gen = self->exprs[i]->expression.codegen;
1514 if (func->curblock->final) {
1515 asterror(ast_ctx(self->exprs[i]), "unreachable statement");
1518 if (!(*gen)(self->exprs[i], func, false, out))
1522 self->expression.outr = *out;
1527 bool ast_store_codegen(ast_store *self, ast_function *func, bool lvalue, ir_value **out)
1529 ast_expression_codegen *cgen;
1530 ir_value *left = NULL;
1531 ir_value *right = NULL;
1535 ast_array_index *ai = NULL;
1537 if (lvalue && self->expression.outl) {
1538 *out = self->expression.outl;
1542 if (!lvalue && self->expression.outr) {
1543 *out = self->expression.outr;
1547 if (ast_istype(self->dest, ast_array_index))
1550 ai = (ast_array_index*)self->dest;
1551 idx = (ast_value*)ai->index;
1553 if (ast_istype(ai->index, ast_value) && idx->hasvalue)
1558 /* we need to call the setter */
1559 ir_value *iridx, *funval;
1563 asterror(ast_ctx(self), "array-subscript assignment cannot produce lvalues");
1567 arr = (ast_value*)ai->array;
1568 if (!ast_istype(ai->array, ast_value) || !arr->setter) {
1569 asterror(ast_ctx(self), "value has no setter (%s)", arr->name);
1573 cgen = idx->expression.codegen;
1574 if (!(*cgen)((ast_expression*)(idx), func, false, &iridx))
1577 cgen = arr->setter->expression.codegen;
1578 if (!(*cgen)((ast_expression*)(arr->setter), func, true, &funval))
1581 cgen = self->source->expression.codegen;
1582 if (!(*cgen)((ast_expression*)(self->source), func, false, &right))
1585 call = ir_block_create_call(func->curblock, ast_function_label(func, "store"), funval);
1588 ir_call_param(call, iridx);
1589 ir_call_param(call, right);
1590 self->expression.outr = right;
1596 cgen = self->dest->expression.codegen;
1598 if (!(*cgen)((ast_expression*)(self->dest), func, true, &left))
1600 self->expression.outl = left;
1602 cgen = self->source->expression.codegen;
1604 if (!(*cgen)((ast_expression*)(self->source), func, false, &right))
1607 if (!ir_block_create_store_op(func->curblock, self->op, left, right))
1609 self->expression.outr = right;
1612 /* Theoretically, an assinment returns its left side as an
1613 * lvalue, if we don't need an lvalue though, we return
1614 * the right side as an rvalue, otherwise we have to
1615 * somehow know whether or not we need to dereference the pointer
1616 * on the left side - that is: OP_LOAD if it was an address.
1617 * Also: in original QC we cannot OP_LOADP *anyway*.
1619 *out = (lvalue ? left : right);
1624 bool ast_binary_codegen(ast_binary *self, ast_function *func, bool lvalue, ir_value **out)
1626 ast_expression_codegen *cgen;
1627 ir_value *left, *right;
1629 /* A binary operation cannot yield an l-value */
1631 asterror(ast_ctx(self), "not an l-value (binop)");
1635 if (self->expression.outr) {
1636 *out = self->expression.outr;
1640 if (OPTS_FLAG(SHORT_LOGIC) &&
1641 (self->op == INSTR_AND || self->op == INSTR_OR))
1643 /* short circuit evaluation */
1644 ir_block *other, *merge;
1645 ir_block *from_left, *from_right;
1650 /* Note about casting to true boolean values:
1651 * We use a single NOT for sub expressions, and an
1652 * overall NOT at the end, and for that purpose swap
1653 * all the jump conditions in order for the NOT to get
1655 * ie: (a && b) usually becomes (!!a ? !!b : !!a)
1656 * but we translate this to (!(!a ? !a : !b))
1659 merge_id = vec_size(func->ir_func->blocks);
1660 merge = ir_function_create_block(func->ir_func, ast_function_label(func, "sce_merge"));
1662 cgen = self->left->expression.codegen;
1663 if (!(*cgen)((ast_expression*)(self->left), func, false, &left))
1665 if (!OPTS_FLAG(PERL_LOGIC)) {
1666 notop = type_not_instr[left->vtype];
1667 if (notop == AINSTR_END) {
1668 asterror(ast_ctx(self), "don't know how to cast to bool...");
1671 left = ir_block_create_unary(func->curblock,
1672 ast_function_label(func, "sce_not"),
1676 from_left = func->curblock;
1678 other = ir_function_create_block(func->ir_func, ast_function_label(func, "sce_other"));
1679 if ( !(self->op == INSTR_OR) != !OPTS_FLAG(PERL_LOGIC) ) {
1680 if (!ir_block_create_if(func->curblock, left, other, merge))
1683 if (!ir_block_create_if(func->curblock, left, merge, other))
1686 /* use the likely flag */
1687 vec_last(func->curblock->instr)->likely = true;
1689 func->curblock = other;
1690 cgen = self->right->expression.codegen;
1691 if (!(*cgen)((ast_expression*)(self->right), func, false, &right))
1693 if (!OPTS_FLAG(PERL_LOGIC)) {
1694 notop = type_not_instr[right->vtype];
1695 if (notop == AINSTR_END) {
1696 asterror(ast_ctx(self), "don't know how to cast to bool...");
1699 right = ir_block_create_unary(func->curblock,
1700 ast_function_label(func, "sce_not"),
1704 from_right = func->curblock;
1706 if (!ir_block_create_jump(func->curblock, merge))
1709 vec_remove(func->ir_func->blocks, merge_id, 1);
1710 vec_push(func->ir_func->blocks, merge);
1712 func->curblock = merge;
1713 phi = ir_block_create_phi(func->curblock, ast_function_label(func, "sce_value"), TYPE_FLOAT);
1714 ir_phi_add(phi, from_left, left);
1715 ir_phi_add(phi, from_right, right);
1716 *out = ir_phi_value(phi);
1717 if (!OPTS_FLAG(PERL_LOGIC)) {
1718 notop = type_not_instr[(*out)->vtype];
1719 if (notop == AINSTR_END) {
1720 asterror(ast_ctx(self), "don't know how to cast to bool...");
1723 *out = ir_block_create_unary(func->curblock,
1724 ast_function_label(func, "sce_final_not"),
1730 self->expression.outr = *out;
1734 cgen = self->left->expression.codegen;
1735 if (!(*cgen)((ast_expression*)(self->left), func, false, &left))
1738 cgen = self->right->expression.codegen;
1739 if (!(*cgen)((ast_expression*)(self->right), func, false, &right))
1742 *out = ir_block_create_binop(func->curblock, ast_function_label(func, "bin"),
1743 self->op, left, right);
1746 self->expression.outr = *out;
1751 bool ast_binstore_codegen(ast_binstore *self, ast_function *func, bool lvalue, ir_value **out)
1753 ast_expression_codegen *cgen;
1754 ir_value *leftl = NULL, *leftr, *right, *bin;
1758 ast_array_index *ai = NULL;
1759 ir_value *iridx = NULL;
1761 if (lvalue && self->expression.outl) {
1762 *out = self->expression.outl;
1766 if (!lvalue && self->expression.outr) {
1767 *out = self->expression.outr;
1771 if (ast_istype(self->dest, ast_array_index))
1774 ai = (ast_array_index*)self->dest;
1775 idx = (ast_value*)ai->index;
1777 if (ast_istype(ai->index, ast_value) && idx->hasvalue)
1781 /* for a binstore we need both an lvalue and an rvalue for the left side */
1782 /* rvalue of destination! */
1784 cgen = idx->expression.codegen;
1785 if (!(*cgen)((ast_expression*)(idx), func, false, &iridx))
1788 cgen = self->dest->expression.codegen;
1789 if (!(*cgen)((ast_expression*)(self->dest), func, false, &leftr))
1792 /* source as rvalue only */
1793 cgen = self->source->expression.codegen;
1794 if (!(*cgen)((ast_expression*)(self->source), func, false, &right))
1797 /* now the binary */
1798 bin = ir_block_create_binop(func->curblock, ast_function_label(func, "binst"),
1799 self->opbin, leftr, right);
1800 self->expression.outr = bin;
1804 /* we need to call the setter */
1809 asterror(ast_ctx(self), "array-subscript assignment cannot produce lvalues");
1813 arr = (ast_value*)ai->array;
1814 if (!ast_istype(ai->array, ast_value) || !arr->setter) {
1815 asterror(ast_ctx(self), "value has no setter (%s)", arr->name);
1819 cgen = arr->setter->expression.codegen;
1820 if (!(*cgen)((ast_expression*)(arr->setter), func, true, &funval))
1823 call = ir_block_create_call(func->curblock, ast_function_label(func, "store"), funval);
1826 ir_call_param(call, iridx);
1827 ir_call_param(call, bin);
1828 self->expression.outr = bin;
1830 /* now store them */
1831 cgen = self->dest->expression.codegen;
1832 /* lvalue of destination */
1833 if (!(*cgen)((ast_expression*)(self->dest), func, true, &leftl))
1835 self->expression.outl = leftl;
1837 if (!ir_block_create_store_op(func->curblock, self->opstore, leftl, bin))
1839 self->expression.outr = bin;
1842 /* Theoretically, an assinment returns its left side as an
1843 * lvalue, if we don't need an lvalue though, we return
1844 * the right side as an rvalue, otherwise we have to
1845 * somehow know whether or not we need to dereference the pointer
1846 * on the left side - that is: OP_LOAD if it was an address.
1847 * Also: in original QC we cannot OP_LOADP *anyway*.
1849 *out = (lvalue ? leftl : bin);
1854 bool ast_unary_codegen(ast_unary *self, ast_function *func, bool lvalue, ir_value **out)
1856 ast_expression_codegen *cgen;
1859 /* An unary operation cannot yield an l-value */
1861 asterror(ast_ctx(self), "not an l-value (binop)");
1865 if (self->expression.outr) {
1866 *out = self->expression.outr;
1870 cgen = self->operand->expression.codegen;
1872 if (!(*cgen)((ast_expression*)(self->operand), func, false, &operand))
1875 *out = ir_block_create_unary(func->curblock, ast_function_label(func, "unary"),
1879 self->expression.outr = *out;
1884 bool ast_return_codegen(ast_return *self, ast_function *func, bool lvalue, ir_value **out)
1886 ast_expression_codegen *cgen;
1891 /* In the context of a return operation, we don't actually return
1895 asterror(ast_ctx(self), "return-expression is not an l-value");
1899 if (self->expression.outr) {
1900 asterror(ast_ctx(self), "internal error: ast_return cannot be reused, it bears no result!");
1903 self->expression.outr = (ir_value*)1;
1905 if (self->operand) {
1906 cgen = self->operand->expression.codegen;
1908 if (!(*cgen)((ast_expression*)(self->operand), func, false, &operand))
1911 if (!ir_block_create_return(func->curblock, operand))
1914 if (!ir_block_create_return(func->curblock, NULL))
1921 bool ast_entfield_codegen(ast_entfield *self, ast_function *func, bool lvalue, ir_value **out)
1923 ast_expression_codegen *cgen;
1924 ir_value *ent, *field;
1926 /* This function needs to take the 'lvalue' flag into account!
1927 * As lvalue we provide a field-pointer, as rvalue we provide the
1931 if (lvalue && self->expression.outl) {
1932 *out = self->expression.outl;
1936 if (!lvalue && self->expression.outr) {
1937 *out = self->expression.outr;
1941 cgen = self->entity->expression.codegen;
1942 if (!(*cgen)((ast_expression*)(self->entity), func, false, &ent))
1945 cgen = self->field->expression.codegen;
1946 if (!(*cgen)((ast_expression*)(self->field), func, false, &field))
1951 *out = ir_block_create_fieldaddress(func->curblock, ast_function_label(func, "efa"),
1954 *out = ir_block_create_load_from_ent(func->curblock, ast_function_label(func, "efv"),
1955 ent, field, self->expression.vtype);
1958 asterror(ast_ctx(self), "failed to create %s instruction (output type %s)",
1959 (lvalue ? "ADDRESS" : "FIELD"),
1960 type_name[self->expression.vtype]);
1965 self->expression.outl = *out;
1967 self->expression.outr = *out;
1969 /* Hm that should be it... */
1973 bool ast_member_codegen(ast_member *self, ast_function *func, bool lvalue, ir_value **out)
1975 ast_expression_codegen *cgen;
1978 /* in QC this is always an lvalue */
1980 if (self->expression.outl) {
1981 *out = self->expression.outl;
1985 cgen = self->owner->expression.codegen;
1986 if (!(*cgen)((ast_expression*)(self->owner), func, true, &vec))
1989 if (vec->vtype != TYPE_VECTOR &&
1990 !(vec->vtype == TYPE_FIELD && self->owner->expression.next->expression.vtype == TYPE_VECTOR))
1995 *out = ir_value_vector_member(vec, self->field);
1996 self->expression.outl = *out;
1998 return (*out != NULL);
2001 bool ast_array_index_codegen(ast_array_index *self, ast_function *func, bool lvalue, ir_value **out)
2006 if (!lvalue && self->expression.outr) {
2007 *out = self->expression.outr;
2009 if (lvalue && self->expression.outl) {
2010 *out = self->expression.outl;
2013 if (!ast_istype(self->array, ast_value)) {
2014 asterror(ast_ctx(self), "array indexing this way is not supported");
2015 /* note this would actually be pointer indexing because the left side is
2016 * not an actual array but (hopefully) an indexable expression.
2017 * Once we get integer arithmetic, and GADDRESS/GSTORE/GLOAD instruction
2018 * support this path will be filled.
2023 arr = (ast_value*)self->array;
2024 idx = (ast_value*)self->index;
2026 if (!ast_istype(self->index, ast_value) || !idx->hasvalue) {
2027 /* Time to use accessor functions */
2028 ast_expression_codegen *cgen;
2029 ir_value *iridx, *funval;
2033 asterror(ast_ctx(self), "(.2) array indexing here needs a compile-time constant");
2038 asterror(ast_ctx(self), "value has no getter, don't know how to index it");
2042 cgen = self->index->expression.codegen;
2043 if (!(*cgen)((ast_expression*)(self->index), func, true, &iridx))
2046 cgen = arr->getter->expression.codegen;
2047 if (!(*cgen)((ast_expression*)(arr->getter), func, true, &funval))
2050 call = ir_block_create_call(func->curblock, ast_function_label(func, "fetch"), funval);
2053 ir_call_param(call, iridx);
2055 *out = ir_call_value(call);
2056 self->expression.outr = *out;
2060 if (idx->expression.vtype == TYPE_FLOAT)
2061 *out = arr->ir_values[(int)idx->constval.vfloat];
2062 else if (idx->expression.vtype == TYPE_INTEGER)
2063 *out = arr->ir_values[idx->constval.vint];
2065 asterror(ast_ctx(self), "array indexing here needs an integer constant");
2071 bool ast_ifthen_codegen(ast_ifthen *self, ast_function *func, bool lvalue, ir_value **out)
2073 ast_expression_codegen *cgen;
2078 ir_block *cond = func->curblock;
2081 ir_block *ontrue_endblock = NULL;
2082 ir_block *onfalse_endblock = NULL;
2085 /* We don't output any value, thus also don't care about r/lvalue */
2089 if (self->expression.outr) {
2090 asterror(ast_ctx(self), "internal error: ast_ifthen cannot be reused, it bears no result!");
2093 self->expression.outr = (ir_value*)1;
2095 /* generate the condition */
2096 cgen = self->cond->expression.codegen;
2097 if (!(*cgen)((ast_expression*)(self->cond), func, false, &condval))
2099 /* update the block which will get the jump - because short-logic or ternaries may have changed this */
2100 cond = func->curblock;
2104 if (self->on_true) {
2105 /* create on-true block */
2106 ontrue = ir_function_create_block(func->ir_func, ast_function_label(func, "ontrue"));
2110 /* enter the block */
2111 func->curblock = ontrue;
2114 cgen = self->on_true->expression.codegen;
2115 if (!(*cgen)((ast_expression*)(self->on_true), func, false, &dummy))
2118 /* we now need to work from the current endpoint */
2119 ontrue_endblock = func->curblock;
2124 if (self->on_false) {
2125 /* create on-false block */
2126 onfalse = ir_function_create_block(func->ir_func, ast_function_label(func, "onfalse"));
2130 /* enter the block */
2131 func->curblock = onfalse;
2134 cgen = self->on_false->expression.codegen;
2135 if (!(*cgen)((ast_expression*)(self->on_false), func, false, &dummy))
2138 /* we now need to work from the current endpoint */
2139 onfalse_endblock = func->curblock;
2143 /* Merge block were they all merge in to */
2144 merge = ir_function_create_block(func->ir_func, ast_function_label(func, "endif"));
2147 /* add jumps ot the merge block */
2148 if (ontrue && !ontrue_endblock->final && !ir_block_create_jump(ontrue_endblock, merge))
2150 if (onfalse && !onfalse_endblock->final && !ir_block_create_jump(onfalse_endblock, merge))
2153 /* we create the if here, that way all blocks are ordered :)
2155 if (!ir_block_create_if(cond, condval,
2156 (ontrue ? ontrue : merge),
2157 (onfalse ? onfalse : merge)))
2162 /* Now enter the merge block */
2163 func->curblock = merge;
2168 bool ast_ternary_codegen(ast_ternary *self, ast_function *func, bool lvalue, ir_value **out)
2170 ast_expression_codegen *cgen;
2173 ir_value *trueval, *falseval;
2176 ir_block *cond = func->curblock;
2181 /* Ternary can never create an lvalue... */
2185 /* In theory it shouldn't be possible to pass through a node twice, but
2186 * in case we add any kind of optimization pass for the AST itself, it
2187 * may still happen, thus we remember a created ir_value and simply return one
2188 * if it already exists.
2190 if (self->expression.outr) {
2191 *out = self->expression.outr;
2195 /* In the following, contraty to ast_ifthen, we assume both paths exist. */
2197 /* generate the condition */
2198 func->curblock = cond;
2199 cgen = self->cond->expression.codegen;
2200 if (!(*cgen)((ast_expression*)(self->cond), func, false, &condval))
2203 /* create on-true block */
2204 ontrue = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_T"));
2209 /* enter the block */
2210 func->curblock = ontrue;
2213 cgen = self->on_true->expression.codegen;
2214 if (!(*cgen)((ast_expression*)(self->on_true), func, false, &trueval))
2218 /* create on-false block */
2219 onfalse = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_F"));
2224 /* enter the block */
2225 func->curblock = onfalse;
2228 cgen = self->on_false->expression.codegen;
2229 if (!(*cgen)((ast_expression*)(self->on_false), func, false, &falseval))
2233 /* create merge block */
2234 merge = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_out"));
2237 /* jump to merge block */
2238 if (!ir_block_create_jump(ontrue, merge))
2240 if (!ir_block_create_jump(onfalse, merge))
2243 /* create if instruction */
2244 if (!ir_block_create_if(cond, condval, ontrue, onfalse))
2247 /* Now enter the merge block */
2248 func->curblock = merge;
2250 /* Here, now, we need a PHI node
2251 * but first some sanity checking...
2253 if (trueval->vtype != falseval->vtype) {
2254 /* error("ternary with different types on the two sides"); */
2259 phi = ir_block_create_phi(merge, ast_function_label(func, "phi"), trueval->vtype);
2262 ir_phi_add(phi, ontrue, trueval);
2263 ir_phi_add(phi, onfalse, falseval);
2265 self->expression.outr = ir_phi_value(phi);
2266 *out = self->expression.outr;
2271 bool ast_loop_codegen(ast_loop *self, ast_function *func, bool lvalue, ir_value **out)
2273 ast_expression_codegen *cgen;
2275 ir_value *dummy = NULL;
2276 ir_value *precond = NULL;
2277 ir_value *postcond = NULL;
2279 /* Since we insert some jumps "late" so we have blocks
2280 * ordered "nicely", we need to keep track of the actual end-blocks
2281 * of expressions to add the jumps to.
2283 ir_block *bbody = NULL, *end_bbody = NULL;
2284 ir_block *bprecond = NULL, *end_bprecond = NULL;
2285 ir_block *bpostcond = NULL, *end_bpostcond = NULL;
2286 ir_block *bincrement = NULL, *end_bincrement = NULL;
2287 ir_block *bout = NULL, *bin = NULL;
2289 /* let's at least move the outgoing block to the end */
2292 /* 'break' and 'continue' need to be able to find the right blocks */
2293 ir_block *bcontinue = NULL;
2294 ir_block *bbreak = NULL;
2296 ir_block *old_bcontinue = NULL;
2297 ir_block *old_bbreak = NULL;
2299 ir_block *tmpblock = NULL;
2304 if (self->expression.outr) {
2305 asterror(ast_ctx(self), "internal error: ast_loop cannot be reused, it bears no result!");
2308 self->expression.outr = (ir_value*)1;
2311 * Should we ever need some kind of block ordering, better make this function
2312 * move blocks around than write a block ordering algorithm later... after all
2313 * the ast and ir should work together, not against each other.
2316 /* initexpr doesn't get its own block, it's pointless, it could create more blocks
2317 * anyway if for example it contains a ternary.
2321 cgen = self->initexpr->expression.codegen;
2322 if (!(*cgen)((ast_expression*)(self->initexpr), func, false, &dummy))
2326 /* Store the block from which we enter this chaos */
2327 bin = func->curblock;
2329 /* The pre-loop condition needs its own block since we
2330 * need to be able to jump to the start of that expression.
2334 bprecond = ir_function_create_block(func->ir_func, ast_function_label(func, "pre_loop_cond"));
2338 /* the pre-loop-condition the least important place to 'continue' at */
2339 bcontinue = bprecond;
2342 func->curblock = bprecond;
2345 cgen = self->precond->expression.codegen;
2346 if (!(*cgen)((ast_expression*)(self->precond), func, false, &precond))
2349 end_bprecond = func->curblock;
2351 bprecond = end_bprecond = NULL;
2354 /* Now the next blocks won't be ordered nicely, but we need to
2355 * generate them this early for 'break' and 'continue'.
2357 if (self->increment) {
2358 bincrement = ir_function_create_block(func->ir_func, ast_function_label(func, "loop_increment"));
2361 bcontinue = bincrement; /* increment comes before the pre-loop-condition */
2363 bincrement = end_bincrement = NULL;
2366 if (self->postcond) {
2367 bpostcond = ir_function_create_block(func->ir_func, ast_function_label(func, "post_loop_cond"));
2370 bcontinue = bpostcond; /* postcond comes before the increment */
2372 bpostcond = end_bpostcond = NULL;
2375 bout_id = vec_size(func->ir_func->blocks);
2376 bout = ir_function_create_block(func->ir_func, ast_function_label(func, "after_loop"));
2381 /* The loop body... */
2384 bbody = ir_function_create_block(func->ir_func, ast_function_label(func, "loop_body"));
2389 func->curblock = bbody;
2391 old_bbreak = func->breakblock;
2392 old_bcontinue = func->continueblock;
2393 func->breakblock = bbreak;
2394 func->continueblock = bcontinue;
2397 cgen = self->body->expression.codegen;
2398 if (!(*cgen)((ast_expression*)(self->body), func, false, &dummy))
2401 end_bbody = func->curblock;
2402 func->breakblock = old_bbreak;
2403 func->continueblock = old_bcontinue;
2406 /* post-loop-condition */
2410 func->curblock = bpostcond;
2413 cgen = self->postcond->expression.codegen;
2414 if (!(*cgen)((ast_expression*)(self->postcond), func, false, &postcond))
2417 end_bpostcond = func->curblock;
2420 /* The incrementor */
2421 if (self->increment)
2424 func->curblock = bincrement;
2427 cgen = self->increment->expression.codegen;
2428 if (!(*cgen)((ast_expression*)(self->increment), func, false, &dummy))
2431 end_bincrement = func->curblock;
2434 /* In any case now, we continue from the outgoing block */
2435 func->curblock = bout;
2437 /* Now all blocks are in place */
2438 /* From 'bin' we jump to whatever comes first */
2439 if (bprecond) tmpblock = bprecond;
2440 else if (bbody) tmpblock = bbody;
2441 else if (bpostcond) tmpblock = bpostcond;
2442 else tmpblock = bout;
2443 if (!ir_block_create_jump(bin, tmpblock))
2449 ir_block *ontrue, *onfalse;
2450 if (bbody) ontrue = bbody;
2451 else if (bincrement) ontrue = bincrement;
2452 else if (bpostcond) ontrue = bpostcond;
2453 else ontrue = bprecond;
2455 if (!ir_block_create_if(end_bprecond, precond, ontrue, onfalse))
2462 if (bincrement) tmpblock = bincrement;
2463 else if (bpostcond) tmpblock = bpostcond;
2464 else if (bprecond) tmpblock = bprecond;
2465 else tmpblock = bout;
2466 if (!end_bbody->final && !ir_block_create_jump(end_bbody, tmpblock))
2470 /* from increment */
2473 if (bpostcond) tmpblock = bpostcond;
2474 else if (bprecond) tmpblock = bprecond;
2475 else if (bbody) tmpblock = bbody;
2476 else tmpblock = bout;
2477 if (!ir_block_create_jump(end_bincrement, tmpblock))
2484 ir_block *ontrue, *onfalse;
2485 if (bprecond) ontrue = bprecond;
2486 else if (bbody) ontrue = bbody;
2487 else if (bincrement) ontrue = bincrement;
2488 else ontrue = bpostcond;
2490 if (!ir_block_create_if(end_bpostcond, postcond, ontrue, onfalse))
2494 /* Move 'bout' to the end */
2495 vec_remove(func->ir_func->blocks, bout_id, 1);
2496 vec_push(func->ir_func->blocks, bout);
2501 bool ast_breakcont_codegen(ast_breakcont *self, ast_function *func, bool lvalue, ir_value **out)
2508 asterror(ast_ctx(self), "break/continue expression is not an l-value");
2512 if (self->expression.outr) {
2513 asterror(ast_ctx(self), "internal error: ast_breakcont cannot be reused!");
2516 self->expression.outr = (ir_value*)1;
2518 if (self->is_continue)
2519 target = func->continueblock;
2521 target = func->breakblock;
2523 if (!ir_block_create_jump(func->curblock, target))
2528 bool ast_switch_codegen(ast_switch *self, ast_function *func, bool lvalue, ir_value **out)
2530 ast_expression_codegen *cgen;
2532 ast_switch_case *def_case = NULL;
2533 ir_block *def_bfall = NULL;
2535 ir_value *dummy = NULL;
2536 ir_value *irop = NULL;
2537 ir_block *old_break = NULL;
2538 ir_block *bout = NULL;
2539 ir_block *bfall = NULL;
2547 asterror(ast_ctx(self), "switch expression is not an l-value");
2551 if (self->expression.outr) {
2552 asterror(ast_ctx(self), "internal error: ast_switch cannot be reused!");
2555 self->expression.outr = (ir_value*)1;
2560 cgen = self->operand->expression.codegen;
2561 if (!(*cgen)((ast_expression*)(self->operand), func, false, &irop))
2564 if (!vec_size(self->cases))
2567 cmpinstr = type_eq_instr[irop->vtype];
2568 if (cmpinstr >= AINSTR_END) {
2569 ast_type_to_string(self->operand, typestr, sizeof(typestr));
2570 asterror(ast_ctx(self), "invalid type to perform a switch on: %s", typestr);
2574 bout_id = vec_size(func->ir_func->blocks);
2575 bout = ir_function_create_block(func->ir_func, ast_function_label(func, "after_switch"));
2579 /* setup the break block */
2580 old_break = func->breakblock;
2581 func->breakblock = bout;
2583 /* Now create all cases */
2584 for (c = 0; c < vec_size(self->cases); ++c) {
2585 ir_value *cond, *val;
2586 ir_block *bcase, *bnot;
2589 ast_switch_case *swcase = &self->cases[c];
2591 if (swcase->value) {
2592 /* A regular case */
2593 /* generate the condition operand */
2594 cgen = swcase->value->expression.codegen;
2595 if (!(*cgen)((ast_expression*)(swcase->value), func, false, &val))
2597 /* generate the condition */
2598 cond = ir_block_create_binop(func->curblock, ast_function_label(func, "switch_eq"), cmpinstr, irop, val);
2602 bcase = ir_function_create_block(func->ir_func, ast_function_label(func, "case"));
2603 bnot_id = vec_size(func->ir_func->blocks);
2604 bnot = ir_function_create_block(func->ir_func, ast_function_label(func, "not_case"));
2605 if (!bcase || !bnot)
2607 if (!ir_block_create_if(func->curblock, cond, bcase, bnot))
2610 /* Make the previous case-end fall through */
2611 if (bfall && !bfall->final) {
2612 if (!ir_block_create_jump(bfall, bcase))
2616 /* enter the case */
2617 func->curblock = bcase;
2618 cgen = swcase->code->expression.codegen;
2619 if (!(*cgen)((ast_expression*)swcase->code, func, false, &dummy))
2622 /* remember this block to fall through from */
2623 bfall = func->curblock;
2625 /* enter the else and move it down */
2626 func->curblock = bnot;
2627 vec_remove(func->ir_func->blocks, bnot_id, 1);
2628 vec_push(func->ir_func->blocks, bnot);
2630 /* The default case */
2631 /* Remember where to fall through from: */
2634 /* remember which case it was */
2639 /* Jump from the last bnot to bout */
2640 if (bfall && !bfall->final && !ir_block_create_jump(bfall, bout)) {
2642 astwarning(ast_ctx(bfall), WARN_???, "missing break after last case");
2647 /* If there was a default case, put it down here */
2651 /* No need to create an extra block */
2652 bcase = func->curblock;
2654 /* Insert the fallthrough jump */
2655 if (def_bfall && !def_bfall->final) {
2656 if (!ir_block_create_jump(def_bfall, bcase))
2660 /* Now generate the default code */
2661 cgen = def_case->code->expression.codegen;
2662 if (!(*cgen)((ast_expression*)def_case->code, func, false, &dummy))
2666 /* Jump from the last bnot to bout */
2667 if (!func->curblock->final && !ir_block_create_jump(func->curblock, bout))
2669 /* enter the outgoing block */
2670 func->curblock = bout;
2672 /* restore the break block */
2673 func->breakblock = old_break;
2675 /* Move 'bout' to the end, it's nicer */
2676 vec_remove(func->ir_func->blocks, bout_id, 1);
2677 vec_push(func->ir_func->blocks, bout);
2682 bool ast_label_codegen(ast_label *self, ast_function *func, bool lvalue, ir_value **out)
2689 asterror(ast_ctx(self), "internal error: ast_label cannot be an lvalue");
2693 /* simply create a new block and jump to it */
2694 self->irblock = ir_function_create_block(func->ir_func, self->name);
2695 if (!self->irblock) {
2696 asterror(ast_ctx(self), "failed to allocate label block `%s`", self->name);
2699 if (!func->curblock->final) {
2700 if (!ir_block_create_jump(func->curblock, self->irblock))
2704 /* enter the new block */
2705 func->curblock = self->irblock;
2707 /* Generate all the leftover gotos */
2708 for (i = 0; i < vec_size(self->gotos); ++i) {
2709 if (!ast_goto_codegen(self->gotos[i], func, false, &dummy))
2716 bool ast_goto_codegen(ast_goto *self, ast_function *func, bool lvalue, ir_value **out)
2720 asterror(ast_ctx(self), "internal error: ast_goto cannot be an lvalue");
2724 if (self->target->irblock) {
2725 if (self->irblock_from) {
2726 /* we already tried once, this is the callback */
2727 self->irblock_from->final = false;
2728 if (!ir_block_create_jump(self->irblock_from, self->target->irblock)) {
2729 asterror(ast_ctx(self), "failed to generate goto to `%s`", self->name);
2735 if (!ir_block_create_jump(func->curblock, self->target->irblock)) {
2736 asterror(ast_ctx(self), "failed to generate goto to `%s`", self->name);
2743 /* the target has not yet been created...
2744 * close this block in a sneaky way:
2746 func->curblock->final = true;
2747 self->irblock_from = func->curblock;
2748 ast_label_register_goto(self->target, self);
2754 bool ast_call_codegen(ast_call *self, ast_function *func, bool lvalue, ir_value **out)
2756 ast_expression_codegen *cgen;
2758 ir_instr *callinstr;
2761 ir_value *funval = NULL;
2763 /* return values are never lvalues */
2765 asterror(ast_ctx(self), "not an l-value (function call)");
2769 if (self->expression.outr) {
2770 *out = self->expression.outr;
2774 cgen = self->func->expression.codegen;
2775 if (!(*cgen)((ast_expression*)(self->func), func, false, &funval))
2783 for (i = 0; i < vec_size(self->params); ++i)
2786 ast_expression *expr = self->params[i];
2788 cgen = expr->expression.codegen;
2789 if (!(*cgen)(expr, func, false, ¶m))
2793 vec_push(params, param);
2796 callinstr = ir_block_create_call(func->curblock, ast_function_label(func, "call"), funval);
2800 for (i = 0; i < vec_size(params); ++i) {
2801 ir_call_param(callinstr, params[i]);
2804 *out = ir_call_value(callinstr);
2805 self->expression.outr = *out;