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;
48 typedef struct ast_array_index_s ast_array_index;
49 typedef struct ast_breakcont_s ast_breakcont;
50 typedef struct ast_switch_s ast_switch;
74 #define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
75 #define ast_ctx(node) (((ast_node_common*)(node))->context)
77 /* Node interface with common components
79 typedef void ast_node_delete(ast_node*);
83 /* I don't feel comfortable using keywords like 'delete' as names... */
84 ast_node_delete *destroy;
86 /* keep: if a node contains this node, 'keep'
87 * prevents its dtor from destroying this node as well.
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*,
109 /* TODO: the codegen function should take an output-type parameter
110 * indicating whether a variable, type, label etc. is expected, and
112 * Then later an ast_ident could have a codegen using this to figure
113 * out what to look for.
114 * eg. in code which uses a not-yet defined variable, the expression
115 * would take an ast_ident, and the codegen would be called with
116 * type `expression`, so the ast_ident's codegen would search for
117 * variables through the environment (or functions, constants...).
121 ast_node_common node;
122 ast_expression_codegen *codegen;
124 ast_expression *next;
125 /* arrays get a member-count */
129 /* The codegen functions should store their output values
130 * so we can call it multiple times without re-evaluating.
131 * Store lvalue and rvalue seperately though. So that
132 * ast_entfield for example can generate both if required.
136 } ast_expression_common;
140 * Types are also values, both have a type and a name.
141 * especially considering possible constructs like typedefs.
143 * is like creating a 'float foo', foo serving as the type's name.
147 ast_expression_common expression;
166 /* usecount for the parser */
170 ir_value **ir_values;
171 size_t ir_value_count;
173 /* ONLY for arrays in progs version up to 6 */
178 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
179 ast_value* ast_value_copy(const ast_value *self);
180 /* This will NOT delete an underlying ast_function */
181 void ast_value_delete(ast_value*);
183 bool ast_value_set_name(ast_value*, const char *name);
185 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
186 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
187 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
189 void ast_value_params_add(ast_value*, ast_value*);
191 bool ast_compare_type(ast_expression *a, ast_expression *b);
192 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
193 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
194 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
195 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
199 * A value-returning binary expression.
203 ast_expression_common expression;
206 ast_expression *left;
207 ast_expression *right;
209 ast_binary* ast_binary_new(lex_ctx ctx,
211 ast_expression *left,
212 ast_expression *right);
213 void ast_binary_delete(ast_binary*);
215 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
219 * An assignment including a binary expression with the source as left operand.
220 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
222 struct ast_binstore_s
224 ast_expression_common expression;
228 ast_expression *dest;
229 ast_expression *source;
231 ast_binstore* ast_binstore_new(lex_ctx ctx,
234 ast_expression *left,
235 ast_expression *right);
236 void ast_binstore_delete(ast_binstore*);
238 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
242 * Regular unary expressions: not,neg
246 ast_expression_common expression;
249 ast_expression *operand;
251 ast_unary* ast_unary_new(lex_ctx ctx,
253 ast_expression *expr);
254 void ast_unary_delete(ast_unary*);
256 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
260 * Make sure 'return' only happens at the end of a block, otherwise the IR
261 * will refuse to create further instructions.
262 * This should be honored by the parser.
266 ast_expression_common expression;
267 ast_expression *operand;
269 ast_return* ast_return_new(lex_ctx ctx,
270 ast_expression *expr);
271 void ast_return_delete(ast_return*);
273 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
277 * This must do 2 things:
278 * -) Provide a way to fetch an entity field value. (Rvalue)
279 * -) Provide a pointer to an entity field. (Lvalue)
281 * In original QC, there's only a STORE via pointer, but
282 * no LOAD via pointer.
283 * So we must know beforehand if we are going to read or assign
285 * For this we will have to extend the codegen() functions with
286 * a flag saying whether or not we need an L or an R-value.
288 struct ast_entfield_s
290 ast_expression_common expression;
291 /* The entity can come from an expression of course. */
292 ast_expression *entity;
293 /* As can the field, it just must result in a value of TYPE_FIELD */
294 ast_expression *field;
296 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
297 ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
298 void ast_entfield_delete(ast_entfield*);
300 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
304 * For now used for vectors. If we get structs or unions
305 * we can have them handled here as well.
309 ast_expression_common expression;
310 ast_expression *owner;
313 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field);
314 void ast_member_delete(ast_member*);
316 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
318 /* Array index access:
320 * QC forces us to take special action on arrays:
321 * an ast_store on an ast_array_index must not codegen the index,
322 * but call its setter - unless we have an instruction set which supports
324 * Any other array index access will be codegened to a call to the getter.
325 * In any case, accessing an element via a compiletime-constant index will
326 * result in quick access to that variable.
328 struct ast_array_index_s
330 ast_expression_common expression;
331 ast_expression *array;
332 ast_expression *index;
334 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
335 void ast_array_index_delete(ast_array_index*);
337 bool ast_array_index_codegen(ast_array_index*, ast_function*, bool lvalue, ir_value**);
341 * Stores left<-right and returns left.
342 * Specialized binary expression node
346 ast_expression_common expression;
348 ast_expression *dest;
349 ast_expression *source;
351 ast_store* ast_store_new(lex_ctx ctx, int op,
352 ast_expression *d, ast_expression *s);
353 void ast_store_delete(ast_store*);
355 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
359 * A general 'if then else' statement, either side can be NULL and will
360 * thus be omitted. It is an error for *both* cases to be NULL at once.
362 * During its 'codegen' it'll be changing the ast_function's block.
364 * An if is also an "expression". Its codegen will put NULL into the
365 * output field though. For ternary expressions an ast_ternary will be
370 ast_expression_common expression;
371 ast_expression *cond;
372 /* It's all just 'expressions', since an ast_block is one too. */
373 ast_expression *on_true;
374 ast_expression *on_false;
376 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
377 void ast_ifthen_delete(ast_ifthen*);
379 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
381 /* Ternary expressions...
383 * Contrary to 'if-then-else' nodes, ternary expressions actually
384 * return a value, otherwise they behave the very same way.
385 * The difference in 'codegen' is that it'll return the value of
388 * The other difference is that in an ast_ternary, NEITHER side
389 * must be NULL, there's ALWAYS an else branch.
391 * This is the only ast_node beside ast_value which contains
392 * an ir_value. Theoretically we don't need to remember it though.
396 ast_expression_common expression;
397 ast_expression *cond;
398 /* It's all just 'expressions', since an ast_block is one too. */
399 ast_expression *on_true;
400 ast_expression *on_false;
402 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
403 void ast_ternary_delete(ast_ternary*);
405 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
407 /* A general loop node
409 * For convenience it contains 4 parts:
410 * -) (ini) = initializing expression
411 * -) (pre) = pre-loop condition
412 * -) (pst) = post-loop condition
413 * -) (inc) = "increment" expression
414 * The following is a psudo-representation of this loop
415 * note that '=>' bears the logical meaning of "implies".
416 * (a => b) equals (!a || b)
419 while (has_pre => {pre})
423 continue: // a 'continue' will jump here
424 if (has_pst => {pst})
432 ast_expression_common expression;
433 ast_expression *initexpr;
434 ast_expression *precond;
435 ast_expression *postcond;
436 ast_expression *increment;
437 ast_expression *body;
439 ast_loop* ast_loop_new(lex_ctx ctx,
440 ast_expression *initexpr,
441 ast_expression *precond,
442 ast_expression *postcond,
443 ast_expression *increment,
444 ast_expression *body);
445 void ast_loop_delete(ast_loop*);
447 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
451 struct ast_breakcont_s
453 ast_expression_common expression;
456 ast_breakcont* ast_breakcont_new(lex_ctx ctx, bool iscont);
457 void ast_breakcont_delete(ast_breakcont*);
459 bool ast_breakcont_codegen(ast_breakcont*, ast_function*, bool lvalue, ir_value**);
463 * A few notes about this: with the original QCVM, no real optimization
464 * is possible. The SWITCH instruction set isn't really helping a lot, since
465 * it only collapes the EQ and IF instructions into one.
466 * Note: Declaring local variables inside caseblocks is normal.
467 * Since we don't have to deal with a stack there's no unnatural behaviour to
468 * be expected from it.
472 ast_expression *value; /* #20 will replace this */
473 ast_expression *code;
477 ast_expression_common expression;
479 ast_expression *operand;
480 ast_switch_case *cases;
483 ast_switch* ast_switch_new(lex_ctx ctx, ast_expression *op);
484 void ast_switch_delete(ast_switch*);
486 bool ast_switch_codegen(ast_switch*, ast_function*, bool lvalue, ir_value**);
490 * Contains an ast_expression as target, rather than an ast_function/value.
491 * Since it's how QC works, every ast_function has an ast_value
492 * associated anyway - in other words, the VM contains function
493 * pointers for every function anyway. Thus, this node will call
495 * Additionally it contains a list of ast_expressions as parameters.
496 * Since calls can return values, an ast_call is also an ast_expression.
500 ast_expression_common expression;
501 ast_expression *func;
502 ast_expression* *params;
504 ast_call* ast_call_new(lex_ctx ctx,
505 ast_expression *funcexpr);
506 void ast_call_delete(ast_call*);
507 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
508 bool ast_call_check_types(ast_call*);
515 ast_expression_common expression;
518 ast_expression* *exprs;
519 ast_expression* *collect;
521 ast_block* ast_block_new(lex_ctx ctx);
522 void ast_block_delete(ast_block*);
523 bool ast_block_set_type(ast_block*, ast_expression *from);
525 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
526 void ast_block_collect(ast_block*, ast_expression*);
530 * Contains a list of blocks... at least in theory.
531 * Usually there's just the main block, other blocks are inside that.
533 * Technically, functions don't need to be an AST node, since we have
534 * neither functions inside functions, nor lambdas, and function
535 * pointers could just work with a name. However, this way could be
536 * more flexible, and adds no real complexity.
538 struct ast_function_s
540 ast_node_common node;
547 ir_function *ir_func;
549 ir_block *breakblock;
550 ir_block *continueblock;
553 /* In order for early-out logic not to go over
554 * excessive jumps, we remember their target
562 /* in order for thread safety - for the optional
563 * channel abesed multithreading... keeping a buffer
564 * here to use in ast_function_label.
570 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
571 /* This will NOT delete the underlying ast_value */
572 void ast_function_delete(ast_function*);
573 /* For "optimized" builds this can just keep returning "foo"...
576 const char* ast_function_label(ast_function*, const char *prefix);
578 bool ast_function_codegen(ast_function *self, ir_builder *builder);
582 union ast_expression_u
584 ast_expression_common expression;
592 ast_entfield entfield;
599 ast_node_common node;
600 ast_expression expression;