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;
116 /* if vtype is qc_function, params contain parameters, and
117 * 'next' the return type.
119 MEM_VECTOR_MAKE(ast_value*, params);
121 MEM_VECTOR_PROTO(ast_value, ast_value*, params);
123 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
124 /* This will NOT delete an underlying ast_function */
125 void ast_value_delete(ast_value*);
127 bool ast_value_set_name(ast_value*, const char *name);
129 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
130 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
131 bool ast_global_codegen(ast_value *self, ir_builder *ir);
135 * A value-returning binary expression.
139 ast_expression_common expression;
142 ast_expression *left;
143 ast_expression *right;
145 ast_binary* ast_binary_new(lex_ctx ctx,
147 ast_expression *left,
148 ast_expression *right);
149 void ast_binary_delete(ast_binary*);
151 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
155 * Regular unary expressions: not,neg
159 ast_expression_common expression;
162 ast_expression *operand;
164 ast_unary* ast_unary_new(lex_ctx ctx,
166 ast_expression *expr);
167 void ast_unary_delete(ast_unary*);
169 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
173 * Make sure 'return' only happens at the end of a block, otherwise the IR
174 * will refuse to create further instructions.
175 * This should be honored by the parser.
179 ast_expression_common expression;
180 ast_expression *operand;
182 ast_return* ast_return_new(lex_ctx ctx,
183 ast_expression *expr);
184 void ast_return_delete(ast_return*);
186 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
190 * This must do 2 things:
191 * -) Provide a way to fetch an entity field value. (Rvalue)
192 * -) Provide a pointer to an entity field. (Lvalue)
194 * In original QC, there's only a STORE via pointer, but
195 * no LOAD via pointer.
196 * So we must know beforehand if we are going to read or assign
198 * For this we will have to extend the codegen() functions with
199 * a flag saying whether or not we need an L or an R-value.
201 struct ast_entfield_s
203 ast_expression_common expression;
204 /* The entity can come from an expression of course. */
205 ast_expression *entity;
206 /* As can the field, it just must result in a value of TYPE_FIELD */
207 ast_expression *field;
209 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
210 void ast_entfield_delete(ast_entfield*);
212 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
216 * Stores left<-right and returns left.
217 * Specialized binary expression node
221 ast_expression_common expression;
223 ast_value *dest; /* When we add pointers this might have to change to expression */
224 ast_expression *source;
226 ast_store* ast_store_new(lex_ctx ctx, int op,
227 ast_value *d, ast_expression *s);
228 void ast_store_delete(ast_store*);
230 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
234 * A general 'if then else' statement, either side can be NULL and will
235 * thus be omitted. It is an error for *both* cases to be NULL at once.
237 * During its 'codegen' it'll be changing the ast_function's block.
239 * An if is also an "expression". Its codegen will put NULL into the
240 * output field though. For ternary expressions an ast_ternary will be
245 ast_expression_common expression;
246 ast_expression *cond;
247 /* It's all just 'expressions', since an ast_block is one too. */
248 ast_expression *on_true;
249 ast_expression *on_false;
251 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
252 void ast_ifthen_delete(ast_ifthen*);
254 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
256 /* Ternary expressions...
258 * Contrary to 'if-then-else' nodes, ternary expressions actually
259 * return a value, otherwise they behave the very same way.
260 * The difference in 'codegen' is that it'll return the value of
263 * The other difference is that in an ast_ternary, NEITHER side
264 * must be NULL, there's ALWAYS an else branch.
266 * This is the only ast_node beside ast_value which contains
267 * an ir_value. Theoretically we don't need to remember it though.
271 ast_expression_common expression;
272 ast_expression *cond;
273 /* It's all just 'expressions', since an ast_block is one too. */
274 ast_expression *on_true;
275 ast_expression *on_false;
276 /* After a ternary expression we find ourselves in a new IR block
277 * and start with a PHI node */
280 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
281 void ast_ternary_delete(ast_ternary*);
283 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
285 /* A general loop node
287 * For convenience it contains 4 parts:
288 * -) (ini) = initializing expression
289 * -) (pre) = pre-loop condition
290 * -) (pst) = post-loop condition
291 * -) (inc) = "increment" expression
292 * The following is a psudo-representation of this loop
293 * note that '=>' bears the logical meaning of "implies".
294 * (a => b) equals (!a || b)
297 while (has_pre => {pre})
301 continue: // a 'continue' will jump here
302 if (has_pst => {pst})
310 ast_expression_common expression;
311 ast_expression *initexpr;
312 ast_expression *precond;
313 ast_expression *postcond;
314 ast_expression *increment;
315 ast_expression *body;
317 ast_loop* ast_loop_new(lex_ctx ctx,
318 ast_expression *initexpr,
319 ast_expression *precond,
320 ast_expression *postcond,
321 ast_expression *increment,
322 ast_expression *body);
323 void ast_loop_delete(ast_loop*);
325 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
329 * Contains an ast_expression as target, rather than an ast_function/value.
330 * Since it's how QC works, every ast_function has an ast_value
331 * associated anyway - in other words, the VM contains function
332 * pointers for every function anyway. Thus, this node will call
334 * Additionally it contains a list of ast_expressions as parameters.
335 * Since calls can return values, an ast_call is also an ast_expression.
339 ast_expression_common expression;
340 ast_expression *func;
341 MEM_VECTOR_MAKE(ast_expression*, params);
343 ast_call* ast_call_new(lex_ctx ctx,
344 ast_expression *funcexpr);
345 void ast_call_delete(ast_call*);
346 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
348 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
355 ast_expression_common expression;
357 MEM_VECTOR_MAKE(ast_value*, locals);
358 MEM_VECTOR_MAKE(ast_expression*, exprs);
360 ast_block* ast_block_new(lex_ctx ctx);
361 void ast_block_delete(ast_block*);
362 bool ast_block_set_type(ast_block*, ast_expression *from);
364 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
365 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
367 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
371 * Contains a list of blocks... at least in theory.
372 * Usually there's just the main block, other blocks are inside that.
374 * Technically, functions don't need to be an AST node, since we have
375 * neither functions inside functions, nor lambdas, and function
376 * pointers could just work with a name. However, this way could be
377 * more flexible, and adds no real complexity.
379 struct ast_function_s
381 ast_node_common node;
388 ir_function *ir_func;
390 ir_block *breakblock;
391 ir_block *continueblock;
394 /* in order for thread safety - for the optional
395 * channel abesed multithreading... keeping a buffer
396 * here to use in ast_function_label.
400 MEM_VECTOR_MAKE(ast_block*, blocks);
402 /* contrary to the params in ast_value, these are the parameter variables
403 * which are to be used in expressions.
404 * The ast_value for the function contains only the parameter types used
405 * to generate ast_calls, and ast_call contains the parameter values
409 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
410 /* This will NOT delete the underlying ast_value */
411 void ast_function_delete(ast_function*);
412 /* For "optimized" builds this can just keep returning "foo"...
415 const char* ast_function_label(ast_function*, const char *prefix);
417 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
419 bool ast_function_codegen(ast_function *self, ir_builder *builder);
423 union ast_expression_u
425 ast_expression_common expression;
433 ast_entfield entfield;
440 ast_node_common node;
441 ast_expression expression;