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) )
69 #define ast_ctx(node) (((ast_node_common*)(node))->context)
71 /* Node interface with common components
73 typedef void ast_node_delete(ast_node*);
77 /* I don't feel comfortable using keywords like 'delete' as names... */
78 ast_node_delete *destroy;
80 /* keep: if a node contains this node, 'keep'
81 * prevents its dtor from destroying this node as well.
84 /* usecount - so we can delete unused _x,_y and _z nodes... */
88 #define ast_use(n) ((ast_node*)(n))->node.uses++
89 #define ast_unuse(n) ((ast_node*)(n))->node.uses--
90 #define ast_usecount(n) (((ast_node*)(n))->node.uses)
92 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
93 #define ast_unref(x) do \
95 if (! (((ast_node*)(x))->node.keep) ) { \
100 /* Expression interface
102 * Any expression or block returns an ir_value, and needs
103 * to know the current function.
105 typedef bool ast_expression_codegen(ast_expression*,
111 ast_node_common node;
112 ast_expression_codegen *codegen;
114 ast_expression *next;
115 MEM_VECTOR_MAKE(ast_value*, params);
116 /* The codegen functions should store their output values
117 * so we can call it multiple times without re-evaluating.
118 * Store lvalue and rvalue seperately though. So that
119 * ast_entfield for example can generate both if required.
123 } ast_expression_common;
124 MEM_VECTOR_PROTO(ast_expression_common, ast_value*, params);
128 * Types are also values, both have a type and a name.
129 * especially considering possible constructs like typedefs.
131 * is like creating a 'float foo', foo serving as the type's name.
135 ast_expression_common expression;
157 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
158 /* This will NOT delete an underlying ast_function */
159 void ast_value_delete(ast_value*);
161 bool ast_value_set_name(ast_value*, const char *name);
163 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
164 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
165 bool ast_global_codegen(ast_value *self, ir_builder *ir);
167 bool GMQCC_WARN ast_value_params_add(ast_value*, ast_value*);
169 bool ast_compare_type(ast_expression *a, ast_expression *b);
173 * A value-returning binary expression.
177 ast_expression_common expression;
180 ast_expression *left;
181 ast_expression *right;
183 ast_binary* ast_binary_new(lex_ctx ctx,
185 ast_expression *left,
186 ast_expression *right);
187 void ast_binary_delete(ast_binary*);
189 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
193 * An assignment including a binary expression with the source as left operand.
194 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
196 struct ast_binstore_s
198 ast_expression_common expression;
202 ast_expression *dest;
203 ast_expression *source;
205 ast_binstore* ast_binstore_new(lex_ctx ctx,
208 ast_expression *left,
209 ast_expression *right);
210 void ast_binstore_delete(ast_binstore*);
212 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
216 * Regular unary expressions: not,neg
220 ast_expression_common expression;
223 ast_expression *operand;
225 ast_unary* ast_unary_new(lex_ctx ctx,
227 ast_expression *expr);
228 void ast_unary_delete(ast_unary*);
230 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
234 * Make sure 'return' only happens at the end of a block, otherwise the IR
235 * will refuse to create further instructions.
236 * This should be honored by the parser.
240 ast_expression_common expression;
241 ast_expression *operand;
243 ast_return* ast_return_new(lex_ctx ctx,
244 ast_expression *expr);
245 void ast_return_delete(ast_return*);
247 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
251 * This must do 2 things:
252 * -) Provide a way to fetch an entity field value. (Rvalue)
253 * -) Provide a pointer to an entity field. (Lvalue)
255 * In original QC, there's only a STORE via pointer, but
256 * no LOAD via pointer.
257 * So we must know beforehand if we are going to read or assign
259 * For this we will have to extend the codegen() functions with
260 * a flag saying whether or not we need an L or an R-value.
262 struct ast_entfield_s
264 ast_expression_common expression;
265 /* The entity can come from an expression of course. */
266 ast_expression *entity;
267 /* As can the field, it just must result in a value of TYPE_FIELD */
268 ast_expression *field;
270 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
271 void ast_entfield_delete(ast_entfield*);
273 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
277 * For now used for vectors. If we get structs or unions
278 * we can have them handled here as well.
282 ast_expression_common expression;
283 ast_expression *owner;
286 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field);
287 void ast_member_delete(ast_member*);
289 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
293 * Stores left<-right and returns left.
294 * Specialized binary expression node
298 ast_expression_common expression;
300 ast_expression *dest;
301 ast_expression *source;
303 ast_store* ast_store_new(lex_ctx ctx, int op,
304 ast_expression *d, ast_expression *s);
305 void ast_store_delete(ast_store*);
307 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
311 * A general 'if then else' statement, either side can be NULL and will
312 * thus be omitted. It is an error for *both* cases to be NULL at once.
314 * During its 'codegen' it'll be changing the ast_function's block.
316 * An if is also an "expression". Its codegen will put NULL into the
317 * output field though. For ternary expressions an ast_ternary will be
322 ast_expression_common expression;
323 ast_expression *cond;
324 /* It's all just 'expressions', since an ast_block is one too. */
325 ast_expression *on_true;
326 ast_expression *on_false;
328 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
329 void ast_ifthen_delete(ast_ifthen*);
331 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
333 /* Ternary expressions...
335 * Contrary to 'if-then-else' nodes, ternary expressions actually
336 * return a value, otherwise they behave the very same way.
337 * The difference in 'codegen' is that it'll return the value of
340 * The other difference is that in an ast_ternary, NEITHER side
341 * must be NULL, there's ALWAYS an else branch.
343 * This is the only ast_node beside ast_value which contains
344 * an ir_value. Theoretically we don't need to remember it though.
348 ast_expression_common expression;
349 ast_expression *cond;
350 /* It's all just 'expressions', since an ast_block is one too. */
351 ast_expression *on_true;
352 ast_expression *on_false;
353 /* After a ternary expression we find ourselves in a new IR block
354 * and start with a PHI node */
357 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
358 void ast_ternary_delete(ast_ternary*);
360 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
362 /* A general loop node
364 * For convenience it contains 4 parts:
365 * -) (ini) = initializing expression
366 * -) (pre) = pre-loop condition
367 * -) (pst) = post-loop condition
368 * -) (inc) = "increment" expression
369 * The following is a psudo-representation of this loop
370 * note that '=>' bears the logical meaning of "implies".
371 * (a => b) equals (!a || b)
374 while (has_pre => {pre})
378 continue: // a 'continue' will jump here
379 if (has_pst => {pst})
387 ast_expression_common expression;
388 ast_expression *initexpr;
389 ast_expression *precond;
390 ast_expression *postcond;
391 ast_expression *increment;
392 ast_expression *body;
394 ast_loop* ast_loop_new(lex_ctx ctx,
395 ast_expression *initexpr,
396 ast_expression *precond,
397 ast_expression *postcond,
398 ast_expression *increment,
399 ast_expression *body);
400 void ast_loop_delete(ast_loop*);
402 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
406 * Contains an ast_expression as target, rather than an ast_function/value.
407 * Since it's how QC works, every ast_function has an ast_value
408 * associated anyway - in other words, the VM contains function
409 * pointers for every function anyway. Thus, this node will call
411 * Additionally it contains a list of ast_expressions as parameters.
412 * Since calls can return values, an ast_call is also an ast_expression.
416 ast_expression_common expression;
417 ast_expression *func;
418 MEM_VECTOR_MAKE(ast_expression*, params);
420 ast_call* ast_call_new(lex_ctx ctx,
421 ast_expression *funcexpr);
422 void ast_call_delete(ast_call*);
423 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
425 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
427 bool ast_call_add_param(ast_call*, ast_expression*);
434 ast_expression_common expression;
436 MEM_VECTOR_MAKE(ast_value*, locals);
437 MEM_VECTOR_MAKE(ast_expression*, exprs);
439 ast_block* ast_block_new(lex_ctx ctx);
440 void ast_block_delete(ast_block*);
441 bool ast_block_set_type(ast_block*, ast_expression *from);
443 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
444 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
446 bool ast_block_add_expr(ast_block*, ast_expression *expr);
448 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
452 * Contains a list of blocks... at least in theory.
453 * Usually there's just the main block, other blocks are inside that.
455 * Technically, functions don't need to be an AST node, since we have
456 * neither functions inside functions, nor lambdas, and function
457 * pointers could just work with a name. However, this way could be
458 * more flexible, and adds no real complexity.
460 struct ast_function_s
462 ast_node_common node;
469 ir_function *ir_func;
471 ir_block *breakblock;
472 ir_block *continueblock;
475 /* in order for thread safety - for the optional
476 * channel abesed multithreading... keeping a buffer
477 * here to use in ast_function_label.
481 MEM_VECTOR_MAKE(ast_block*, blocks);
483 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
484 /* This will NOT delete the underlying ast_value */
485 void ast_function_delete(ast_function*);
486 /* For "optimized" builds this can just keep returning "foo"...
489 const char* ast_function_label(ast_function*, const char *prefix);
491 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
493 bool ast_function_codegen(ast_function *self, ir_builder *builder);
497 union ast_expression_u
499 ast_expression_common expression;
507 ast_entfield entfield;
514 ast_node_common node;
515 ast_expression expression;