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;
46 typedef struct ast_member_s ast_member;
66 #define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
68 /* Node interface with common components
70 typedef void ast_node_delete(ast_node*);
74 /* I don't feel comfortable using keywords like 'delete' as names... */
75 ast_node_delete *destroy;
77 /* keep: if a node contains this node, 'keep'
78 * prevents its dtor from destroying this node as well.
83 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
84 #define ast_unref(x) do \
86 if (! (((ast_node*)(x))->node.keep) ) { \
91 /* Expression interface
93 * Any expression or block returns an ir_value, and needs
94 * to know the current function.
96 typedef bool ast_expression_codegen(ast_expression*,
102 ast_node_common node;
103 ast_expression_codegen *codegen;
105 ast_expression *next;
106 MEM_VECTOR_MAKE(ast_value*, params);
107 } ast_expression_common;
108 MEM_VECTOR_PROTO(ast_expression_common, ast_value*, params);
112 * Types are also values, both have a type and a name.
113 * especially considering possible constructs like typedefs.
115 * is like creating a 'float foo', foo serving as the type's name.
119 ast_expression_common expression;
143 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
144 /* This will NOT delete an underlying ast_function */
145 void ast_value_delete(ast_value*);
147 bool ast_value_set_name(ast_value*, const char *name);
149 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
150 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
151 bool ast_global_codegen(ast_value *self, ir_builder *ir);
153 bool GMQCC_WARN ast_value_params_add(ast_value*, ast_value*);
157 * A value-returning binary expression.
161 ast_expression_common expression;
164 ast_expression *left;
165 ast_expression *right;
167 ast_binary* ast_binary_new(lex_ctx ctx,
169 ast_expression *left,
170 ast_expression *right);
171 void ast_binary_delete(ast_binary*);
173 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
177 * Regular unary expressions: not,neg
181 ast_expression_common expression;
184 ast_expression *operand;
186 ast_unary* ast_unary_new(lex_ctx ctx,
188 ast_expression *expr);
189 void ast_unary_delete(ast_unary*);
191 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
195 * Make sure 'return' only happens at the end of a block, otherwise the IR
196 * will refuse to create further instructions.
197 * This should be honored by the parser.
201 ast_expression_common expression;
202 ast_expression *operand;
204 ast_return* ast_return_new(lex_ctx ctx,
205 ast_expression *expr);
206 void ast_return_delete(ast_return*);
208 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
212 * This must do 2 things:
213 * -) Provide a way to fetch an entity field value. (Rvalue)
214 * -) Provide a pointer to an entity field. (Lvalue)
216 * In original QC, there's only a STORE via pointer, but
217 * no LOAD via pointer.
218 * So we must know beforehand if we are going to read or assign
220 * For this we will have to extend the codegen() functions with
221 * a flag saying whether or not we need an L or an R-value.
223 struct ast_entfield_s
225 ast_expression_common expression;
226 /* The entity can come from an expression of course. */
227 ast_expression *entity;
228 /* As can the field, it just must result in a value of TYPE_FIELD */
229 ast_expression *field;
231 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
232 void ast_entfield_delete(ast_entfield*);
234 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
238 * For now used for vectors. If we get structs or unions
239 * we can have them handled here as well.
243 ast_expression_common expression;
244 ast_expression *owner;
247 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field);
248 void ast_member_delete(ast_member*);
250 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
254 * Stores left<-right and returns left.
255 * Specialized binary expression node
259 ast_expression_common expression;
261 ast_expression *dest;
262 ast_expression *source;
264 ast_store* ast_store_new(lex_ctx ctx, int op,
265 ast_expression *d, ast_expression *s);
266 void ast_store_delete(ast_store*);
268 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
272 * A general 'if then else' statement, either side can be NULL and will
273 * thus be omitted. It is an error for *both* cases to be NULL at once.
275 * During its 'codegen' it'll be changing the ast_function's block.
277 * An if is also an "expression". Its codegen will put NULL into the
278 * output field though. For ternary expressions an ast_ternary will be
283 ast_expression_common expression;
284 ast_expression *cond;
285 /* It's all just 'expressions', since an ast_block is one too. */
286 ast_expression *on_true;
287 ast_expression *on_false;
289 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
290 void ast_ifthen_delete(ast_ifthen*);
292 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
294 /* Ternary expressions...
296 * Contrary to 'if-then-else' nodes, ternary expressions actually
297 * return a value, otherwise they behave the very same way.
298 * The difference in 'codegen' is that it'll return the value of
301 * The other difference is that in an ast_ternary, NEITHER side
302 * must be NULL, there's ALWAYS an else branch.
304 * This is the only ast_node beside ast_value which contains
305 * an ir_value. Theoretically we don't need to remember it though.
309 ast_expression_common expression;
310 ast_expression *cond;
311 /* It's all just 'expressions', since an ast_block is one too. */
312 ast_expression *on_true;
313 ast_expression *on_false;
314 /* After a ternary expression we find ourselves in a new IR block
315 * and start with a PHI node */
318 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
319 void ast_ternary_delete(ast_ternary*);
321 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
323 /* A general loop node
325 * For convenience it contains 4 parts:
326 * -) (ini) = initializing expression
327 * -) (pre) = pre-loop condition
328 * -) (pst) = post-loop condition
329 * -) (inc) = "increment" expression
330 * The following is a psudo-representation of this loop
331 * note that '=>' bears the logical meaning of "implies".
332 * (a => b) equals (!a || b)
335 while (has_pre => {pre})
339 continue: // a 'continue' will jump here
340 if (has_pst => {pst})
348 ast_expression_common expression;
349 ast_expression *initexpr;
350 ast_expression *precond;
351 ast_expression *postcond;
352 ast_expression *increment;
353 ast_expression *body;
355 ast_loop* ast_loop_new(lex_ctx ctx,
356 ast_expression *initexpr,
357 ast_expression *precond,
358 ast_expression *postcond,
359 ast_expression *increment,
360 ast_expression *body);
361 void ast_loop_delete(ast_loop*);
363 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
367 * Contains an ast_expression as target, rather than an ast_function/value.
368 * Since it's how QC works, every ast_function has an ast_value
369 * associated anyway - in other words, the VM contains function
370 * pointers for every function anyway. Thus, this node will call
372 * Additionally it contains a list of ast_expressions as parameters.
373 * Since calls can return values, an ast_call is also an ast_expression.
377 ast_expression_common expression;
378 ast_expression *func;
379 MEM_VECTOR_MAKE(ast_expression*, params);
381 ast_call* ast_call_new(lex_ctx ctx,
382 ast_expression *funcexpr);
383 void ast_call_delete(ast_call*);
384 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
386 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
393 ast_expression_common expression;
395 MEM_VECTOR_MAKE(ast_value*, locals);
396 MEM_VECTOR_MAKE(ast_expression*, exprs);
398 ast_block* ast_block_new(lex_ctx ctx);
399 void ast_block_delete(ast_block*);
400 bool ast_block_set_type(ast_block*, ast_expression *from);
402 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
403 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
405 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
409 * Contains a list of blocks... at least in theory.
410 * Usually there's just the main block, other blocks are inside that.
412 * Technically, functions don't need to be an AST node, since we have
413 * neither functions inside functions, nor lambdas, and function
414 * pointers could just work with a name. However, this way could be
415 * more flexible, and adds no real complexity.
417 struct ast_function_s
419 ast_node_common node;
426 ir_function *ir_func;
428 ir_block *breakblock;
429 ir_block *continueblock;
432 /* in order for thread safety - for the optional
433 * channel abesed multithreading... keeping a buffer
434 * here to use in ast_function_label.
438 MEM_VECTOR_MAKE(ast_block*, blocks);
440 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
441 /* This will NOT delete the underlying ast_value */
442 void ast_function_delete(ast_function*);
443 /* For "optimized" builds this can just keep returning "foo"...
446 const char* ast_function_label(ast_function*, const char *prefix);
448 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
450 bool ast_function_codegen(ast_function *self, ir_builder *builder);
454 union ast_expression_u
456 ast_expression_common expression;
464 ast_entfield entfield;
471 ast_node_common node;
472 ast_expression expression;