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)
76 #define ast_side_effects(node) (((ast_node_common*)(node))->side_effects)
78 /* Node interface with common components
80 typedef void ast_node_delete(ast_node*);
84 /* I don't feel comfortable using keywords like 'delete' as names... */
85 ast_node_delete *destroy;
87 /* keep: if a node contains this node, 'keep'
88 * prevents its dtor from destroying this node as well.
94 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
95 #define ast_unref(x) do \
97 if (! (((ast_node*)(x))->node.keep) ) { \
102 /* Expression interface
104 * Any expression or block returns an ir_value, and needs
105 * to know the current function.
107 typedef bool ast_expression_codegen(ast_expression*,
111 /* TODO: the codegen function should take an output-type parameter
112 * indicating whether a variable, type, label etc. is expected, and
114 * Then later an ast_ident could have a codegen using this to figure
115 * out what to look for.
116 * eg. in code which uses a not-yet defined variable, the expression
117 * would take an ast_ident, and the codegen would be called with
118 * type `expression`, so the ast_ident's codegen would search for
119 * variables through the environment (or functions, constants...).
123 ast_node_common node;
124 ast_expression_codegen *codegen;
126 ast_expression *next;
127 /* arrays get a member-count */
131 /* The codegen functions should store their output values
132 * so we can call it multiple times without re-evaluating.
133 * Store lvalue and rvalue seperately though. So that
134 * ast_entfield for example can generate both if required.
138 } ast_expression_common;
142 * Types are also values, both have a type and a name.
143 * especially considering possible constructs like typedefs.
145 * is like creating a 'float foo', foo serving as the type's name.
149 ast_expression_common expression;
169 /* usecount for the parser */
173 ir_value **ir_values;
174 size_t ir_value_count;
176 /* ONLY for arrays in progs version up to 6 */
181 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
182 ast_value* ast_value_copy(const ast_value *self);
183 /* This will NOT delete an underlying ast_function */
184 void ast_value_delete(ast_value*);
186 bool ast_value_set_name(ast_value*, const char *name);
188 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
189 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
190 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
192 void ast_value_params_add(ast_value*, ast_value*);
194 bool ast_compare_type(ast_expression *a, ast_expression *b);
195 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
196 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
197 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
198 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
202 * A value-returning binary expression.
206 ast_expression_common expression;
209 ast_expression *left;
210 ast_expression *right;
212 ast_binary* ast_binary_new(lex_ctx ctx,
214 ast_expression *left,
215 ast_expression *right);
216 void ast_binary_delete(ast_binary*);
218 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
222 * An assignment including a binary expression with the source as left operand.
223 * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
225 struct ast_binstore_s
227 ast_expression_common expression;
231 ast_expression *dest;
232 ast_expression *source;
234 ast_binstore* ast_binstore_new(lex_ctx ctx,
237 ast_expression *left,
238 ast_expression *right);
239 void ast_binstore_delete(ast_binstore*);
241 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
245 * Regular unary expressions: not,neg
249 ast_expression_common expression;
252 ast_expression *operand;
254 ast_unary* ast_unary_new(lex_ctx ctx,
256 ast_expression *expr);
257 void ast_unary_delete(ast_unary*);
259 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
263 * Make sure 'return' only happens at the end of a block, otherwise the IR
264 * will refuse to create further instructions.
265 * This should be honored by the parser.
269 ast_expression_common expression;
270 ast_expression *operand;
272 ast_return* ast_return_new(lex_ctx ctx,
273 ast_expression *expr);
274 void ast_return_delete(ast_return*);
276 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
280 * This must do 2 things:
281 * -) Provide a way to fetch an entity field value. (Rvalue)
282 * -) Provide a pointer to an entity field. (Lvalue)
284 * In original QC, there's only a STORE via pointer, but
285 * no LOAD via pointer.
286 * So we must know beforehand if we are going to read or assign
288 * For this we will have to extend the codegen() functions with
289 * a flag saying whether or not we need an L or an R-value.
291 struct ast_entfield_s
293 ast_expression_common expression;
294 /* The entity can come from an expression of course. */
295 ast_expression *entity;
296 /* As can the field, it just must result in a value of TYPE_FIELD */
297 ast_expression *field;
299 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
300 ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
301 void ast_entfield_delete(ast_entfield*);
303 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
307 * For now used for vectors. If we get structs or unions
308 * we can have them handled here as well.
312 ast_expression_common expression;
313 ast_expression *owner;
317 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field, const char *name);
318 void ast_member_delete(ast_member*);
320 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
322 /* Array index access:
324 * QC forces us to take special action on arrays:
325 * an ast_store on an ast_array_index must not codegen the index,
326 * but call its setter - unless we have an instruction set which supports
328 * Any other array index access will be codegened to a call to the getter.
329 * In any case, accessing an element via a compiletime-constant index will
330 * result in quick access to that variable.
332 struct ast_array_index_s
334 ast_expression_common expression;
335 ast_expression *array;
336 ast_expression *index;
338 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
339 void ast_array_index_delete(ast_array_index*);
341 bool ast_array_index_codegen(ast_array_index*, ast_function*, bool lvalue, ir_value**);
345 * Stores left<-right and returns left.
346 * Specialized binary expression node
350 ast_expression_common expression;
352 ast_expression *dest;
353 ast_expression *source;
355 ast_store* ast_store_new(lex_ctx ctx, int op,
356 ast_expression *d, ast_expression *s);
357 void ast_store_delete(ast_store*);
359 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
363 * A general 'if then else' statement, either side can be NULL and will
364 * thus be omitted. It is an error for *both* cases to be NULL at once.
366 * During its 'codegen' it'll be changing the ast_function's block.
368 * An if is also an "expression". Its codegen will put NULL into the
369 * output field though. For ternary expressions an ast_ternary will be
374 ast_expression_common expression;
375 ast_expression *cond;
376 /* It's all just 'expressions', since an ast_block is one too. */
377 ast_expression *on_true;
378 ast_expression *on_false;
380 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
381 void ast_ifthen_delete(ast_ifthen*);
383 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
385 /* Ternary expressions...
387 * Contrary to 'if-then-else' nodes, ternary expressions actually
388 * return a value, otherwise they behave the very same way.
389 * The difference in 'codegen' is that it'll return the value of
392 * The other difference is that in an ast_ternary, NEITHER side
393 * must be NULL, there's ALWAYS an else branch.
395 * This is the only ast_node beside ast_value which contains
396 * an ir_value. Theoretically we don't need to remember it though.
400 ast_expression_common expression;
401 ast_expression *cond;
402 /* It's all just 'expressions', since an ast_block is one too. */
403 ast_expression *on_true;
404 ast_expression *on_false;
406 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
407 void ast_ternary_delete(ast_ternary*);
409 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
411 /* A general loop node
413 * For convenience it contains 4 parts:
414 * -) (ini) = initializing expression
415 * -) (pre) = pre-loop condition
416 * -) (pst) = post-loop condition
417 * -) (inc) = "increment" expression
418 * The following is a psudo-representation of this loop
419 * note that '=>' bears the logical meaning of "implies".
420 * (a => b) equals (!a || b)
423 while (has_pre => {pre})
427 continue: // a 'continue' will jump here
428 if (has_pst => {pst})
436 ast_expression_common expression;
437 ast_expression *initexpr;
438 ast_expression *precond;
439 ast_expression *postcond;
440 ast_expression *increment;
441 ast_expression *body;
443 ast_loop* ast_loop_new(lex_ctx ctx,
444 ast_expression *initexpr,
445 ast_expression *precond,
446 ast_expression *postcond,
447 ast_expression *increment,
448 ast_expression *body);
449 void ast_loop_delete(ast_loop*);
451 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
455 struct ast_breakcont_s
457 ast_expression_common expression;
460 ast_breakcont* ast_breakcont_new(lex_ctx ctx, bool iscont);
461 void ast_breakcont_delete(ast_breakcont*);
463 bool ast_breakcont_codegen(ast_breakcont*, ast_function*, bool lvalue, ir_value**);
467 * A few notes about this: with the original QCVM, no real optimization
468 * is possible. The SWITCH instruction set isn't really helping a lot, since
469 * it only collapes the EQ and IF instructions into one.
470 * Note: Declaring local variables inside caseblocks is normal.
471 * Since we don't have to deal with a stack there's no unnatural behaviour to
472 * be expected from it.
476 ast_expression *value; /* #20 will replace this */
477 ast_expression *code;
481 ast_expression_common expression;
483 ast_expression *operand;
484 ast_switch_case *cases;
487 ast_switch* ast_switch_new(lex_ctx ctx, ast_expression *op);
488 void ast_switch_delete(ast_switch*);
490 bool ast_switch_codegen(ast_switch*, ast_function*, bool lvalue, ir_value**);
494 * Contains an ast_expression as target, rather than an ast_function/value.
495 * Since it's how QC works, every ast_function has an ast_value
496 * associated anyway - in other words, the VM contains function
497 * pointers for every function anyway. Thus, this node will call
499 * Additionally it contains a list of ast_expressions as parameters.
500 * Since calls can return values, an ast_call is also an ast_expression.
504 ast_expression_common expression;
505 ast_expression *func;
506 ast_expression* *params;
508 ast_call* ast_call_new(lex_ctx ctx,
509 ast_expression *funcexpr);
510 void ast_call_delete(ast_call*);
511 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
512 bool ast_call_check_types(ast_call*);
519 ast_expression_common expression;
522 ast_expression* *exprs;
523 ast_expression* *collect;
525 ast_block* ast_block_new(lex_ctx ctx);
526 void ast_block_delete(ast_block*);
527 bool ast_block_set_type(ast_block*, ast_expression *from);
529 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
530 void ast_block_collect(ast_block*, ast_expression*);
532 void ast_block_add_expr(ast_block*, ast_expression*);
536 * Contains a list of blocks... at least in theory.
537 * Usually there's just the main block, other blocks are inside that.
539 * Technically, functions don't need to be an AST node, since we have
540 * neither functions inside functions, nor lambdas, and function
541 * pointers could just work with a name. However, this way could be
542 * more flexible, and adds no real complexity.
544 struct ast_function_s
546 ast_node_common node;
553 ir_function *ir_func;
555 ir_block *breakblock;
556 ir_block *continueblock;
559 /* In order for early-out logic not to go over
560 * excessive jumps, we remember their target
568 /* in order for thread safety - for the optional
569 * channel abesed multithreading... keeping a buffer
570 * here to use in ast_function_label.
576 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
577 /* This will NOT delete the underlying ast_value */
578 void ast_function_delete(ast_function*);
579 /* For "optimized" builds this can just keep returning "foo"...
582 const char* ast_function_label(ast_function*, const char *prefix);
584 bool ast_function_codegen(ast_function *self, ir_builder *builder);
588 union ast_expression_u
590 ast_expression_common expression;
598 ast_entfield entfield;
605 ast_node_common node;
606 ast_expression expression;