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
39 static void asterror(lex_ctx ctx, const char *msg, ...)
43 cvprintmsg(ctx, LVL_ERROR, "error", msg, ap);
47 /* It must not be possible to get here. */
48 static GMQCC_NORETURN void _ast_node_destroy(ast_node *self)
50 fprintf(stderr, "ast node missing destroy()\n");
54 /* Initialize main ast node aprts */
55 static void ast_node_init(ast_node *self, lex_ctx ctx, int nodetype)
57 self->node.context = ctx;
58 self->node.destroy = &_ast_node_destroy;
59 self->node.keep = false;
60 self->node.nodetype = nodetype;
63 /* General expression initialization */
64 static void ast_expression_init(ast_expression *self,
65 ast_expression_codegen *codegen)
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);
76 static void ast_expression_delete(ast_expression *self)
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]);
84 MEM_VECTOR_CLEAR(&self->expression, params);
87 static void ast_expression_delete_full(ast_expression *self)
89 ast_expression_delete(self);
93 MEM_VEC_FUNCTIONS(ast_expression_common, ast_value*, params)
95 ast_value* ast_value_copy(const ast_value *self)
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);
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);
121 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other)
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)
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))
143 static ast_expression* ast_shallow_type(lex_ctx ctx, int vtype)
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;
153 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex)
156 const ast_expression_common *fromex;
157 ast_expression_common *selfex;
163 ast_instantiate(ast_expression, ctx, ast_expression_delete_full);
164 ast_expression_init(self, NULL);
166 fromex = &ex->expression;
167 selfex = &self->expression;
169 /* This may never be codegen()d */
170 selfex->codegen = NULL;
172 selfex->vtype = fromex->vtype;
175 selfex->next = ast_type_copy(ctx, fromex->next);
177 ast_expression_delete_full(self);
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);
197 bool ast_compare_type(ast_expression *a, ast_expression *b)
199 if (a->expression.vtype != b->expression.vtype)
201 if (!a->expression.next != !b->expression.next)
203 if (a->expression.params_count != b->expression.params_count)
205 if (a->expression.variadic != b->expression.variadic)
207 if (a->expression.params_count) {
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]))
215 if (a->expression.next)
216 return ast_compare_type(a->expression.next, b->expression.next);
220 static size_t ast_type_to_string_impl(ast_expression *e, char *buf, size_t bufsize, size_t pos)
227 if (pos + 6 >= bufsize)
229 strcpy(buf + pos, "(null)");
233 if (pos + 1 >= bufsize)
236 switch (e->expression.vtype) {
238 strcpy(buf + pos, "(variant)");
243 return ast_type_to_string_impl(e->expression.next, buf, bufsize, pos);
246 if (pos + 3 >= bufsize)
250 pos = ast_type_to_string_impl(e->expression.next, buf, bufsize, pos);
251 if (pos + 1 >= bufsize)
257 pos = ast_type_to_string_impl(e->expression.next, buf, bufsize, pos);
258 if (pos + 2 >= bufsize)
260 if (e->expression.params_count == 0) {
266 pos = ast_type_to_string_impl((ast_expression*)(e->expression.params[0]), buf, bufsize, pos);
267 for (i = 1; i < e->expression.params_count; ++i) {
268 if (pos + 2 >= bufsize)
272 pos = ast_type_to_string_impl((ast_expression*)(e->expression.params[i]), buf, bufsize, pos);
274 if (pos + 1 >= bufsize)
280 pos = ast_type_to_string_impl(e->expression.next, buf, bufsize, pos);
281 if (pos + 1 >= bufsize)
284 pos += snprintf(buf + pos, bufsize - pos - 1, "%i", (int)e->expression.count);
285 if (pos + 1 >= bufsize)
291 typestr = type_name[e->expression.vtype];
292 typelen = strlen(typestr);
293 if (pos + typelen >= bufsize)
295 strcpy(buf + pos, typestr);
296 return pos + typelen;
300 buf[bufsize-3] = '.';
301 buf[bufsize-2] = '.';
302 buf[bufsize-1] = '.';
306 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize)
308 size_t pos = ast_type_to_string_impl(e, buf, bufsize-1, 0);
312 ast_value* ast_value_new(lex_ctx ctx, const char *name, int t)
314 ast_instantiate(ast_value, ctx, ast_value_delete);
315 ast_expression_init((ast_expression*)self,
316 (ast_expression_codegen*)&ast_value_codegen);
317 self->expression.node.keep = true; /* keep */
319 self->name = name ? util_strdup(name) : NULL;
320 self->expression.vtype = t;
321 self->expression.next = NULL;
322 self->isconst = false;
324 memset(&self->constval, 0, sizeof(self->constval));
327 self->ir_values = NULL;
328 self->ir_value_count = 0;
333 void ast_value_delete(ast_value* self)
336 mem_d((void*)self->name);
338 switch (self->expression.vtype)
341 mem_d((void*)self->constval.vstring);
344 /* unlink us from the function node */
345 self->constval.vfunc->vtype = NULL;
347 /* NOTE: delete function? currently collected in
348 * the parser structure
355 mem_d(self->ir_values);
356 ast_expression_delete((ast_expression*)self);
360 bool GMQCC_WARN ast_value_params_add(ast_value *self, ast_value *p)
362 return ast_expression_common_params_add(&self->expression, p);
365 bool ast_value_set_name(ast_value *self, const char *name)
368 mem_d((void*)self->name);
369 self->name = util_strdup(name);
373 ast_binary* ast_binary_new(lex_ctx ctx, int op,
374 ast_expression* left, ast_expression* right)
376 ast_instantiate(ast_binary, ctx, ast_binary_delete);
377 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_binary_codegen);
383 if (op >= INSTR_EQ_F && op <= INSTR_GT)
384 self->expression.vtype = TYPE_FLOAT;
385 else if (op == INSTR_AND || op == INSTR_OR ||
386 op == INSTR_BITAND || op == INSTR_BITOR)
387 self->expression.vtype = TYPE_FLOAT;
388 else if (op == INSTR_MUL_VF || op == INSTR_MUL_FV)
389 self->expression.vtype = TYPE_VECTOR;
390 else if (op == INSTR_MUL_V)
391 self->expression.vtype = TYPE_FLOAT;
393 self->expression.vtype = left->expression.vtype;
398 void ast_binary_delete(ast_binary *self)
400 ast_unref(self->left);
401 ast_unref(self->right);
402 ast_expression_delete((ast_expression*)self);
406 ast_binstore* ast_binstore_new(lex_ctx ctx, int storop, int op,
407 ast_expression* left, ast_expression* right)
409 ast_instantiate(ast_binstore, ctx, ast_binstore_delete);
410 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_binstore_codegen);
412 self->opstore = storop;
415 self->source = right;
417 self->expression.vtype = left->expression.vtype;
418 if (left->expression.next) {
419 self->expression.next = ast_type_copy(ctx, left);
420 if (!self->expression.next) {
426 self->expression.next = NULL;
431 void ast_binstore_delete(ast_binstore *self)
433 ast_unref(self->dest);
434 ast_unref(self->source);
435 ast_expression_delete((ast_expression*)self);
439 ast_unary* ast_unary_new(lex_ctx ctx, int op,
440 ast_expression *expr)
442 ast_instantiate(ast_unary, ctx, ast_unary_delete);
443 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_unary_codegen);
446 self->operand = expr;
448 if (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) {
449 self->expression.vtype = TYPE_FLOAT;
451 asterror(ctx, "cannot determine type of unary operation %s", asm_instr[op].m);
456 void ast_unary_delete(ast_unary *self)
458 ast_unref(self->operand);
459 ast_expression_delete((ast_expression*)self);
463 ast_return* ast_return_new(lex_ctx ctx, ast_expression *expr)
465 ast_instantiate(ast_return, ctx, ast_return_delete);
466 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_return_codegen);
468 self->operand = expr;
473 void ast_return_delete(ast_return *self)
476 ast_unref(self->operand);
477 ast_expression_delete((ast_expression*)self);
481 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field)
483 const ast_expression *outtype;
485 ast_instantiate(ast_entfield, ctx, ast_entfield_delete);
487 if (field->expression.vtype != TYPE_FIELD) {
492 outtype = field->expression.next;
495 /* Error: field has no type... */
499 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_entfield_codegen);
501 self->entity = entity;
504 if (!ast_type_adopt(self, outtype)) {
505 ast_entfield_delete(self);
512 void ast_entfield_delete(ast_entfield *self)
514 ast_unref(self->entity);
515 ast_unref(self->field);
516 ast_expression_delete((ast_expression*)self);
520 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field)
522 ast_instantiate(ast_member, ctx, ast_member_delete);
528 if (owner->expression.vtype != TYPE_VECTOR &&
529 owner->expression.vtype != TYPE_FIELD) {
530 asterror(ctx, "member-access on an invalid owner of type %s", type_name[owner->expression.vtype]);
535 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_member_codegen);
536 self->expression.node.keep = true; /* keep */
538 if (owner->expression.vtype == TYPE_VECTOR) {
539 self->expression.vtype = TYPE_FLOAT;
540 self->expression.next = NULL;
542 self->expression.vtype = TYPE_FIELD;
543 self->expression.next = ast_shallow_type(ctx, TYPE_FLOAT);
552 void ast_member_delete(ast_member *self)
554 /* The owner is always an ast_value, which has .keep=true,
555 * also: ast_members are usually deleted after the owner, thus
556 * this will cause invalid access
557 ast_unref(self->owner);
558 * once we allow (expression).x to access a vector-member, we need
559 * to change this: preferably by creating an alternate ast node for this
560 * purpose that is not garbage-collected.
562 ast_expression_delete((ast_expression*)self);
566 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse)
568 ast_instantiate(ast_ifthen, ctx, ast_ifthen_delete);
569 if (!ontrue && !onfalse) {
570 /* because it is invalid */
574 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_ifthen_codegen);
577 self->on_true = ontrue;
578 self->on_false = onfalse;
583 void ast_ifthen_delete(ast_ifthen *self)
585 ast_unref(self->cond);
587 ast_unref(self->on_true);
589 ast_unref(self->on_false);
590 ast_expression_delete((ast_expression*)self);
594 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse)
596 ast_instantiate(ast_ternary, ctx, ast_ternary_delete);
597 /* This time NEITHER must be NULL */
598 if (!ontrue || !onfalse) {
602 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_ternary_codegen);
605 self->on_true = ontrue;
606 self->on_false = onfalse;
607 self->phi_out = NULL;
612 void ast_ternary_delete(ast_ternary *self)
614 ast_unref(self->cond);
615 ast_unref(self->on_true);
616 ast_unref(self->on_false);
617 ast_expression_delete((ast_expression*)self);
621 ast_loop* ast_loop_new(lex_ctx ctx,
622 ast_expression *initexpr,
623 ast_expression *precond,
624 ast_expression *postcond,
625 ast_expression *increment,
626 ast_expression *body)
628 ast_instantiate(ast_loop, ctx, ast_loop_delete);
629 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_loop_codegen);
631 self->initexpr = initexpr;
632 self->precond = precond;
633 self->postcond = postcond;
634 self->increment = increment;
640 void ast_loop_delete(ast_loop *self)
643 ast_unref(self->initexpr);
645 ast_unref(self->precond);
647 ast_unref(self->postcond);
649 ast_unref(self->increment);
651 ast_unref(self->body);
652 ast_expression_delete((ast_expression*)self);
656 ast_call* ast_call_new(lex_ctx ctx,
657 ast_expression *funcexpr)
659 ast_instantiate(ast_call, ctx, ast_call_delete);
660 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_call_codegen);
662 MEM_VECTOR_INIT(self, params);
664 self->func = funcexpr;
666 self->expression.vtype = funcexpr->expression.next->expression.vtype;
667 if (funcexpr->expression.next->expression.next)
668 self->expression.next = ast_type_copy(ctx, funcexpr->expression.next->expression.next);
672 MEM_VEC_FUNCTIONS(ast_call, ast_expression*, params)
674 void ast_call_delete(ast_call *self)
677 for (i = 0; i < self->params_count; ++i)
678 ast_unref(self->params[i]);
679 MEM_VECTOR_CLEAR(self, params);
682 ast_unref(self->func);
684 ast_expression_delete((ast_expression*)self);
688 bool ast_call_check_types(ast_call *self)
692 const ast_expression *func = self->func;
693 size_t count = self->params_count;
694 if (count > func->expression.params_count)
695 count = func->expression.params_count;
697 for (i = 0; i < count; ++i) {
698 if (!ast_compare_type(self->params[i], (ast_expression*)(func->expression.params[i]))) {
699 asterror(ast_ctx(self), "invalid type for parameter %u in function call",
700 (unsigned int)(i+1));
701 /* we don't immediately return */
708 ast_store* ast_store_new(lex_ctx ctx, int op,
709 ast_expression *dest, ast_expression *source)
711 ast_instantiate(ast_store, ctx, ast_store_delete);
712 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_store_codegen);
716 self->source = source;
718 self->expression.vtype = dest->expression.vtype;
719 if (dest->expression.next) {
720 self->expression.next = ast_type_copy(ctx, dest);
721 if (!self->expression.next) {
727 self->expression.next = NULL;
732 void ast_store_delete(ast_store *self)
734 ast_unref(self->dest);
735 ast_unref(self->source);
736 ast_expression_delete((ast_expression*)self);
740 ast_block* ast_block_new(lex_ctx ctx)
742 ast_instantiate(ast_block, ctx, ast_block_delete);
743 ast_expression_init((ast_expression*)self,
744 (ast_expression_codegen*)&ast_block_codegen);
746 MEM_VECTOR_INIT(self, locals);
747 MEM_VECTOR_INIT(self, exprs);
748 MEM_VECTOR_INIT(self, collect);
752 MEM_VEC_FUNCTIONS(ast_block, ast_value*, locals)
753 MEM_VEC_FUNCTIONS(ast_block, ast_expression*, exprs)
754 MEM_VEC_FUNCTIONS(ast_block, ast_expression*, collect)
756 bool ast_block_collect(ast_block *self, ast_expression *expr)
758 if (!ast_block_collect_add(self, expr))
760 expr->expression.node.keep = true;
764 void ast_block_delete(ast_block *self)
767 for (i = 0; i < self->exprs_count; ++i)
768 ast_unref(self->exprs[i]);
769 MEM_VECTOR_CLEAR(self, exprs);
770 for (i = 0; i < self->locals_count; ++i)
771 ast_delete(self->locals[i]);
772 MEM_VECTOR_CLEAR(self, locals);
773 for (i = 0; i < self->collect_count; ++i)
774 ast_delete(self->collect[i]);
775 MEM_VECTOR_CLEAR(self, collect);
776 ast_expression_delete((ast_expression*)self);
780 bool ast_block_set_type(ast_block *self, ast_expression *from)
782 if (self->expression.next)
783 ast_delete(self->expression.next);
784 self->expression.vtype = from->expression.vtype;
785 if (from->expression.next) {
786 self->expression.next = ast_type_copy(self->expression.node.context, from->expression.next);
787 if (!self->expression.next)
791 self->expression.next = NULL;
795 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype)
797 ast_instantiate(ast_function, ctx, ast_function_delete);
801 vtype->expression.vtype != TYPE_FUNCTION)
808 self->name = name ? util_strdup(name) : NULL;
809 MEM_VECTOR_INIT(self, blocks);
811 self->labelcount = 0;
814 self->ir_func = NULL;
815 self->curblock = NULL;
817 self->breakblock = NULL;
818 self->continueblock = NULL;
820 vtype->isconst = true;
821 vtype->constval.vfunc = self;
826 MEM_VEC_FUNCTIONS(ast_function, ast_block*, blocks)
828 void ast_function_delete(ast_function *self)
832 mem_d((void*)self->name);
834 /* ast_value_delete(self->vtype); */
835 self->vtype->isconst = false;
836 self->vtype->constval.vfunc = NULL;
837 /* We use unref - if it was stored in a global table it is supposed
838 * to be deleted from *there*
840 ast_unref(self->vtype);
842 for (i = 0; i < self->blocks_count; ++i)
843 ast_delete(self->blocks[i]);
844 MEM_VECTOR_CLEAR(self, blocks);
848 const char* ast_function_label(ast_function *self, const char *prefix)
857 id = (self->labelcount++);
858 len = strlen(prefix);
860 from = self->labelbuf + sizeof(self->labelbuf)-1;
863 unsigned int digit = id % 10;
867 memcpy(from - len, prefix, len);
871 /*********************************************************************/
873 * by convention you must never pass NULL to the 'ir_value **out'
874 * parameter. If you really don't care about the output, pass a dummy.
875 * But I can't imagine a pituation where the output is truly unnecessary.
878 bool ast_value_codegen(ast_value *self, ast_function *func, bool lvalue, ir_value **out)
880 /* NOTE: This is the codegen for a variable used in an expression.
881 * It is not the codegen to generate the value. For this purpose,
882 * ast_local_codegen and ast_global_codegen are to be used before this
883 * is executed. ast_function_codegen should take care of its locals,
884 * and the ast-user should take care of ast_global_codegen to be used
885 * on all the globals.
888 asterror(ast_ctx(self), "ast_value used before generated (%s)", self->name);
895 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield)
898 if (self->isconst && self->expression.vtype == TYPE_FUNCTION)
900 ir_function *func = ir_builder_create_function(ir, self->name, self->expression.next->expression.vtype);
903 func->context = ast_ctx(self);
904 func->value->context = ast_ctx(self);
906 self->constval.vfunc->ir_func = func;
907 self->ir_v = func->value;
908 /* The function is filled later on ast_function_codegen... */
912 if (isfield && self->expression.vtype == TYPE_FIELD) {
913 v = ir_builder_create_field(ir, self->name, self->expression.next->expression.vtype);
916 v->context = ast_ctx(self);
918 asterror(ast_ctx(self), "TODO: constant field pointers with value");
925 if (self->expression.vtype == TYPE_ARRAY) {
930 ast_expression_common *elemtype = &self->expression.next->expression;
931 int vtype = elemtype->vtype;
932 printf("Generating `%s`\n", self->name);
933 /* we are lame now - considering the way QC works we won't tolerate arrays > 1024 elements */
934 if (!self->expression.count || self->expression.count > opts_max_array_size) {
935 asterror(ast_ctx(self), "Invalid array of size %lu", (unsigned long)self->expression.count);
938 self->ir_values = (ir_value**)mem_a(sizeof(self->ir_values[0]) * self->expression.count);
939 if (!self->ir_values) {
940 asterror(ast_ctx(self), "failed to allocate array values");
944 v = ir_builder_create_global(ir, self->name, vtype);
946 asterror(ast_ctx(self), "ir_builder_create_global failed");
949 if (vtype == TYPE_FIELD)
950 v->fieldtype = elemtype->next->expression.vtype;
951 v->context = ast_ctx(self);
953 namelen = strlen(self->name);
954 name = (char*)mem_a(namelen + 16);
955 strcpy(name, self->name);
957 self->ir_values[0] = v;
958 for (ai = 1; ai < self->expression.count; ++ai) {
959 snprintf(name + namelen, 16, "[%u]", (unsigned int)ai);
960 self->ir_values[ai] = ir_builder_create_global(ir, name, vtype);
961 if (!self->ir_values[ai]) {
962 asterror(ast_ctx(self), "ir_builder_create_global failed");
965 if (vtype == TYPE_FIELD)
966 self->ir_values[ai]->fieldtype = elemtype->next->expression.vtype;
967 self->ir_values[ai]->context = ast_ctx(self);
972 /* Arrays don't do this since there's no "array" value which spans across the
975 v = ir_builder_create_global(ir, self->name, self->expression.vtype);
977 asterror(ast_ctx(self), "ir_builder_create_global failed");
980 if (self->expression.vtype == TYPE_FIELD)
981 v->fieldtype = self->expression.next->expression.vtype;
982 v->context = ast_ctx(self);
986 switch (self->expression.vtype)
989 if (!ir_value_set_float(v, self->constval.vfloat))
993 if (!ir_value_set_vector(v, self->constval.vvec))
997 if (!ir_value_set_string(v, self->constval.vstring))
1001 asterror(ast_ctx(self), "TODO: global constant array");
1004 asterror(ast_ctx(self), "global of type function not properly generated");
1006 /* Cannot generate an IR value for a function,
1007 * need a pointer pointing to a function rather.
1010 asterror(ast_ctx(self), "TODO: global constant type %i", self->expression.vtype);
1015 /* link us to the ir_value */
1019 error: /* clean up */
1024 bool ast_local_codegen(ast_value *self, ir_function *func, bool param)
1027 if (self->isconst && self->expression.vtype == TYPE_FUNCTION)
1029 /* Do we allow local functions? I think not...
1030 * this is NOT a function pointer atm.
1035 if (self->expression.vtype == TYPE_ARRAY)
1037 asterror(ast_ctx(self), "TODO: ast_local_codgen for TYPE_ARRAY");
1041 v = ir_function_create_local(func, self->name, self->expression.vtype, param);
1044 if (self->expression.vtype == TYPE_FIELD)
1045 v->fieldtype = self->expression.next->expression.vtype;
1046 v->context = ast_ctx(self);
1048 /* A constant local... hmmm...
1049 * I suppose the IR will have to deal with this
1051 if (self->isconst) {
1052 switch (self->expression.vtype)
1055 if (!ir_value_set_float(v, self->constval.vfloat))
1059 if (!ir_value_set_vector(v, self->constval.vvec))
1063 if (!ir_value_set_string(v, self->constval.vstring))
1067 asterror(ast_ctx(self), "TODO: global constant type %i", self->expression.vtype);
1072 /* link us to the ir_value */
1076 error: /* clean up */
1081 bool ast_function_codegen(ast_function *self, ir_builder *ir)
1085 ast_expression_common *ec;
1088 irf = self->ir_func;
1090 asterror(ast_ctx(self), "ast_function's related ast_value was not generated yet");
1094 /* fill the parameter list */
1095 ec = &self->vtype->expression;
1096 for (i = 0; i < ec->params_count; ++i)
1098 if (!ir_function_params_add(irf, ec->params[i]->expression.vtype))
1100 if (!self->builtin) {
1101 if (!ast_local_codegen(ec->params[i], self->ir_func, true))
1106 if (self->builtin) {
1107 irf->builtin = self->builtin;
1111 if (!self->blocks_count) {
1112 asterror(ast_ctx(self), "function `%s` has no body", self->name);
1116 self->curblock = ir_function_create_block(irf, "entry");
1117 if (!self->curblock) {
1118 asterror(ast_ctx(self), "failed to allocate entry block for `%s`", self->name);
1122 for (i = 0; i < self->blocks_count; ++i) {
1123 ast_expression_codegen *gen = self->blocks[i]->expression.codegen;
1124 if (!(*gen)((ast_expression*)self->blocks[i], self, false, &dummy))
1128 /* TODO: check return types */
1129 if (!self->curblock->is_return)
1131 return ir_block_create_return(self->curblock, NULL);
1132 /* From now on the parser has to handle this situation */
1134 if (!self->vtype->expression.next ||
1135 self->vtype->expression.next->expression.vtype == TYPE_VOID)
1137 return ir_block_create_return(self->curblock, NULL);
1141 /* error("missing return"); */
1142 asterror(ast_ctx(self), "function `%s` missing return value", self->name);
1150 /* Note, you will not see ast_block_codegen generate ir_blocks.
1151 * To the AST and the IR, blocks are 2 different things.
1152 * In the AST it represents a block of code, usually enclosed in
1153 * curly braces {...}.
1154 * While in the IR it represents a block in terms of control-flow.
1156 bool ast_block_codegen(ast_block *self, ast_function *func, bool lvalue, ir_value **out)
1160 /* We don't use this
1161 * Note: an ast-representation using the comma-operator
1162 * of the form: (a, b, c) = x should not assign to c...
1165 asterror(ast_ctx(self), "not an l-value (code-block)");
1169 if (self->expression.outr) {
1170 *out = self->expression.outr;
1174 /* output is NULL at first, we'll have each expression
1175 * assign to out output, thus, a comma-operator represention
1176 * using an ast_block will return the last generated value,
1177 * so: (b, c) + a executed both b and c, and returns c,
1178 * which is then added to a.
1182 /* generate locals */
1183 for (i = 0; i < self->locals_count; ++i)
1185 if (!ast_local_codegen(self->locals[i], func->ir_func, false)) {
1187 asterror(ast_ctx(self), "failed to generate local `%s`", self->locals[i]->name);
1192 for (i = 0; i < self->exprs_count; ++i)
1194 ast_expression_codegen *gen = self->exprs[i]->expression.codegen;
1195 if (!(*gen)(self->exprs[i], func, false, out))
1199 self->expression.outr = *out;
1204 bool ast_store_codegen(ast_store *self, ast_function *func, bool lvalue, ir_value **out)
1206 ast_expression_codegen *cgen;
1207 ir_value *left, *right;
1209 if (lvalue && self->expression.outl) {
1210 *out = self->expression.outl;
1214 if (!lvalue && self->expression.outr) {
1215 *out = self->expression.outr;
1219 cgen = self->dest->expression.codegen;
1221 if (!(*cgen)((ast_expression*)(self->dest), func, true, &left))
1223 self->expression.outl = left;
1225 cgen = self->source->expression.codegen;
1227 if (!(*cgen)((ast_expression*)(self->source), func, false, &right))
1230 if (!ir_block_create_store_op(func->curblock, self->op, left, right))
1232 self->expression.outr = right;
1234 /* Theoretically, an assinment returns its left side as an
1235 * lvalue, if we don't need an lvalue though, we return
1236 * the right side as an rvalue, otherwise we have to
1237 * somehow know whether or not we need to dereference the pointer
1238 * on the left side - that is: OP_LOAD if it was an address.
1239 * Also: in original QC we cannot OP_LOADP *anyway*.
1241 *out = (lvalue ? left : right);
1246 bool ast_binary_codegen(ast_binary *self, ast_function *func, bool lvalue, ir_value **out)
1248 ast_expression_codegen *cgen;
1249 ir_value *left, *right;
1251 /* A binary operation cannot yield an l-value */
1253 asterror(ast_ctx(self), "not an l-value (binop)");
1257 if (self->expression.outr) {
1258 *out = self->expression.outr;
1262 cgen = self->left->expression.codegen;
1264 if (!(*cgen)((ast_expression*)(self->left), func, false, &left))
1267 cgen = self->right->expression.codegen;
1269 if (!(*cgen)((ast_expression*)(self->right), func, false, &right))
1272 *out = ir_block_create_binop(func->curblock, ast_function_label(func, "bin"),
1273 self->op, left, right);
1276 self->expression.outr = *out;
1281 bool ast_binstore_codegen(ast_binstore *self, ast_function *func, bool lvalue, ir_value **out)
1283 ast_expression_codegen *cgen;
1284 ir_value *leftl, *leftr, *right, *bin;
1286 if (lvalue && self->expression.outl) {
1287 *out = self->expression.outl;
1291 if (!lvalue && self->expression.outr) {
1292 *out = self->expression.outr;
1296 /* for a binstore we need both an lvalue and an rvalue for the left side */
1297 /* rvalue of destination! */
1298 cgen = self->dest->expression.codegen;
1299 if (!(*cgen)((ast_expression*)(self->dest), func, false, &leftr))
1302 /* source as rvalue only */
1303 cgen = self->source->expression.codegen;
1304 if (!(*cgen)((ast_expression*)(self->source), func, false, &right))
1307 /* now the binary */
1308 bin = ir_block_create_binop(func->curblock, ast_function_label(func, "binst"),
1309 self->opbin, leftr, right);
1310 self->expression.outr = bin;
1312 /* now store them */
1313 cgen = self->dest->expression.codegen;
1314 /* lvalue of destination */
1315 if (!(*cgen)((ast_expression*)(self->dest), func, true, &leftl))
1317 self->expression.outl = leftl;
1319 if (!ir_block_create_store_op(func->curblock, self->opstore, leftl, bin))
1321 self->expression.outr = bin;
1323 /* Theoretically, an assinment returns its left side as an
1324 * lvalue, if we don't need an lvalue though, we return
1325 * the right side as an rvalue, otherwise we have to
1326 * somehow know whether or not we need to dereference the pointer
1327 * on the left side - that is: OP_LOAD if it was an address.
1328 * Also: in original QC we cannot OP_LOADP *anyway*.
1330 *out = (lvalue ? leftl : bin);
1335 bool ast_unary_codegen(ast_unary *self, ast_function *func, bool lvalue, ir_value **out)
1337 ast_expression_codegen *cgen;
1340 /* An unary operation cannot yield an l-value */
1342 asterror(ast_ctx(self), "not an l-value (binop)");
1346 if (self->expression.outr) {
1347 *out = self->expression.outr;
1351 cgen = self->operand->expression.codegen;
1353 if (!(*cgen)((ast_expression*)(self->operand), func, false, &operand))
1356 *out = ir_block_create_unary(func->curblock, ast_function_label(func, "unary"),
1360 self->expression.outr = *out;
1365 bool ast_return_codegen(ast_return *self, ast_function *func, bool lvalue, ir_value **out)
1367 ast_expression_codegen *cgen;
1370 /* In the context of a return operation, we don't actually return
1374 asterror(ast_ctx(self), "return-expression is not an l-value");
1378 if (self->expression.outr) {
1379 asterror(ast_ctx(self), "internal error: ast_return cannot be reused, it bears no result!");
1382 self->expression.outr = (ir_value*)1;
1384 if (self->operand) {
1385 cgen = self->operand->expression.codegen;
1387 if (!(*cgen)((ast_expression*)(self->operand), func, false, &operand))
1390 if (!ir_block_create_return(func->curblock, operand))
1393 if (!ir_block_create_return(func->curblock, NULL))
1400 bool ast_entfield_codegen(ast_entfield *self, ast_function *func, bool lvalue, ir_value **out)
1402 ast_expression_codegen *cgen;
1403 ir_value *ent, *field;
1405 /* This function needs to take the 'lvalue' flag into account!
1406 * As lvalue we provide a field-pointer, as rvalue we provide the
1410 if (lvalue && self->expression.outl) {
1411 *out = self->expression.outl;
1415 if (!lvalue && self->expression.outr) {
1416 *out = self->expression.outr;
1420 cgen = self->entity->expression.codegen;
1421 if (!(*cgen)((ast_expression*)(self->entity), func, false, &ent))
1424 cgen = self->field->expression.codegen;
1425 if (!(*cgen)((ast_expression*)(self->field), func, false, &field))
1430 *out = ir_block_create_fieldaddress(func->curblock, ast_function_label(func, "efa"),
1433 *out = ir_block_create_load_from_ent(func->curblock, ast_function_label(func, "efv"),
1434 ent, field, self->expression.vtype);
1437 asterror(ast_ctx(self), "failed to create %s instruction (output type %s)",
1438 (lvalue ? "ADDRESS" : "FIELD"),
1439 type_name[self->expression.vtype]);
1444 self->expression.outl = *out;
1446 self->expression.outr = *out;
1448 /* Hm that should be it... */
1452 bool ast_member_codegen(ast_member *self, ast_function *func, bool lvalue, ir_value **out)
1454 ast_expression_codegen *cgen;
1457 /* in QC this is always an lvalue */
1459 if (self->expression.outl) {
1460 *out = self->expression.outl;
1464 cgen = self->owner->expression.codegen;
1465 if (!(*cgen)((ast_expression*)(self->owner), func, true, &vec))
1468 if (vec->vtype != TYPE_VECTOR &&
1469 !(vec->vtype == TYPE_FIELD && self->owner->expression.next->expression.vtype == TYPE_VECTOR))
1474 *out = ir_value_vector_member(vec, self->field);
1475 self->expression.outl = *out;
1477 return (*out != NULL);
1480 bool ast_ifthen_codegen(ast_ifthen *self, ast_function *func, bool lvalue, ir_value **out)
1482 ast_expression_codegen *cgen;
1487 ir_block *cond = func->curblock;
1490 ir_block *ontrue_endblock = NULL;
1491 ir_block *onfalse_endblock = NULL;
1494 /* We don't output any value, thus also don't care about r/lvalue */
1498 if (self->expression.outr) {
1499 asterror(ast_ctx(self), "internal error: ast_ifthen cannot be reused, it bears no result!");
1502 self->expression.outr = (ir_value*)1;
1504 /* generate the condition */
1505 func->curblock = cond;
1506 cgen = self->cond->expression.codegen;
1507 if (!(*cgen)((ast_expression*)(self->cond), func, false, &condval))
1512 if (self->on_true) {
1513 /* create on-true block */
1514 ontrue = ir_function_create_block(func->ir_func, ast_function_label(func, "ontrue"));
1518 /* enter the block */
1519 func->curblock = ontrue;
1522 cgen = self->on_true->expression.codegen;
1523 if (!(*cgen)((ast_expression*)(self->on_true), func, false, &dummy))
1526 /* we now need to work from the current endpoint */
1527 ontrue_endblock = func->curblock;
1532 if (self->on_false) {
1533 /* create on-false block */
1534 onfalse = ir_function_create_block(func->ir_func, ast_function_label(func, "onfalse"));
1538 /* enter the block */
1539 func->curblock = onfalse;
1542 cgen = self->on_false->expression.codegen;
1543 if (!(*cgen)((ast_expression*)(self->on_false), func, false, &dummy))
1546 /* we now need to work from the current endpoint */
1547 onfalse_endblock = func->curblock;
1551 /* Merge block were they all merge in to */
1552 merge = ir_function_create_block(func->ir_func, ast_function_label(func, "endif"));
1556 /* add jumps ot the merge block */
1557 if (ontrue && !ontrue_endblock->final && !ir_block_create_jump(ontrue_endblock, merge))
1559 if (onfalse && !onfalse_endblock->final && !ir_block_create_jump(onfalse_endblock, merge))
1562 /* we create the if here, that way all blocks are ordered :)
1564 if (!ir_block_create_if(cond, condval,
1565 (ontrue ? ontrue : merge),
1566 (onfalse ? onfalse : merge)))
1571 /* Now enter the merge block */
1572 func->curblock = merge;
1577 bool ast_ternary_codegen(ast_ternary *self, ast_function *func, bool lvalue, ir_value **out)
1579 ast_expression_codegen *cgen;
1582 ir_value *trueval, *falseval;
1585 ir_block *cond = func->curblock;
1590 /* Ternary can never create an lvalue... */
1594 /* In theory it shouldn't be possible to pass through a node twice, but
1595 * in case we add any kind of optimization pass for the AST itself, it
1596 * may still happen, thus we remember a created ir_value and simply return one
1597 * if it already exists.
1599 if (self->phi_out) {
1600 *out = self->phi_out;
1604 /* In the following, contraty to ast_ifthen, we assume both paths exist. */
1606 /* generate the condition */
1607 func->curblock = cond;
1608 cgen = self->cond->expression.codegen;
1609 if (!(*cgen)((ast_expression*)(self->cond), func, false, &condval))
1612 /* create on-true block */
1613 ontrue = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_T"));
1618 /* enter the block */
1619 func->curblock = ontrue;
1622 cgen = self->on_true->expression.codegen;
1623 if (!(*cgen)((ast_expression*)(self->on_true), func, false, &trueval))
1627 /* create on-false block */
1628 onfalse = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_F"));
1633 /* enter the block */
1634 func->curblock = onfalse;
1637 cgen = self->on_false->expression.codegen;
1638 if (!(*cgen)((ast_expression*)(self->on_false), func, false, &falseval))
1642 /* create merge block */
1643 merge = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_out"));
1646 /* jump to merge block */
1647 if (!ir_block_create_jump(ontrue, merge))
1649 if (!ir_block_create_jump(onfalse, merge))
1652 /* create if instruction */
1653 if (!ir_block_create_if(cond, condval, ontrue, onfalse))
1656 /* Now enter the merge block */
1657 func->curblock = merge;
1659 /* Here, now, we need a PHI node
1660 * but first some sanity checking...
1662 if (trueval->vtype != falseval->vtype) {
1663 /* error("ternary with different types on the two sides"); */
1668 phi = ir_block_create_phi(merge, ast_function_label(func, "phi"), trueval->vtype);
1670 !ir_phi_add(phi, ontrue, trueval) ||
1671 !ir_phi_add(phi, onfalse, falseval))
1676 self->phi_out = ir_phi_value(phi);
1677 *out = self->phi_out;
1682 bool ast_loop_codegen(ast_loop *self, ast_function *func, bool lvalue, ir_value **out)
1684 ast_expression_codegen *cgen;
1686 ir_value *dummy = NULL;
1687 ir_value *precond = NULL;
1688 ir_value *postcond = NULL;
1690 /* Since we insert some jumps "late" so we have blocks
1691 * ordered "nicely", we need to keep track of the actual end-blocks
1692 * of expressions to add the jumps to.
1694 ir_block *bbody = NULL, *end_bbody = NULL;
1695 ir_block *bprecond = NULL, *end_bprecond = NULL;
1696 ir_block *bpostcond = NULL, *end_bpostcond = NULL;
1697 ir_block *bincrement = NULL, *end_bincrement = NULL;
1698 ir_block *bout = NULL, *bin = NULL;
1700 /* let's at least move the outgoing block to the end */
1703 /* 'break' and 'continue' need to be able to find the right blocks */
1704 ir_block *bcontinue = NULL;
1705 ir_block *bbreak = NULL;
1707 ir_block *old_bcontinue = NULL;
1708 ir_block *old_bbreak = NULL;
1710 ir_block *tmpblock = NULL;
1715 if (self->expression.outr) {
1716 asterror(ast_ctx(self), "internal error: ast_loop cannot be reused, it bears no result!");
1719 self->expression.outr = (ir_value*)1;
1722 * Should we ever need some kind of block ordering, better make this function
1723 * move blocks around than write a block ordering algorithm later... after all
1724 * the ast and ir should work together, not against each other.
1727 /* initexpr doesn't get its own block, it's pointless, it could create more blocks
1728 * anyway if for example it contains a ternary.
1732 cgen = self->initexpr->expression.codegen;
1733 if (!(*cgen)((ast_expression*)(self->initexpr), func, false, &dummy))
1737 /* Store the block from which we enter this chaos */
1738 bin = func->curblock;
1740 /* The pre-loop condition needs its own block since we
1741 * need to be able to jump to the start of that expression.
1745 bprecond = ir_function_create_block(func->ir_func, ast_function_label(func, "pre_loop_cond"));
1749 /* the pre-loop-condition the least important place to 'continue' at */
1750 bcontinue = bprecond;
1753 func->curblock = bprecond;
1756 cgen = self->precond->expression.codegen;
1757 if (!(*cgen)((ast_expression*)(self->precond), func, false, &precond))
1760 end_bprecond = func->curblock;
1762 bprecond = end_bprecond = NULL;
1765 /* Now the next blocks won't be ordered nicely, but we need to
1766 * generate them this early for 'break' and 'continue'.
1768 if (self->increment) {
1769 bincrement = ir_function_create_block(func->ir_func, ast_function_label(func, "loop_increment"));
1772 bcontinue = bincrement; /* increment comes before the pre-loop-condition */
1774 bincrement = end_bincrement = NULL;
1777 if (self->postcond) {
1778 bpostcond = ir_function_create_block(func->ir_func, ast_function_label(func, "post_loop_cond"));
1781 bcontinue = bpostcond; /* postcond comes before the increment */
1783 bpostcond = end_bpostcond = NULL;
1786 bout_id = func->ir_func->blocks_count;
1787 bout = ir_function_create_block(func->ir_func, ast_function_label(func, "after_loop"));
1792 /* The loop body... */
1795 bbody = ir_function_create_block(func->ir_func, ast_function_label(func, "loop_body"));
1800 func->curblock = bbody;
1802 old_bbreak = func->breakblock;
1803 old_bcontinue = func->continueblock;
1804 func->breakblock = bbreak;
1805 func->continueblock = bcontinue;
1808 cgen = self->body->expression.codegen;
1809 if (!(*cgen)((ast_expression*)(self->body), func, false, &dummy))
1812 end_bbody = func->curblock;
1813 func->breakblock = old_bbreak;
1814 func->continueblock = old_bcontinue;
1817 /* post-loop-condition */
1821 func->curblock = bpostcond;
1824 cgen = self->postcond->expression.codegen;
1825 if (!(*cgen)((ast_expression*)(self->postcond), func, false, &postcond))
1828 end_bpostcond = func->curblock;
1831 /* The incrementor */
1832 if (self->increment)
1835 func->curblock = bincrement;
1838 cgen = self->increment->expression.codegen;
1839 if (!(*cgen)((ast_expression*)(self->increment), func, false, &dummy))
1842 end_bincrement = func->curblock;
1845 /* In any case now, we continue from the outgoing block */
1846 func->curblock = bout;
1848 /* Now all blocks are in place */
1849 /* From 'bin' we jump to whatever comes first */
1850 if (bprecond) tmpblock = bprecond;
1851 else if (bbody) tmpblock = bbody;
1852 else if (bpostcond) tmpblock = bpostcond;
1853 else tmpblock = bout;
1854 if (!ir_block_create_jump(bin, tmpblock))
1860 ir_block *ontrue, *onfalse;
1861 if (bbody) ontrue = bbody;
1862 else if (bincrement) ontrue = bincrement;
1863 else if (bpostcond) ontrue = bpostcond;
1864 else ontrue = bprecond;
1866 if (!ir_block_create_if(end_bprecond, precond, ontrue, onfalse))
1873 if (bincrement) tmpblock = bincrement;
1874 else if (bpostcond) tmpblock = bpostcond;
1875 else if (bprecond) tmpblock = bprecond;
1876 else tmpblock = bout;
1877 if (!end_bbody->final && !ir_block_create_jump(end_bbody, tmpblock))
1881 /* from increment */
1884 if (bpostcond) tmpblock = bpostcond;
1885 else if (bprecond) tmpblock = bprecond;
1886 else if (bbody) tmpblock = bbody;
1887 else tmpblock = bout;
1888 if (!ir_block_create_jump(end_bincrement, tmpblock))
1895 ir_block *ontrue, *onfalse;
1896 if (bprecond) ontrue = bprecond;
1897 else if (bbody) ontrue = bbody;
1898 else if (bincrement) ontrue = bincrement;
1899 else ontrue = bpostcond;
1901 if (!ir_block_create_if(end_bpostcond, postcond, ontrue, onfalse))
1905 /* Move 'bout' to the end */
1906 if (!ir_function_blocks_remove(func->ir_func, bout_id) ||
1907 !ir_function_blocks_add(func->ir_func, bout))
1909 ir_block_delete(bout);
1916 bool ast_call_codegen(ast_call *self, ast_function *func, bool lvalue, ir_value **out)
1918 ast_expression_codegen *cgen;
1919 ir_value_vector params;
1920 ir_instr *callinstr;
1923 ir_value *funval = NULL;
1925 /* return values are never lvalues */
1927 asterror(ast_ctx(self), "not an l-value (function call)");
1931 if (self->expression.outr) {
1932 *out = self->expression.outr;
1936 cgen = self->func->expression.codegen;
1937 if (!(*cgen)((ast_expression*)(self->func), func, false, &funval))
1942 MEM_VECTOR_INIT(¶ms, v);
1945 for (i = 0; i < self->params_count; ++i)
1948 ast_expression *expr = self->params[i];
1950 cgen = expr->expression.codegen;
1951 if (!(*cgen)(expr, func, false, ¶m))
1955 if (!ir_value_vector_v_add(¶ms, param))
1959 callinstr = ir_block_create_call(func->curblock, ast_function_label(func, "call"), funval);
1963 for (i = 0; i < params.v_count; ++i) {
1964 if (!ir_call_param(callinstr, params.v[i]))
1968 *out = ir_call_value(callinstr);
1969 self->expression.outr = *out;
1971 MEM_VECTOR_CLEAR(¶ms, v);
1974 MEM_VECTOR_CLEAR(¶ms, v);