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
27 /* Note: I will not be using a _t suffix for the
28 * "main" ast node types for now.
31 typedef union ast_node_u ast_node;
32 typedef union ast_expression_u ast_expression;
34 typedef struct ast_value_s ast_value;
35 typedef struct ast_function_s ast_function;
36 typedef struct ast_block_s ast_block;
37 typedef struct ast_binary_s ast_binary;
38 typedef struct ast_store_s ast_store;
39 typedef struct ast_entfield_s ast_entfield;
40 typedef struct ast_ifthen_s ast_ifthen;
41 typedef struct ast_ternary_s ast_ternary;
42 typedef struct ast_loop_s ast_loop;
43 typedef struct ast_call_s ast_call;
44 typedef struct ast_unary_s ast_unary;
45 typedef struct ast_return_s ast_return;
47 /* Node interface with common components
49 typedef void ast_node_delete(ast_node*);
53 /* I don't feel comfortable using keywords like 'delete' as names... */
54 ast_node_delete *destroy;
55 /* keep: if a node contains this node, 'keep'
56 * prevents its dtor from destroying this node as well.
61 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
62 #define ast_unref(x) do \
64 if (! (((ast_node*)(x))->node.keep) ) { \
69 /* Expression interface
71 * Any expression or block returns an ir_value, and needs
72 * to know the current function.
74 typedef bool ast_expression_codegen(ast_expression*,
81 ast_expression_codegen *codegen;
84 } ast_expression_common;
88 * Types are also values, both have a type and a name.
89 * especially considering possible constructs like typedefs.
91 * is like creating a 'float foo', foo serving as the type's name.
95 ast_expression_common expression;
118 /* if vtype is qc_function, params contain parameters, and
119 * 'next' the return type.
121 MEM_VECTOR_MAKE(ast_value*, params);
123 MEM_VECTOR_PROTO(ast_value, ast_value*, params);
125 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
126 /* This will NOT delete an underlying ast_function */
127 void ast_value_delete(ast_value*);
129 bool ast_value_set_name(ast_value*, const char *name);
131 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
132 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
133 bool ast_global_codegen(ast_value *self, ir_builder *ir);
137 * A value-returning binary expression.
141 ast_expression_common expression;
144 ast_expression *left;
145 ast_expression *right;
147 ast_binary* ast_binary_new(lex_ctx ctx,
149 ast_expression *left,
150 ast_expression *right);
151 void ast_binary_delete(ast_binary*);
153 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
157 * Regular unary expressions: not,neg
161 ast_expression_common expression;
164 ast_expression *operand;
166 ast_unary* ast_unary_new(lex_ctx ctx,
168 ast_expression *expr);
169 void ast_unary_delete(ast_unary*);
171 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
175 * Make sure 'return' only happens at the end of a block, otherwise the IR
176 * will refuse to create further instructions.
177 * This should be honored by the parser.
181 ast_expression_common expression;
182 ast_expression *operand;
184 ast_return* ast_return_new(lex_ctx ctx,
185 ast_expression *expr);
186 void ast_return_delete(ast_return*);
188 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
192 * This must do 2 things:
193 * -) Provide a way to fetch an entity field value. (Rvalue)
194 * -) Provide a pointer to an entity field. (Lvalue)
196 * In original QC, there's only a STORE via pointer, but
197 * no LOAD via pointer.
198 * So we must know beforehand if we are going to read or assign
200 * For this we will have to extend the codegen() functions with
201 * a flag saying whether or not we need an L or an R-value.
203 struct ast_entfield_s
205 ast_expression_common expression;
206 /* The entity can come from an expression of course. */
207 ast_expression *entity;
208 /* As can the field, it just must result in a value of TYPE_FIELD */
209 ast_expression *field;
211 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
212 void ast_entfield_delete(ast_entfield*);
214 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
218 * Stores left<-right and returns left.
219 * Specialized binary expression node
223 ast_expression_common expression;
225 ast_value *dest; /* When we add pointers this might have to change to expression */
226 ast_expression *source;
228 ast_store* ast_store_new(lex_ctx ctx, int op,
229 ast_value *d, ast_expression *s);
230 void ast_store_delete(ast_store*);
232 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
236 * A general 'if then else' statement, either side can be NULL and will
237 * thus be omitted. It is an error for *both* cases to be NULL at once.
239 * During its 'codegen' it'll be changing the ast_function's block.
241 * An if is also an "expression". Its codegen will put NULL into the
242 * output field though. For ternary expressions an ast_ternary will be
247 ast_expression_common expression;
248 ast_expression *cond;
249 /* It's all just 'expressions', since an ast_block is one too. */
250 ast_expression *on_true;
251 ast_expression *on_false;
253 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
254 void ast_ifthen_delete(ast_ifthen*);
256 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
258 /* Ternary expressions...
260 * Contrary to 'if-then-else' nodes, ternary expressions actually
261 * return a value, otherwise they behave the very same way.
262 * The difference in 'codegen' is that it'll return the value of
265 * The other difference is that in an ast_ternary, NEITHER side
266 * must be NULL, there's ALWAYS an else branch.
268 * This is the only ast_node beside ast_value which contains
269 * an ir_value. Theoretically we don't need to remember it though.
273 ast_expression_common expression;
274 ast_expression *cond;
275 /* It's all just 'expressions', since an ast_block is one too. */
276 ast_expression *on_true;
277 ast_expression *on_false;
278 /* After a ternary expression we find ourselves in a new IR block
279 * and start with a PHI node */
282 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
283 void ast_ternary_delete(ast_ternary*);
285 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
287 /* A general loop node
289 * For convenience it contains 4 parts:
290 * -) (ini) = initializing expression
291 * -) (pre) = pre-loop condition
292 * -) (pst) = post-loop condition
293 * -) (inc) = "increment" expression
294 * The following is a psudo-representation of this loop
295 * note that '=>' bears the logical meaning of "implies".
296 * (a => b) equals (!a || b)
299 while (has_pre => {pre})
303 continue: // a 'continue' will jump here
304 if (has_pst => {pst})
312 ast_expression_common expression;
313 ast_expression *initexpr;
314 ast_expression *precond;
315 ast_expression *postcond;
316 ast_expression *increment;
317 ast_expression *body;
319 ast_loop* ast_loop_new(lex_ctx ctx,
320 ast_expression *initexpr,
321 ast_expression *precond,
322 ast_expression *postcond,
323 ast_expression *increment,
324 ast_expression *body);
325 void ast_loop_delete(ast_loop*);
327 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
331 * Contains an ast_expression as target, rather than an ast_function/value.
332 * Since it's how QC works, every ast_function has an ast_value
333 * associated anyway - in other words, the VM contains function
334 * pointers for every function anyway. Thus, this node will call
336 * Additionally it contains a list of ast_expressions as parameters.
337 * Since calls can return values, an ast_call is also an ast_expression.
341 ast_expression_common expression;
342 ast_expression *func;
343 MEM_VECTOR_MAKE(ast_expression*, params);
345 ast_call* ast_call_new(lex_ctx ctx,
346 ast_expression *funcexpr);
347 void ast_call_delete(ast_call*);
348 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
350 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
357 ast_expression_common expression;
359 MEM_VECTOR_MAKE(ast_value*, locals);
360 MEM_VECTOR_MAKE(ast_expression*, exprs);
362 ast_block* ast_block_new(lex_ctx ctx);
363 void ast_block_delete(ast_block*);
365 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
366 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
368 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
372 * Contains a list of blocks... at least in theory.
373 * Usually there's just the main block, other blocks are inside that.
375 * Technically, functions don't need to be an AST node, since we have
376 * neither functions inside functions, nor lambdas, and function
377 * pointers could just work with a name. However, this way could be
378 * more flexible, and adds no real complexity.
380 struct ast_function_s
382 ast_node_common node;
389 ir_function *ir_func;
391 ir_block *breakblock;
392 ir_block *continueblock;
395 /* in order for thread safety - for the optional
396 * channel abesed multithreading... keeping a buffer
397 * here to use in ast_function_label.
401 MEM_VECTOR_MAKE(ast_block*, blocks);
403 /* contrary to the params in ast_value, these are the parameter variables
404 * which are to be used in expressions.
405 * The ast_value for the function contains only the parameter types used
406 * to generate ast_calls, and ast_call contains the parameter values
410 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
411 /* This will NOT delete the underlying ast_value */
412 void ast_function_delete(ast_function*);
413 /* For "optimized" builds this can just keep returning "foo"...
416 const char* ast_function_label(ast_function*, const char *prefix);
418 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
420 bool ast_function_codegen(ast_function *self, ir_builder *builder);
424 union ast_expression_u
426 ast_expression_common expression;
434 ast_entfield entfield;
441 ast_node_common node;
442 ast_expression expression;