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 MEM_VECTOR_MAKE(ast_value*, params);
85 } ast_expression_common;
86 MEM_VECTOR_PROTO(ast_expression_common, ast_value*, params);
90 * Types are also values, both have a type and a name.
91 * especially considering possible constructs like typedefs.
93 * is like creating a 'float foo', foo serving as the type's name.
97 ast_expression_common expression;
119 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
120 /* This will NOT delete an underlying ast_function */
121 void ast_value_delete(ast_value*);
123 bool ast_value_set_name(ast_value*, const char *name);
125 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
126 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
127 bool ast_global_codegen(ast_value *self, ir_builder *ir);
129 bool GMQCC_WARN ast_value_params_add(ast_value*, ast_value*);
133 * A value-returning binary expression.
137 ast_expression_common expression;
140 ast_expression *left;
141 ast_expression *right;
143 ast_binary* ast_binary_new(lex_ctx ctx,
145 ast_expression *left,
146 ast_expression *right);
147 void ast_binary_delete(ast_binary*);
149 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
153 * Regular unary expressions: not,neg
157 ast_expression_common expression;
160 ast_expression *operand;
162 ast_unary* ast_unary_new(lex_ctx ctx,
164 ast_expression *expr);
165 void ast_unary_delete(ast_unary*);
167 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
171 * Make sure 'return' only happens at the end of a block, otherwise the IR
172 * will refuse to create further instructions.
173 * This should be honored by the parser.
177 ast_expression_common expression;
178 ast_expression *operand;
180 ast_return* ast_return_new(lex_ctx ctx,
181 ast_expression *expr);
182 void ast_return_delete(ast_return*);
184 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
188 * This must do 2 things:
189 * -) Provide a way to fetch an entity field value. (Rvalue)
190 * -) Provide a pointer to an entity field. (Lvalue)
192 * In original QC, there's only a STORE via pointer, but
193 * no LOAD via pointer.
194 * So we must know beforehand if we are going to read or assign
196 * For this we will have to extend the codegen() functions with
197 * a flag saying whether or not we need an L or an R-value.
199 struct ast_entfield_s
201 ast_expression_common expression;
202 /* The entity can come from an expression of course. */
203 ast_expression *entity;
204 /* As can the field, it just must result in a value of TYPE_FIELD */
205 ast_expression *field;
207 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
208 void ast_entfield_delete(ast_entfield*);
210 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
214 * Stores left<-right and returns left.
215 * Specialized binary expression node
219 ast_expression_common expression;
221 ast_value *dest; /* When we add pointers this might have to change to expression */
222 ast_expression *source;
224 ast_store* ast_store_new(lex_ctx ctx, int op,
225 ast_value *d, ast_expression *s);
226 void ast_store_delete(ast_store*);
228 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
232 * A general 'if then else' statement, either side can be NULL and will
233 * thus be omitted. It is an error for *both* cases to be NULL at once.
235 * During its 'codegen' it'll be changing the ast_function's block.
237 * An if is also an "expression". Its codegen will put NULL into the
238 * output field though. For ternary expressions an ast_ternary will be
243 ast_expression_common expression;
244 ast_expression *cond;
245 /* It's all just 'expressions', since an ast_block is one too. */
246 ast_expression *on_true;
247 ast_expression *on_false;
249 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
250 void ast_ifthen_delete(ast_ifthen*);
252 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
254 /* Ternary expressions...
256 * Contrary to 'if-then-else' nodes, ternary expressions actually
257 * return a value, otherwise they behave the very same way.
258 * The difference in 'codegen' is that it'll return the value of
261 * The other difference is that in an ast_ternary, NEITHER side
262 * must be NULL, there's ALWAYS an else branch.
264 * This is the only ast_node beside ast_value which contains
265 * an ir_value. Theoretically we don't need to remember it though.
269 ast_expression_common expression;
270 ast_expression *cond;
271 /* It's all just 'expressions', since an ast_block is one too. */
272 ast_expression *on_true;
273 ast_expression *on_false;
274 /* After a ternary expression we find ourselves in a new IR block
275 * and start with a PHI node */
278 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
279 void ast_ternary_delete(ast_ternary*);
281 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
283 /* A general loop node
285 * For convenience it contains 4 parts:
286 * -) (ini) = initializing expression
287 * -) (pre) = pre-loop condition
288 * -) (pst) = post-loop condition
289 * -) (inc) = "increment" expression
290 * The following is a psudo-representation of this loop
291 * note that '=>' bears the logical meaning of "implies".
292 * (a => b) equals (!a || b)
295 while (has_pre => {pre})
299 continue: // a 'continue' will jump here
300 if (has_pst => {pst})
308 ast_expression_common expression;
309 ast_expression *initexpr;
310 ast_expression *precond;
311 ast_expression *postcond;
312 ast_expression *increment;
313 ast_expression *body;
315 ast_loop* ast_loop_new(lex_ctx ctx,
316 ast_expression *initexpr,
317 ast_expression *precond,
318 ast_expression *postcond,
319 ast_expression *increment,
320 ast_expression *body);
321 void ast_loop_delete(ast_loop*);
323 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
327 * Contains an ast_expression as target, rather than an ast_function/value.
328 * Since it's how QC works, every ast_function has an ast_value
329 * associated anyway - in other words, the VM contains function
330 * pointers for every function anyway. Thus, this node will call
332 * Additionally it contains a list of ast_expressions as parameters.
333 * Since calls can return values, an ast_call is also an ast_expression.
337 ast_expression_common expression;
338 ast_expression *func;
339 MEM_VECTOR_MAKE(ast_expression*, params);
341 ast_call* ast_call_new(lex_ctx ctx,
342 ast_expression *funcexpr);
343 void ast_call_delete(ast_call*);
344 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
346 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
353 ast_expression_common expression;
355 MEM_VECTOR_MAKE(ast_value*, locals);
356 MEM_VECTOR_MAKE(ast_expression*, exprs);
358 ast_block* ast_block_new(lex_ctx ctx);
359 void ast_block_delete(ast_block*);
360 bool ast_block_set_type(ast_block*, ast_expression *from);
362 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
363 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
365 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
369 * Contains a list of blocks... at least in theory.
370 * Usually there's just the main block, other blocks are inside that.
372 * Technically, functions don't need to be an AST node, since we have
373 * neither functions inside functions, nor lambdas, and function
374 * pointers could just work with a name. However, this way could be
375 * more flexible, and adds no real complexity.
377 struct ast_function_s
379 ast_node_common node;
386 ir_function *ir_func;
388 ir_block *breakblock;
389 ir_block *continueblock;
392 /* in order for thread safety - for the optional
393 * channel abesed multithreading... keeping a buffer
394 * here to use in ast_function_label.
398 MEM_VECTOR_MAKE(ast_block*, blocks);
400 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
401 /* This will NOT delete the underlying ast_value */
402 void ast_function_delete(ast_function*);
403 /* For "optimized" builds this can just keep returning "foo"...
406 const char* ast_function_label(ast_function*, const char *prefix);
408 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
410 bool ast_function_codegen(ast_function *self, ir_builder *builder);
414 union ast_expression_u
416 ast_expression_common expression;
424 ast_entfield entfield;
431 ast_node_common node;
432 ast_expression expression;