]> git.xonotic.org Git - xonotic/gmqcc.git/blob - ast.c
params should be deleted, not unref()d
[xonotic/gmqcc.git] / ast.c
1 /*
2  * Copyright (C) 2012
3  *     Wolfgang Bumiller
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9  * of the Software, and to permit persons to whom the Software is furnished to do
10  * so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26
27 #include "gmqcc.h"
28 #include "ast.h"
29
30 #define ast_instantiate(T, ctx, destroyfn)                          \
31     T* self = (T*)mem_a(sizeof(T));                                 \
32     ast_node_init((ast_node*)self, ctx);                            \
33     ( (ast_node*)self )->node.destroy = (ast_node_delete*)destroyfn
34
35 /* It must not be possible to get here. */
36 static void _ast_node_destroy(ast_node *self)
37 {
38     fprintf(stderr, "ast node missing destroy()\n");
39     abort();
40 }
41
42 /* Initialize main ast node aprts */
43 static void ast_node_init(ast_node *self, lex_ctx ctx)
44 {
45     self->node.context = ctx;
46     self->node.destroy = &_ast_node_destroy;
47     self->node.keep    = false;
48 }
49
50 /* General expression initialization */
51 static void ast_expression_init(ast_expression *self,
52                                 ast_expression_codegen *codegen)
53 {
54     self->expression.codegen = codegen;
55 }
56
57 ast_value* ast_value_new(lex_ctx ctx, const char *name, int t)
58 {
59     ast_instantiate(ast_value, ctx, ast_value_delete);
60     ast_expression_init((ast_expression*)self,
61                         (ast_expression_codegen*)&ast_value_codegen);
62     self->expression.node.keep = true; /* keep */
63
64     self->name = name ? util_strdup(name) : NULL;
65     self->vtype = t;
66     self->next = NULL;
67     MEM_VECTOR_INIT(self, params);
68     self->isconst = false;
69     memset(&self->constval, 0, sizeof(self->constval));
70
71     self->ir_v    = NULL;
72
73     return self;
74 }
75 MEM_VEC_FUNCTIONS(ast_value, ast_value*, params)
76
77 void ast_value_delete(ast_value* self)
78 {
79     size_t i;
80     if (self->name)
81         mem_d((void*)self->name);
82     for (i = 0; i < self->params_count; ++i)
83         ast_value_delete(self->params[i]); /* delete, the ast_function is expected to die first */
84     MEM_VECTOR_CLEAR(self, params);
85     if (self->next) /* delete, not unref, types are always copied */
86         ast_delete(self->next);
87     if (self->isconst) {
88         switch (self->vtype)
89         {
90         case TYPE_STRING:
91             mem_d((void*)self->constval.vstring);
92             break;
93         case TYPE_FUNCTION:
94             /* unlink us from the function node */
95             self->constval.vfunc->vtype = NULL;
96             break;
97         /* NOTE: delete function? currently collected in
98          * the parser structure
99          */
100         default:
101             break;
102         }
103     }
104     mem_d(self);
105 }
106
107 bool ast_value_set_name(ast_value *self, const char *name)
108 {
109     if (self->name)
110         mem_d((void*)self->name);
111     self->name = util_strdup(name);
112     return !!self->name;
113 }
114
115 ast_binary* ast_binary_new(lex_ctx ctx, int op,
116                            ast_expression* left, ast_expression* right)
117 {
118     ast_instantiate(ast_binary, ctx, ast_binary_delete);
119     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_binary_codegen);
120
121     self->op = op;
122     self->left = left;
123     self->right = right;
124
125     return self;
126 }
127
128 void ast_binary_delete(ast_binary *self)
129 {
130     ast_unref(self->left);
131     ast_unref(self->right);
132     mem_d(self);
133 }
134
135 ast_store* ast_store_new(lex_ctx ctx, int op,
136                          ast_value *dest, ast_expression *source)
137 {
138     ast_instantiate(ast_store, ctx, ast_store_delete);
139     ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_store_codegen);
140
141     self->op = op;
142     self->dest = dest;
143     self->source = source;
144
145     return self;
146 }
147
148 void ast_store_delete(ast_store *self)
149 {
150     ast_unref(self->dest);
151     ast_unref(self->source);
152     mem_d(self);
153 }
154
155 ast_block* ast_block_new(lex_ctx ctx)
156 {
157     ast_instantiate(ast_block, ctx, ast_block_delete);
158     ast_expression_init((ast_expression*)self,
159                         (ast_expression_codegen*)&ast_block_codegen);
160
161     MEM_VECTOR_INIT(self, locals);
162     MEM_VECTOR_INIT(self, exprs);
163
164     return self;
165 }
166 MEM_VEC_FUNCTIONS(ast_block, ast_value*, locals)
167 MEM_VEC_FUNCTIONS(ast_block, ast_expression*, exprs)
168
169 void ast_block_delete(ast_block *self)
170 {
171     size_t i;
172     for (i = 0; i < self->exprs_count; ++i)
173         ast_unref(self->exprs[i]);
174     MEM_VECTOR_CLEAR(self, exprs);
175     for (i = 0; i < self->locals_count; ++i)
176         ast_delete(self->locals[i]);
177     MEM_VECTOR_CLEAR(self, locals);
178     mem_d(self);
179 }
180
181 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype)
182 {
183     ast_instantiate(ast_function, ctx, ast_function_delete);
184
185     if (!vtype ||
186         vtype->isconst ||
187         vtype->vtype != TYPE_FUNCTION)
188     {
189         mem_d(self);
190         return NULL;
191     }
192
193     self->vtype = vtype;
194     self->name = name ? util_strdup(name) : NULL;
195     MEM_VECTOR_INIT(self, blocks);
196
197     self->ir_func = NULL;
198
199     vtype->isconst = true;
200     vtype->constval.vfunc = self;
201
202     return self;
203 }
204
205 MEM_VEC_FUNCTIONS(ast_function, ast_block*, blocks)
206
207 void ast_function_delete(ast_function *self)
208 {
209     size_t i;
210     if (self->name)
211         mem_d((void*)self->name);
212     if (self->vtype) {
213         /* ast_value_delete(self->vtype); */
214         self->vtype->isconst = false;
215         self->vtype->constval.vfunc = NULL;
216         /* We use unref - if it was stored in a global table it is supposed
217          * to be deleted from *there*
218          */
219         ast_unref(self->vtype);
220     }
221     for (i = 0; i < self->blocks_count; ++i)
222         ast_delete(self->blocks[i]);
223     MEM_VECTOR_CLEAR(self, blocks);
224     mem_d(self);
225 }
226
227 /*********************************************************************/
228 /* AST codegen aprt
229  */
230
231 bool ast_value_codegen(ast_value *self, ast_function *func, ir_value **out)
232 {
233     /* NOTE: This is the codegen for a variable used in an expression.
234      * It is not the codegen to generate the value. For this purpose,
235      * ast_local_codegen and ast_global_codegen are to be used before this
236      * is executed. ast_function_codegen should take care of its locals,
237      * and the ast-user should take care of ast_global_codegen to be used
238      * on all the globals.
239      */
240     return false;
241 }
242
243 bool ast_global_codegen(ast_value *self, ir_builder *ir)
244 {
245     ir_value *v = NULL;
246     if (self->isconst && self->vtype == TYPE_FUNCTION)
247     {
248         ir_function *func = ir_builder_create_function(ir, self->name);
249         if (!func)
250             return false;
251
252         self->constval.vfunc->ir_func = func;
253         /* The function is filled later on ast_function_codegen... */
254         return true;
255     }
256
257     v = ir_builder_create_global(ir, self->name, self->vtype);
258     if (!v)
259         return false;
260
261     if (self->isconst) {
262         switch (self->vtype)
263         {
264             case TYPE_FLOAT:
265                 if (!ir_value_set_float(v, self->constval.vfloat))
266                     goto error;
267                 break;
268             case TYPE_VECTOR:
269                 if (!ir_value_set_vector(v, self->constval.vvec))
270                     goto error;
271                 break;
272             case TYPE_STRING:
273                 if (!ir_value_set_string(v, self->constval.vstring))
274                     goto error;
275                 break;
276             case TYPE_FUNCTION:
277                 /* Cannot generate an IR value for a function,
278                  * need a pointer pointing to a function rather.
279                  */
280                 goto error;
281             default:
282                 printf("TODO: global constant type %i\n", self->vtype);
283                 break;
284         }
285     }
286
287     /* link us to the ir_value */
288     self->ir_v = v;
289     return true;
290
291 error: /* clean up */
292     ir_value_delete(v);
293     return false;
294 }
295
296 bool ast_function_codegen(ast_function *self, ir_builder *ir)
297 {
298     if (!self->ir_func) {
299         printf("ast_function's related ast_value was not generated yet\n");
300         return false;
301     }
302     return false;
303 }
304
305 bool ast_block_codegen(ast_block *self, ast_function *func, ir_value **out)
306 {
307     return false;
308 }
309
310 bool ast_store_codegen(ast_store *self, ast_function *func, ir_value **out)
311 {
312     return false;
313 }
314
315 bool ast_binary_codegen(ast_binary *self, ast_function *func, ir_value **out)
316 {
317     return false;
318 }