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 typestr = type_name[e->expression.vtype];
281 typelen = strlen(typestr);
282 if (pos + typelen >= bufsize)
284 strcpy(buf + pos, typestr);
285 return pos + typelen;
289 buf[bufsize-3] = '.';
290 buf[bufsize-2] = '.';
291 buf[bufsize-1] = '.';
295 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize)
297 size_t pos = ast_type_to_string_impl(e, buf, bufsize-1, 0);
301 ast_value* ast_value_new(lex_ctx ctx, const char *name, int t)
303 ast_instantiate(ast_value, ctx, ast_value_delete);
304 ast_expression_init((ast_expression*)self,
305 (ast_expression_codegen*)&ast_value_codegen);
306 self->expression.node.keep = true; /* keep */
308 self->name = name ? util_strdup(name) : NULL;
309 self->expression.vtype = t;
310 self->expression.next = NULL;
311 self->isconst = false;
313 memset(&self->constval, 0, sizeof(self->constval));
316 self->ir_values = NULL;
317 self->ir_value_count = 0;
322 void ast_value_delete(ast_value* self)
325 mem_d((void*)self->name);
327 switch (self->expression.vtype)
330 mem_d((void*)self->constval.vstring);
333 /* unlink us from the function node */
334 self->constval.vfunc->vtype = NULL;
336 /* NOTE: delete function? currently collected in
337 * the parser structure
343 ast_expression_delete((ast_expression*)self);
347 bool GMQCC_WARN ast_value_params_add(ast_value *self, ast_value *p)
349 return ast_expression_common_params_add(&self->expression, p);
352 bool ast_value_set_name(ast_value *self, const char *name)
355 mem_d((void*)self->name);
356 self->name = util_strdup(name);
360 ast_binary* ast_binary_new(lex_ctx ctx, int op,
361 ast_expression* left, ast_expression* right)
363 ast_instantiate(ast_binary, ctx, ast_binary_delete);
364 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_binary_codegen);
370 if (op >= INSTR_EQ_F && op <= INSTR_GT)
371 self->expression.vtype = TYPE_FLOAT;
372 else if (op == INSTR_AND || op == INSTR_OR ||
373 op == INSTR_BITAND || op == INSTR_BITOR)
374 self->expression.vtype = TYPE_FLOAT;
375 else if (op == INSTR_MUL_VF || op == INSTR_MUL_FV)
376 self->expression.vtype = TYPE_VECTOR;
377 else if (op == INSTR_MUL_V)
378 self->expression.vtype = TYPE_FLOAT;
380 self->expression.vtype = left->expression.vtype;
385 void ast_binary_delete(ast_binary *self)
387 ast_unref(self->left);
388 ast_unref(self->right);
389 ast_expression_delete((ast_expression*)self);
393 ast_binstore* ast_binstore_new(lex_ctx ctx, int storop, int op,
394 ast_expression* left, ast_expression* right)
396 ast_instantiate(ast_binstore, ctx, ast_binstore_delete);
397 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_binstore_codegen);
399 self->opstore = storop;
402 self->source = right;
404 self->expression.vtype = left->expression.vtype;
405 if (left->expression.next) {
406 self->expression.next = ast_type_copy(ctx, left);
407 if (!self->expression.next) {
413 self->expression.next = NULL;
418 void ast_binstore_delete(ast_binstore *self)
420 ast_unref(self->dest);
421 ast_unref(self->source);
422 ast_expression_delete((ast_expression*)self);
426 ast_unary* ast_unary_new(lex_ctx ctx, int op,
427 ast_expression *expr)
429 ast_instantiate(ast_unary, ctx, ast_unary_delete);
430 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_unary_codegen);
433 self->operand = expr;
435 if (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) {
436 self->expression.vtype = TYPE_FLOAT;
438 asterror(ctx, "cannot determine type of unary operation %s", asm_instr[op].m);
443 void ast_unary_delete(ast_unary *self)
445 ast_unref(self->operand);
446 ast_expression_delete((ast_expression*)self);
450 ast_return* ast_return_new(lex_ctx ctx, ast_expression *expr)
452 ast_instantiate(ast_return, ctx, ast_return_delete);
453 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_return_codegen);
455 self->operand = expr;
460 void ast_return_delete(ast_return *self)
463 ast_unref(self->operand);
464 ast_expression_delete((ast_expression*)self);
468 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field)
470 const ast_expression *outtype;
472 ast_instantiate(ast_entfield, ctx, ast_entfield_delete);
474 if (field->expression.vtype != TYPE_FIELD) {
479 outtype = field->expression.next;
482 /* Error: field has no type... */
486 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_entfield_codegen);
488 self->entity = entity;
491 if (!ast_type_adopt(self, outtype)) {
492 ast_entfield_delete(self);
499 void ast_entfield_delete(ast_entfield *self)
501 ast_unref(self->entity);
502 ast_unref(self->field);
503 ast_expression_delete((ast_expression*)self);
507 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field)
509 ast_instantiate(ast_member, ctx, ast_member_delete);
515 if (owner->expression.vtype != TYPE_VECTOR &&
516 owner->expression.vtype != TYPE_FIELD) {
517 asterror(ctx, "member-access on an invalid owner of type %s", type_name[owner->expression.vtype]);
522 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_member_codegen);
523 self->expression.node.keep = true; /* keep */
525 if (owner->expression.vtype == TYPE_VECTOR) {
526 self->expression.vtype = TYPE_FLOAT;
527 self->expression.next = NULL;
529 self->expression.vtype = TYPE_FIELD;
530 self->expression.next = ast_shallow_type(ctx, TYPE_FLOAT);
539 void ast_member_delete(ast_member *self)
541 /* The owner is always an ast_value, which has .keep=true,
542 * also: ast_members are usually deleted after the owner, thus
543 * this will cause invalid access
544 ast_unref(self->owner);
545 * once we allow (expression).x to access a vector-member, we need
546 * to change this: preferably by creating an alternate ast node for this
547 * purpose that is not garbage-collected.
549 ast_expression_delete((ast_expression*)self);
553 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse)
555 ast_instantiate(ast_ifthen, ctx, ast_ifthen_delete);
556 if (!ontrue && !onfalse) {
557 /* because it is invalid */
561 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_ifthen_codegen);
564 self->on_true = ontrue;
565 self->on_false = onfalse;
570 void ast_ifthen_delete(ast_ifthen *self)
572 ast_unref(self->cond);
574 ast_unref(self->on_true);
576 ast_unref(self->on_false);
577 ast_expression_delete((ast_expression*)self);
581 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse)
583 ast_instantiate(ast_ternary, ctx, ast_ternary_delete);
584 /* This time NEITHER must be NULL */
585 if (!ontrue || !onfalse) {
589 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_ternary_codegen);
592 self->on_true = ontrue;
593 self->on_false = onfalse;
594 self->phi_out = NULL;
599 void ast_ternary_delete(ast_ternary *self)
601 ast_unref(self->cond);
602 ast_unref(self->on_true);
603 ast_unref(self->on_false);
604 ast_expression_delete((ast_expression*)self);
608 ast_loop* ast_loop_new(lex_ctx ctx,
609 ast_expression *initexpr,
610 ast_expression *precond,
611 ast_expression *postcond,
612 ast_expression *increment,
613 ast_expression *body)
615 ast_instantiate(ast_loop, ctx, ast_loop_delete);
616 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_loop_codegen);
618 self->initexpr = initexpr;
619 self->precond = precond;
620 self->postcond = postcond;
621 self->increment = increment;
627 void ast_loop_delete(ast_loop *self)
630 ast_unref(self->initexpr);
632 ast_unref(self->precond);
634 ast_unref(self->postcond);
636 ast_unref(self->increment);
638 ast_unref(self->body);
639 ast_expression_delete((ast_expression*)self);
643 ast_call* ast_call_new(lex_ctx ctx,
644 ast_expression *funcexpr)
646 ast_instantiate(ast_call, ctx, ast_call_delete);
647 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_call_codegen);
649 MEM_VECTOR_INIT(self, params);
651 self->func = funcexpr;
653 self->expression.vtype = funcexpr->expression.next->expression.vtype;
654 if (funcexpr->expression.next->expression.next)
655 self->expression.next = ast_type_copy(ctx, funcexpr->expression.next->expression.next);
659 MEM_VEC_FUNCTIONS(ast_call, ast_expression*, params)
661 void ast_call_delete(ast_call *self)
664 for (i = 0; i < self->params_count; ++i)
665 ast_unref(self->params[i]);
666 MEM_VECTOR_CLEAR(self, params);
669 ast_unref(self->func);
671 ast_expression_delete((ast_expression*)self);
675 bool ast_call_check_types(ast_call *self)
679 const ast_expression *func = self->func;
680 size_t count = self->params_count;
681 if (count > func->expression.params_count)
682 count = func->expression.params_count;
684 for (i = 0; i < count; ++i) {
685 if (!ast_compare_type(self->params[i], (ast_expression*)(func->expression.params[i]))) {
686 asterror(ast_ctx(self), "invalid type for parameter %u in function call",
687 (unsigned int)(i+1));
688 /* we don't immediately return */
695 ast_store* ast_store_new(lex_ctx ctx, int op,
696 ast_expression *dest, ast_expression *source)
698 ast_instantiate(ast_store, ctx, ast_store_delete);
699 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_store_codegen);
703 self->source = source;
705 self->expression.vtype = dest->expression.vtype;
706 if (dest->expression.next) {
707 self->expression.next = ast_type_copy(ctx, dest);
708 if (!self->expression.next) {
714 self->expression.next = NULL;
719 void ast_store_delete(ast_store *self)
721 ast_unref(self->dest);
722 ast_unref(self->source);
723 ast_expression_delete((ast_expression*)self);
727 ast_block* ast_block_new(lex_ctx ctx)
729 ast_instantiate(ast_block, ctx, ast_block_delete);
730 ast_expression_init((ast_expression*)self,
731 (ast_expression_codegen*)&ast_block_codegen);
733 MEM_VECTOR_INIT(self, locals);
734 MEM_VECTOR_INIT(self, exprs);
735 MEM_VECTOR_INIT(self, collect);
739 MEM_VEC_FUNCTIONS(ast_block, ast_value*, locals)
740 MEM_VEC_FUNCTIONS(ast_block, ast_expression*, exprs)
741 MEM_VEC_FUNCTIONS(ast_block, ast_expression*, collect)
743 bool ast_block_collect(ast_block *self, ast_expression *expr)
745 if (!ast_block_collect_add(self, expr))
747 expr->expression.node.keep = true;
751 void ast_block_delete(ast_block *self)
754 for (i = 0; i < self->exprs_count; ++i)
755 ast_unref(self->exprs[i]);
756 MEM_VECTOR_CLEAR(self, exprs);
757 for (i = 0; i < self->locals_count; ++i)
758 ast_delete(self->locals[i]);
759 MEM_VECTOR_CLEAR(self, locals);
760 for (i = 0; i < self->collect_count; ++i)
761 ast_delete(self->collect[i]);
762 MEM_VECTOR_CLEAR(self, collect);
763 ast_expression_delete((ast_expression*)self);
767 bool ast_block_set_type(ast_block *self, ast_expression *from)
769 if (self->expression.next)
770 ast_delete(self->expression.next);
771 self->expression.vtype = from->expression.vtype;
772 if (from->expression.next) {
773 self->expression.next = ast_type_copy(self->expression.node.context, from->expression.next);
774 if (!self->expression.next)
778 self->expression.next = NULL;
782 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype)
784 ast_instantiate(ast_function, ctx, ast_function_delete);
788 vtype->expression.vtype != TYPE_FUNCTION)
795 self->name = name ? util_strdup(name) : NULL;
796 MEM_VECTOR_INIT(self, blocks);
798 self->labelcount = 0;
801 self->ir_func = NULL;
802 self->curblock = NULL;
804 self->breakblock = NULL;
805 self->continueblock = NULL;
807 vtype->isconst = true;
808 vtype->constval.vfunc = self;
813 MEM_VEC_FUNCTIONS(ast_function, ast_block*, blocks)
815 void ast_function_delete(ast_function *self)
819 mem_d((void*)self->name);
821 /* ast_value_delete(self->vtype); */
822 self->vtype->isconst = false;
823 self->vtype->constval.vfunc = NULL;
824 /* We use unref - if it was stored in a global table it is supposed
825 * to be deleted from *there*
827 ast_unref(self->vtype);
829 for (i = 0; i < self->blocks_count; ++i)
830 ast_delete(self->blocks[i]);
831 MEM_VECTOR_CLEAR(self, blocks);
835 const char* ast_function_label(ast_function *self, const char *prefix)
844 id = (self->labelcount++);
845 len = strlen(prefix);
847 from = self->labelbuf + sizeof(self->labelbuf)-1;
850 unsigned int digit = id % 10;
854 memcpy(from - len, prefix, len);
858 /*********************************************************************/
860 * by convention you must never pass NULL to the 'ir_value **out'
861 * parameter. If you really don't care about the output, pass a dummy.
862 * But I can't imagine a pituation where the output is truly unnecessary.
865 bool ast_value_codegen(ast_value *self, ast_function *func, bool lvalue, ir_value **out)
867 /* NOTE: This is the codegen for a variable used in an expression.
868 * It is not the codegen to generate the value. For this purpose,
869 * ast_local_codegen and ast_global_codegen are to be used before this
870 * is executed. ast_function_codegen should take care of its locals,
871 * and the ast-user should take care of ast_global_codegen to be used
872 * on all the globals.
875 asterror(ast_ctx(self), "ast_value used before generated (%s)", self->name);
882 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield)
885 if (self->isconst && self->expression.vtype == TYPE_FUNCTION)
887 ir_function *func = ir_builder_create_function(ir, self->name, self->expression.next->expression.vtype);
890 func->context = ast_ctx(self);
891 func->value->context = ast_ctx(self);
893 self->constval.vfunc->ir_func = func;
894 self->ir_v = func->value;
895 /* The function is filled later on ast_function_codegen... */
899 if (isfield && self->expression.vtype == TYPE_FIELD) {
900 v = ir_builder_create_field(ir, self->name, self->expression.next->expression.vtype);
903 v->context = ast_ctx(self);
905 asterror(ast_ctx(self), "TODO: constant field pointers with value");
912 if (self->expression.vtype == TYPE_ARRAY) {
914 /* we are lame now - considering the way QC works we won't tolerate arrays > 1024 elements */
915 if (!self->expression.count || self->expression.count > opts_max_array_size) {
916 asterror(ast_ctx(self), "Invalid array of size %lu", (unsigned long)self->expression.count);
918 for (ai = 0; ai < self->expression.count; ++ai) {
919 asterror(ast_ctx(self), "TODO: array gen");
924 /* Arrays don't do this since there's no "array" value which spans across the
927 v = ir_builder_create_global(ir, self->name, self->expression.vtype);
929 asterror(ast_ctx(self), "ir_builder_create_global failed");
932 if (self->expression.vtype == TYPE_FIELD)
933 v->fieldtype = self->expression.next->expression.vtype;
934 v->context = ast_ctx(self);
938 switch (self->expression.vtype)
941 if (!ir_value_set_float(v, self->constval.vfloat))
945 if (!ir_value_set_vector(v, self->constval.vvec))
949 if (!ir_value_set_string(v, self->constval.vstring))
953 asterror(ast_ctx(self), "TODO: global constant array");
956 asterror(ast_ctx(self), "global of type function not properly generated");
958 /* Cannot generate an IR value for a function,
959 * need a pointer pointing to a function rather.
962 asterror(ast_ctx(self), "TODO: global constant type %i", self->expression.vtype);
967 /* link us to the ir_value */
971 error: /* clean up */
976 bool ast_local_codegen(ast_value *self, ir_function *func, bool param)
979 if (self->isconst && self->expression.vtype == TYPE_FUNCTION)
981 /* Do we allow local functions? I think not...
982 * this is NOT a function pointer atm.
987 if (self->expression.vtype == TYPE_ARRAY)
989 asterror(ast_ctx(self), "TODO: ast_local_codgen for TYPE_ARRAY");
993 v = ir_function_create_local(func, self->name, self->expression.vtype, param);
996 if (self->expression.vtype == TYPE_FIELD)
997 v->fieldtype = self->expression.next->expression.vtype;
998 v->context = ast_ctx(self);
1000 /* A constant local... hmmm...
1001 * I suppose the IR will have to deal with this
1003 if (self->isconst) {
1004 switch (self->expression.vtype)
1007 if (!ir_value_set_float(v, self->constval.vfloat))
1011 if (!ir_value_set_vector(v, self->constval.vvec))
1015 if (!ir_value_set_string(v, self->constval.vstring))
1019 asterror(ast_ctx(self), "TODO: global constant type %i", self->expression.vtype);
1024 /* link us to the ir_value */
1028 error: /* clean up */
1033 bool ast_function_codegen(ast_function *self, ir_builder *ir)
1037 ast_expression_common *ec;
1040 irf = self->ir_func;
1042 asterror(ast_ctx(self), "ast_function's related ast_value was not generated yet");
1046 /* fill the parameter list */
1047 ec = &self->vtype->expression;
1048 for (i = 0; i < ec->params_count; ++i)
1050 if (!ir_function_params_add(irf, ec->params[i]->expression.vtype))
1052 if (!self->builtin) {
1053 if (!ast_local_codegen(ec->params[i], self->ir_func, true))
1058 if (self->builtin) {
1059 irf->builtin = self->builtin;
1063 if (!self->blocks_count) {
1064 asterror(ast_ctx(self), "function `%s` has no body", self->name);
1068 self->curblock = ir_function_create_block(irf, "entry");
1069 if (!self->curblock) {
1070 asterror(ast_ctx(self), "failed to allocate entry block for `%s`", self->name);
1074 for (i = 0; i < self->blocks_count; ++i) {
1075 ast_expression_codegen *gen = self->blocks[i]->expression.codegen;
1076 if (!(*gen)((ast_expression*)self->blocks[i], self, false, &dummy))
1080 /* TODO: check return types */
1081 if (!self->curblock->is_return)
1083 return ir_block_create_return(self->curblock, NULL);
1084 /* From now on the parser has to handle this situation */
1086 if (!self->vtype->expression.next ||
1087 self->vtype->expression.next->expression.vtype == TYPE_VOID)
1089 return ir_block_create_return(self->curblock, NULL);
1093 /* error("missing return"); */
1094 asterror(ast_ctx(self), "function `%s` missing return value", self->name);
1102 /* Note, you will not see ast_block_codegen generate ir_blocks.
1103 * To the AST and the IR, blocks are 2 different things.
1104 * In the AST it represents a block of code, usually enclosed in
1105 * curly braces {...}.
1106 * While in the IR it represents a block in terms of control-flow.
1108 bool ast_block_codegen(ast_block *self, ast_function *func, bool lvalue, ir_value **out)
1112 /* We don't use this
1113 * Note: an ast-representation using the comma-operator
1114 * of the form: (a, b, c) = x should not assign to c...
1117 asterror(ast_ctx(self), "not an l-value (code-block)");
1121 if (self->expression.outr) {
1122 *out = self->expression.outr;
1126 /* output is NULL at first, we'll have each expression
1127 * assign to out output, thus, a comma-operator represention
1128 * using an ast_block will return the last generated value,
1129 * so: (b, c) + a executed both b and c, and returns c,
1130 * which is then added to a.
1134 /* generate locals */
1135 for (i = 0; i < self->locals_count; ++i)
1137 if (!ast_local_codegen(self->locals[i], func->ir_func, false)) {
1139 asterror(ast_ctx(self), "failed to generate local `%s`", self->locals[i]->name);
1144 for (i = 0; i < self->exprs_count; ++i)
1146 ast_expression_codegen *gen = self->exprs[i]->expression.codegen;
1147 if (!(*gen)(self->exprs[i], func, false, out))
1151 self->expression.outr = *out;
1156 bool ast_store_codegen(ast_store *self, ast_function *func, bool lvalue, ir_value **out)
1158 ast_expression_codegen *cgen;
1159 ir_value *left, *right;
1161 if (lvalue && self->expression.outl) {
1162 *out = self->expression.outl;
1166 if (!lvalue && self->expression.outr) {
1167 *out = self->expression.outr;
1171 cgen = self->dest->expression.codegen;
1173 if (!(*cgen)((ast_expression*)(self->dest), func, true, &left))
1175 self->expression.outl = left;
1177 cgen = self->source->expression.codegen;
1179 if (!(*cgen)((ast_expression*)(self->source), func, false, &right))
1182 if (!ir_block_create_store_op(func->curblock, self->op, left, right))
1184 self->expression.outr = right;
1186 /* Theoretically, an assinment returns its left side as an
1187 * lvalue, if we don't need an lvalue though, we return
1188 * the right side as an rvalue, otherwise we have to
1189 * somehow know whether or not we need to dereference the pointer
1190 * on the left side - that is: OP_LOAD if it was an address.
1191 * Also: in original QC we cannot OP_LOADP *anyway*.
1193 *out = (lvalue ? left : right);
1198 bool ast_binary_codegen(ast_binary *self, ast_function *func, bool lvalue, ir_value **out)
1200 ast_expression_codegen *cgen;
1201 ir_value *left, *right;
1203 /* A binary operation cannot yield an l-value */
1205 asterror(ast_ctx(self), "not an l-value (binop)");
1209 if (self->expression.outr) {
1210 *out = self->expression.outr;
1214 cgen = self->left->expression.codegen;
1216 if (!(*cgen)((ast_expression*)(self->left), func, false, &left))
1219 cgen = self->right->expression.codegen;
1221 if (!(*cgen)((ast_expression*)(self->right), func, false, &right))
1224 *out = ir_block_create_binop(func->curblock, ast_function_label(func, "bin"),
1225 self->op, left, right);
1228 self->expression.outr = *out;
1233 bool ast_binstore_codegen(ast_binstore *self, ast_function *func, bool lvalue, ir_value **out)
1235 ast_expression_codegen *cgen;
1236 ir_value *leftl, *leftr, *right, *bin;
1238 if (lvalue && self->expression.outl) {
1239 *out = self->expression.outl;
1243 if (!lvalue && self->expression.outr) {
1244 *out = self->expression.outr;
1248 /* for a binstore we need both an lvalue and an rvalue for the left side */
1249 /* rvalue of destination! */
1250 cgen = self->dest->expression.codegen;
1251 if (!(*cgen)((ast_expression*)(self->dest), func, false, &leftr))
1254 /* source as rvalue only */
1255 cgen = self->source->expression.codegen;
1256 if (!(*cgen)((ast_expression*)(self->source), func, false, &right))
1259 /* now the binary */
1260 bin = ir_block_create_binop(func->curblock, ast_function_label(func, "binst"),
1261 self->opbin, leftr, right);
1262 self->expression.outr = bin;
1264 /* now store them */
1265 cgen = self->dest->expression.codegen;
1266 /* lvalue of destination */
1267 if (!(*cgen)((ast_expression*)(self->dest), func, true, &leftl))
1269 self->expression.outl = leftl;
1271 if (!ir_block_create_store_op(func->curblock, self->opstore, leftl, bin))
1273 self->expression.outr = bin;
1275 /* Theoretically, an assinment returns its left side as an
1276 * lvalue, if we don't need an lvalue though, we return
1277 * the right side as an rvalue, otherwise we have to
1278 * somehow know whether or not we need to dereference the pointer
1279 * on the left side - that is: OP_LOAD if it was an address.
1280 * Also: in original QC we cannot OP_LOADP *anyway*.
1282 *out = (lvalue ? leftl : bin);
1287 bool ast_unary_codegen(ast_unary *self, ast_function *func, bool lvalue, ir_value **out)
1289 ast_expression_codegen *cgen;
1292 /* An unary operation cannot yield an l-value */
1294 asterror(ast_ctx(self), "not an l-value (binop)");
1298 if (self->expression.outr) {
1299 *out = self->expression.outr;
1303 cgen = self->operand->expression.codegen;
1305 if (!(*cgen)((ast_expression*)(self->operand), func, false, &operand))
1308 *out = ir_block_create_unary(func->curblock, ast_function_label(func, "unary"),
1312 self->expression.outr = *out;
1317 bool ast_return_codegen(ast_return *self, ast_function *func, bool lvalue, ir_value **out)
1319 ast_expression_codegen *cgen;
1322 /* In the context of a return operation, we don't actually return
1326 asterror(ast_ctx(self), "return-expression is not an l-value");
1330 if (self->expression.outr) {
1331 asterror(ast_ctx(self), "internal error: ast_return cannot be reused, it bears no result!");
1334 self->expression.outr = (ir_value*)1;
1336 if (self->operand) {
1337 cgen = self->operand->expression.codegen;
1339 if (!(*cgen)((ast_expression*)(self->operand), func, false, &operand))
1342 if (!ir_block_create_return(func->curblock, operand))
1345 if (!ir_block_create_return(func->curblock, NULL))
1352 bool ast_entfield_codegen(ast_entfield *self, ast_function *func, bool lvalue, ir_value **out)
1354 ast_expression_codegen *cgen;
1355 ir_value *ent, *field;
1357 /* This function needs to take the 'lvalue' flag into account!
1358 * As lvalue we provide a field-pointer, as rvalue we provide the
1362 if (lvalue && self->expression.outl) {
1363 *out = self->expression.outl;
1367 if (!lvalue && self->expression.outr) {
1368 *out = self->expression.outr;
1372 cgen = self->entity->expression.codegen;
1373 if (!(*cgen)((ast_expression*)(self->entity), func, false, &ent))
1376 cgen = self->field->expression.codegen;
1377 if (!(*cgen)((ast_expression*)(self->field), func, false, &field))
1382 *out = ir_block_create_fieldaddress(func->curblock, ast_function_label(func, "efa"),
1385 *out = ir_block_create_load_from_ent(func->curblock, ast_function_label(func, "efv"),
1386 ent, field, self->expression.vtype);
1389 asterror(ast_ctx(self), "failed to create %s instruction (output type %s)",
1390 (lvalue ? "ADDRESS" : "FIELD"),
1391 type_name[self->expression.vtype]);
1396 self->expression.outl = *out;
1398 self->expression.outr = *out;
1400 /* Hm that should be it... */
1404 bool ast_member_codegen(ast_member *self, ast_function *func, bool lvalue, ir_value **out)
1406 ast_expression_codegen *cgen;
1409 /* in QC this is always an lvalue */
1411 if (self->expression.outl) {
1412 *out = self->expression.outl;
1416 cgen = self->owner->expression.codegen;
1417 if (!(*cgen)((ast_expression*)(self->owner), func, true, &vec))
1420 if (vec->vtype != TYPE_VECTOR &&
1421 !(vec->vtype == TYPE_FIELD && self->owner->expression.next->expression.vtype == TYPE_VECTOR))
1426 *out = ir_value_vector_member(vec, self->field);
1427 self->expression.outl = *out;
1429 return (*out != NULL);
1432 bool ast_ifthen_codegen(ast_ifthen *self, ast_function *func, bool lvalue, ir_value **out)
1434 ast_expression_codegen *cgen;
1439 ir_block *cond = func->curblock;
1442 ir_block *ontrue_endblock = NULL;
1443 ir_block *onfalse_endblock = NULL;
1446 /* We don't output any value, thus also don't care about r/lvalue */
1450 if (self->expression.outr) {
1451 asterror(ast_ctx(self), "internal error: ast_ifthen cannot be reused, it bears no result!");
1454 self->expression.outr = (ir_value*)1;
1456 /* generate the condition */
1457 func->curblock = cond;
1458 cgen = self->cond->expression.codegen;
1459 if (!(*cgen)((ast_expression*)(self->cond), func, false, &condval))
1464 if (self->on_true) {
1465 /* create on-true block */
1466 ontrue = ir_function_create_block(func->ir_func, ast_function_label(func, "ontrue"));
1470 /* enter the block */
1471 func->curblock = ontrue;
1474 cgen = self->on_true->expression.codegen;
1475 if (!(*cgen)((ast_expression*)(self->on_true), func, false, &dummy))
1478 /* we now need to work from the current endpoint */
1479 ontrue_endblock = func->curblock;
1484 if (self->on_false) {
1485 /* create on-false block */
1486 onfalse = ir_function_create_block(func->ir_func, ast_function_label(func, "onfalse"));
1490 /* enter the block */
1491 func->curblock = onfalse;
1494 cgen = self->on_false->expression.codegen;
1495 if (!(*cgen)((ast_expression*)(self->on_false), func, false, &dummy))
1498 /* we now need to work from the current endpoint */
1499 onfalse_endblock = func->curblock;
1503 /* Merge block were they all merge in to */
1504 merge = ir_function_create_block(func->ir_func, ast_function_label(func, "endif"));
1508 /* add jumps ot the merge block */
1509 if (ontrue && !ontrue_endblock->final && !ir_block_create_jump(ontrue_endblock, merge))
1511 if (onfalse && !onfalse_endblock->final && !ir_block_create_jump(onfalse_endblock, merge))
1514 /* we create the if here, that way all blocks are ordered :)
1516 if (!ir_block_create_if(cond, condval,
1517 (ontrue ? ontrue : merge),
1518 (onfalse ? onfalse : merge)))
1523 /* Now enter the merge block */
1524 func->curblock = merge;
1529 bool ast_ternary_codegen(ast_ternary *self, ast_function *func, bool lvalue, ir_value **out)
1531 ast_expression_codegen *cgen;
1534 ir_value *trueval, *falseval;
1537 ir_block *cond = func->curblock;
1542 /* Ternary can never create an lvalue... */
1546 /* In theory it shouldn't be possible to pass through a node twice, but
1547 * in case we add any kind of optimization pass for the AST itself, it
1548 * may still happen, thus we remember a created ir_value and simply return one
1549 * if it already exists.
1551 if (self->phi_out) {
1552 *out = self->phi_out;
1556 /* In the following, contraty to ast_ifthen, we assume both paths exist. */
1558 /* generate the condition */
1559 func->curblock = cond;
1560 cgen = self->cond->expression.codegen;
1561 if (!(*cgen)((ast_expression*)(self->cond), func, false, &condval))
1564 /* create on-true block */
1565 ontrue = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_T"));
1570 /* enter the block */
1571 func->curblock = ontrue;
1574 cgen = self->on_true->expression.codegen;
1575 if (!(*cgen)((ast_expression*)(self->on_true), func, false, &trueval))
1579 /* create on-false block */
1580 onfalse = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_F"));
1585 /* enter the block */
1586 func->curblock = onfalse;
1589 cgen = self->on_false->expression.codegen;
1590 if (!(*cgen)((ast_expression*)(self->on_false), func, false, &falseval))
1594 /* create merge block */
1595 merge = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_out"));
1598 /* jump to merge block */
1599 if (!ir_block_create_jump(ontrue, merge))
1601 if (!ir_block_create_jump(onfalse, merge))
1604 /* create if instruction */
1605 if (!ir_block_create_if(cond, condval, ontrue, onfalse))
1608 /* Now enter the merge block */
1609 func->curblock = merge;
1611 /* Here, now, we need a PHI node
1612 * but first some sanity checking...
1614 if (trueval->vtype != falseval->vtype) {
1615 /* error("ternary with different types on the two sides"); */
1620 phi = ir_block_create_phi(merge, ast_function_label(func, "phi"), trueval->vtype);
1622 !ir_phi_add(phi, ontrue, trueval) ||
1623 !ir_phi_add(phi, onfalse, falseval))
1628 self->phi_out = ir_phi_value(phi);
1629 *out = self->phi_out;
1634 bool ast_loop_codegen(ast_loop *self, ast_function *func, bool lvalue, ir_value **out)
1636 ast_expression_codegen *cgen;
1638 ir_value *dummy = NULL;
1639 ir_value *precond = NULL;
1640 ir_value *postcond = NULL;
1642 /* Since we insert some jumps "late" so we have blocks
1643 * ordered "nicely", we need to keep track of the actual end-blocks
1644 * of expressions to add the jumps to.
1646 ir_block *bbody = NULL, *end_bbody = NULL;
1647 ir_block *bprecond = NULL, *end_bprecond = NULL;
1648 ir_block *bpostcond = NULL, *end_bpostcond = NULL;
1649 ir_block *bincrement = NULL, *end_bincrement = NULL;
1650 ir_block *bout = NULL, *bin = NULL;
1652 /* let's at least move the outgoing block to the end */
1655 /* 'break' and 'continue' need to be able to find the right blocks */
1656 ir_block *bcontinue = NULL;
1657 ir_block *bbreak = NULL;
1659 ir_block *old_bcontinue = NULL;
1660 ir_block *old_bbreak = NULL;
1662 ir_block *tmpblock = NULL;
1667 if (self->expression.outr) {
1668 asterror(ast_ctx(self), "internal error: ast_loop cannot be reused, it bears no result!");
1671 self->expression.outr = (ir_value*)1;
1674 * Should we ever need some kind of block ordering, better make this function
1675 * move blocks around than write a block ordering algorithm later... after all
1676 * the ast and ir should work together, not against each other.
1679 /* initexpr doesn't get its own block, it's pointless, it could create more blocks
1680 * anyway if for example it contains a ternary.
1684 cgen = self->initexpr->expression.codegen;
1685 if (!(*cgen)((ast_expression*)(self->initexpr), func, false, &dummy))
1689 /* Store the block from which we enter this chaos */
1690 bin = func->curblock;
1692 /* The pre-loop condition needs its own block since we
1693 * need to be able to jump to the start of that expression.
1697 bprecond = ir_function_create_block(func->ir_func, ast_function_label(func, "pre_loop_cond"));
1701 /* the pre-loop-condition the least important place to 'continue' at */
1702 bcontinue = bprecond;
1705 func->curblock = bprecond;
1708 cgen = self->precond->expression.codegen;
1709 if (!(*cgen)((ast_expression*)(self->precond), func, false, &precond))
1712 end_bprecond = func->curblock;
1714 bprecond = end_bprecond = NULL;
1717 /* Now the next blocks won't be ordered nicely, but we need to
1718 * generate them this early for 'break' and 'continue'.
1720 if (self->increment) {
1721 bincrement = ir_function_create_block(func->ir_func, ast_function_label(func, "loop_increment"));
1724 bcontinue = bincrement; /* increment comes before the pre-loop-condition */
1726 bincrement = end_bincrement = NULL;
1729 if (self->postcond) {
1730 bpostcond = ir_function_create_block(func->ir_func, ast_function_label(func, "post_loop_cond"));
1733 bcontinue = bpostcond; /* postcond comes before the increment */
1735 bpostcond = end_bpostcond = NULL;
1738 bout_id = func->ir_func->blocks_count;
1739 bout = ir_function_create_block(func->ir_func, ast_function_label(func, "after_loop"));
1744 /* The loop body... */
1747 bbody = ir_function_create_block(func->ir_func, ast_function_label(func, "loop_body"));
1752 func->curblock = bbody;
1754 old_bbreak = func->breakblock;
1755 old_bcontinue = func->continueblock;
1756 func->breakblock = bbreak;
1757 func->continueblock = bcontinue;
1760 cgen = self->body->expression.codegen;
1761 if (!(*cgen)((ast_expression*)(self->body), func, false, &dummy))
1764 end_bbody = func->curblock;
1765 func->breakblock = old_bbreak;
1766 func->continueblock = old_bcontinue;
1769 /* post-loop-condition */
1773 func->curblock = bpostcond;
1776 cgen = self->postcond->expression.codegen;
1777 if (!(*cgen)((ast_expression*)(self->postcond), func, false, &postcond))
1780 end_bpostcond = func->curblock;
1783 /* The incrementor */
1784 if (self->increment)
1787 func->curblock = bincrement;
1790 cgen = self->increment->expression.codegen;
1791 if (!(*cgen)((ast_expression*)(self->increment), func, false, &dummy))
1794 end_bincrement = func->curblock;
1797 /* In any case now, we continue from the outgoing block */
1798 func->curblock = bout;
1800 /* Now all blocks are in place */
1801 /* From 'bin' we jump to whatever comes first */
1802 if (bprecond) tmpblock = bprecond;
1803 else if (bbody) tmpblock = bbody;
1804 else if (bpostcond) tmpblock = bpostcond;
1805 else tmpblock = bout;
1806 if (!ir_block_create_jump(bin, tmpblock))
1812 ir_block *ontrue, *onfalse;
1813 if (bbody) ontrue = bbody;
1814 else if (bincrement) ontrue = bincrement;
1815 else if (bpostcond) ontrue = bpostcond;
1816 else ontrue = bprecond;
1818 if (!ir_block_create_if(end_bprecond, precond, ontrue, onfalse))
1825 if (bincrement) tmpblock = bincrement;
1826 else if (bpostcond) tmpblock = bpostcond;
1827 else if (bprecond) tmpblock = bprecond;
1828 else tmpblock = bout;
1829 if (!end_bbody->final && !ir_block_create_jump(end_bbody, tmpblock))
1833 /* from increment */
1836 if (bpostcond) tmpblock = bpostcond;
1837 else if (bprecond) tmpblock = bprecond;
1838 else if (bbody) tmpblock = bbody;
1839 else tmpblock = bout;
1840 if (!ir_block_create_jump(end_bincrement, tmpblock))
1847 ir_block *ontrue, *onfalse;
1848 if (bprecond) ontrue = bprecond;
1849 else if (bbody) ontrue = bbody;
1850 else if (bincrement) ontrue = bincrement;
1851 else ontrue = bpostcond;
1853 if (!ir_block_create_if(end_bpostcond, postcond, ontrue, onfalse))
1857 /* Move 'bout' to the end */
1858 if (!ir_function_blocks_remove(func->ir_func, bout_id) ||
1859 !ir_function_blocks_add(func->ir_func, bout))
1861 ir_block_delete(bout);
1868 bool ast_call_codegen(ast_call *self, ast_function *func, bool lvalue, ir_value **out)
1870 ast_expression_codegen *cgen;
1871 ir_value_vector params;
1872 ir_instr *callinstr;
1875 ir_value *funval = NULL;
1877 /* return values are never lvalues */
1879 asterror(ast_ctx(self), "not an l-value (function call)");
1883 if (self->expression.outr) {
1884 *out = self->expression.outr;
1888 cgen = self->func->expression.codegen;
1889 if (!(*cgen)((ast_expression*)(self->func), func, false, &funval))
1894 MEM_VECTOR_INIT(¶ms, v);
1897 for (i = 0; i < self->params_count; ++i)
1900 ast_expression *expr = self->params[i];
1902 cgen = expr->expression.codegen;
1903 if (!(*cgen)(expr, func, false, ¶m))
1907 if (!ir_value_vector_v_add(¶ms, param))
1911 callinstr = ir_block_create_call(func->curblock, ast_function_label(func, "call"), funval);
1915 for (i = 0; i < params.v_count; ++i) {
1916 if (!ir_call_param(callinstr, params.v[i]))
1920 *out = ir_call_value(callinstr);
1921 self->expression.outr = *out;
1923 MEM_VECTOR_CLEAR(¶ms, v);
1926 MEM_VECTOR_CLEAR(¶ms, v);