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_binstore_s ast_binstore;
40 typedef struct ast_entfield_s ast_entfield;
41 typedef struct ast_ifthen_s ast_ifthen;
42 typedef struct ast_ternary_s ast_ternary;
43 typedef struct ast_loop_s ast_loop;
44 typedef struct ast_call_s ast_call;
45 typedef struct ast_unary_s ast_unary;
46 typedef struct ast_return_s ast_return;
47 typedef struct ast_member_s ast_member;
68 #define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
70 /* Node interface with common components
72 typedef void ast_node_delete(ast_node*);
76 /* I don't feel comfortable using keywords like 'delete' as names... */
77 ast_node_delete *destroy;
79 /* keep: if a node contains this node, 'keep'
80 * prevents its dtor from destroying this node as well.
85 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
86 #define ast_unref(x) do \
88 if (! (((ast_node*)(x))->node.keep) ) { \
93 /* Expression interface
95 * Any expression or block returns an ir_value, and needs
96 * to know the current function.
98 typedef bool ast_expression_codegen(ast_expression*,
104 ast_node_common node;
105 ast_expression_codegen *codegen;
107 ast_expression *next;
108 MEM_VECTOR_MAKE(ast_value*, params);
109 /* The codegen functions should store their output values
110 * so we can call it multiple times without re-evaluating.
111 * Store lvalue and rvalue seperately though. So that
112 * ast_entfield for example can generate both if required.
116 } ast_expression_common;
117 MEM_VECTOR_PROTO(ast_expression_common, ast_value*, params);
121 * Types are also values, both have a type and a name.
122 * especially considering possible constructs like typedefs.
124 * is like creating a 'float foo', foo serving as the type's name.
128 ast_expression_common expression;
150 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
151 /* This will NOT delete an underlying ast_function */
152 void ast_value_delete(ast_value*);
154 bool ast_value_set_name(ast_value*, const char *name);
156 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
157 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
158 bool ast_global_codegen(ast_value *self, ir_builder *ir);
160 bool GMQCC_WARN ast_value_params_add(ast_value*, ast_value*);
164 * A value-returning binary expression.
168 ast_expression_common expression;
171 ast_expression *left;
172 ast_expression *right;
174 ast_binary* ast_binary_new(lex_ctx ctx,
176 ast_expression *left,
177 ast_expression *right);
178 void ast_binary_delete(ast_binary*);
180 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
184 * An assignment including a binary expression with the source as left operand.
185 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
187 struct ast_binstore_s
189 ast_expression_common expression;
193 ast_expression *dest;
194 ast_expression *source;
196 ast_binstore* ast_binstore_new(lex_ctx ctx,
199 ast_expression *left,
200 ast_expression *right);
201 void ast_binstore_delete(ast_binstore*);
203 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
207 * Regular unary expressions: not,neg
211 ast_expression_common expression;
214 ast_expression *operand;
216 ast_unary* ast_unary_new(lex_ctx ctx,
218 ast_expression *expr);
219 void ast_unary_delete(ast_unary*);
221 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
225 * Make sure 'return' only happens at the end of a block, otherwise the IR
226 * will refuse to create further instructions.
227 * This should be honored by the parser.
231 ast_expression_common expression;
232 ast_expression *operand;
234 ast_return* ast_return_new(lex_ctx ctx,
235 ast_expression *expr);
236 void ast_return_delete(ast_return*);
238 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
242 * This must do 2 things:
243 * -) Provide a way to fetch an entity field value. (Rvalue)
244 * -) Provide a pointer to an entity field. (Lvalue)
246 * In original QC, there's only a STORE via pointer, but
247 * no LOAD via pointer.
248 * So we must know beforehand if we are going to read or assign
250 * For this we will have to extend the codegen() functions with
251 * a flag saying whether or not we need an L or an R-value.
253 struct ast_entfield_s
255 ast_expression_common expression;
256 /* The entity can come from an expression of course. */
257 ast_expression *entity;
258 /* As can the field, it just must result in a value of TYPE_FIELD */
259 ast_expression *field;
261 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
262 void ast_entfield_delete(ast_entfield*);
264 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
268 * For now used for vectors. If we get structs or unions
269 * we can have them handled here as well.
273 ast_expression_common expression;
274 ast_expression *owner;
277 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field);
278 void ast_member_delete(ast_member*);
280 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
284 * Stores left<-right and returns left.
285 * Specialized binary expression node
289 ast_expression_common expression;
291 ast_expression *dest;
292 ast_expression *source;
294 ast_store* ast_store_new(lex_ctx ctx, int op,
295 ast_expression *d, ast_expression *s);
296 void ast_store_delete(ast_store*);
298 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
302 * A general 'if then else' statement, either side can be NULL and will
303 * thus be omitted. It is an error for *both* cases to be NULL at once.
305 * During its 'codegen' it'll be changing the ast_function's block.
307 * An if is also an "expression". Its codegen will put NULL into the
308 * output field though. For ternary expressions an ast_ternary will be
313 ast_expression_common expression;
314 ast_expression *cond;
315 /* It's all just 'expressions', since an ast_block is one too. */
316 ast_expression *on_true;
317 ast_expression *on_false;
319 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
320 void ast_ifthen_delete(ast_ifthen*);
322 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
324 /* Ternary expressions...
326 * Contrary to 'if-then-else' nodes, ternary expressions actually
327 * return a value, otherwise they behave the very same way.
328 * The difference in 'codegen' is that it'll return the value of
331 * The other difference is that in an ast_ternary, NEITHER side
332 * must be NULL, there's ALWAYS an else branch.
334 * This is the only ast_node beside ast_value which contains
335 * an ir_value. Theoretically we don't need to remember it though.
339 ast_expression_common expression;
340 ast_expression *cond;
341 /* It's all just 'expressions', since an ast_block is one too. */
342 ast_expression *on_true;
343 ast_expression *on_false;
344 /* After a ternary expression we find ourselves in a new IR block
345 * and start with a PHI node */
348 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
349 void ast_ternary_delete(ast_ternary*);
351 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
353 /* A general loop node
355 * For convenience it contains 4 parts:
356 * -) (ini) = initializing expression
357 * -) (pre) = pre-loop condition
358 * -) (pst) = post-loop condition
359 * -) (inc) = "increment" expression
360 * The following is a psudo-representation of this loop
361 * note that '=>' bears the logical meaning of "implies".
362 * (a => b) equals (!a || b)
365 while (has_pre => {pre})
369 continue: // a 'continue' will jump here
370 if (has_pst => {pst})
378 ast_expression_common expression;
379 ast_expression *initexpr;
380 ast_expression *precond;
381 ast_expression *postcond;
382 ast_expression *increment;
383 ast_expression *body;
385 ast_loop* ast_loop_new(lex_ctx ctx,
386 ast_expression *initexpr,
387 ast_expression *precond,
388 ast_expression *postcond,
389 ast_expression *increment,
390 ast_expression *body);
391 void ast_loop_delete(ast_loop*);
393 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
397 * Contains an ast_expression as target, rather than an ast_function/value.
398 * Since it's how QC works, every ast_function has an ast_value
399 * associated anyway - in other words, the VM contains function
400 * pointers for every function anyway. Thus, this node will call
402 * Additionally it contains a list of ast_expressions as parameters.
403 * Since calls can return values, an ast_call is also an ast_expression.
407 ast_expression_common expression;
408 ast_expression *func;
409 MEM_VECTOR_MAKE(ast_expression*, params);
411 ast_call* ast_call_new(lex_ctx ctx,
412 ast_expression *funcexpr);
413 void ast_call_delete(ast_call*);
414 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
416 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
423 ast_expression_common expression;
425 MEM_VECTOR_MAKE(ast_value*, locals);
426 MEM_VECTOR_MAKE(ast_expression*, exprs);
428 ast_block* ast_block_new(lex_ctx ctx);
429 void ast_block_delete(ast_block*);
430 bool ast_block_set_type(ast_block*, ast_expression *from);
432 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
433 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
435 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
439 * Contains a list of blocks... at least in theory.
440 * Usually there's just the main block, other blocks are inside that.
442 * Technically, functions don't need to be an AST node, since we have
443 * neither functions inside functions, nor lambdas, and function
444 * pointers could just work with a name. However, this way could be
445 * more flexible, and adds no real complexity.
447 struct ast_function_s
449 ast_node_common node;
456 ir_function *ir_func;
458 ir_block *breakblock;
459 ir_block *continueblock;
462 /* in order for thread safety - for the optional
463 * channel abesed multithreading... keeping a buffer
464 * here to use in ast_function_label.
468 MEM_VECTOR_MAKE(ast_block*, blocks);
470 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
471 /* This will NOT delete the underlying ast_value */
472 void ast_function_delete(ast_function*);
473 /* For "optimized" builds this can just keep returning "foo"...
476 const char* ast_function_label(ast_function*, const char *prefix);
478 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
480 bool ast_function_codegen(ast_function *self, ir_builder *builder);
484 union ast_expression_u
486 ast_expression_common expression;
494 ast_entfield entfield;
501 ast_node_common node;
502 ast_expression expression;