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;
43 /* Node interface with common components
45 typedef void ast_node_delete(ast_node*);
49 /* I don't feel comfortable using keywords like 'delete' as names... */
50 ast_node_delete *destroy;
51 /* keep: if a node contains this node, 'keep'
52 * prevents its dtor from destroying this node as well.
57 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
58 #define ast_unref(x) do \
60 if (! (((ast_node*)(x))->node.keep) ) { \
65 /* Expression interface
67 * Any expression or block returns an ir_value, and needs
68 * to know the current function.
70 typedef bool ast_expression_codegen(ast_expression*,
77 ast_expression_codegen *codegen;
78 } ast_expression_common;
82 * Types are also values, both have a type and a name.
83 * especially considering possible constructs like typedefs.
85 * is like creating a 'float foo', foo serving as the type's name.
89 ast_expression_common expression;
108 /* if vtype is qc_function, params contain parameters, and
109 * 'next' the return type.
111 MEM_VECTOR_MAKE(ast_value*, params);
113 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
114 /* This will NOT delete an underlying ast_function */
115 void ast_value_delete(ast_value*);
117 bool ast_value_set_name(ast_value*, const char *name);
119 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
120 bool ast_local_codegen(ast_value *self, ir_function *func);
121 bool ast_global_codegen(ast_value *self, ir_builder *ir);
125 * A value-returning binary expression.
129 ast_expression_common expression;
132 ast_expression *left;
133 ast_expression *right;
135 ast_binary* ast_binary_new(lex_ctx ctx,
137 ast_expression *left,
138 ast_expression *right);
139 void ast_binary_delete(ast_binary*);
141 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
145 * This must do 2 things:
146 * -) Provide a way to fetch an entity field value. (Rvalue)
147 * -) Provide a pointer to an entity field. (Lvalue)
149 * In original QC, there's only a STORE via pointer, but
150 * no LOAD via pointer.
151 * So we must know beforehand if we are going to read or assign
153 * For this we will have to extend the codegen() functions with
154 * a flag saying whether or not we need an L or an R-value.
156 struct ast_entfield_s
158 ast_expression_common expression;
159 /* The entity can come from an expression of course. */
160 ast_expression *entity;
161 /* As can the field, it just must result in a value of TYPE_FIELD */
162 ast_expression *field;
164 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
165 void ast_entfield_delete(ast_entfield*);
167 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
171 * Stores left<-right and returns left.
172 * Specialized binary expression node
176 ast_expression_common expression;
178 ast_value *dest; /* When we add pointers this might have to change to expression */
179 ast_expression *source;
181 ast_store* ast_store_new(lex_ctx ctx, int op,
182 ast_value *d, ast_expression *s);
183 void ast_store_delete(ast_store*);
185 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
189 * A general 'if then else' statement, either side can be NULL and will
190 * thus be omitted. It is an error for *both* cases to be NULL at once.
192 * During its 'codegen' it'll be changing the ast_function's block.
194 * An if is also an "expression". Its codegen will put NULL into the
195 * output field though. For ternary expressions an ast_ternary will be
200 ast_expression_common expression;
201 ast_expression *cond;
202 /* It's all just 'expressions', since an ast_block is one too. */
203 ast_expression *on_true;
204 ast_expression *on_false;
206 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
207 void ast_ifthen_delete(ast_ifthen*);
209 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
211 /* Ternary expressions...
213 * Contrary to 'if-then-else' nodes, ternary expressions actually
214 * return a value, otherwise they behave the very same way.
215 * The difference in 'codegen' is that it'll return the value of
218 * The other difference is that in an ast_ternary, NEITHER side
219 * must be NULL, there's ALWAYS an else branch.
221 * This is the only ast_node beside ast_value which contains
222 * an ir_value. Theoretically we don't need to remember it though.
226 ast_expression_common expression;
227 ast_expression *cond;
228 /* It's all just 'expressions', since an ast_block is one too. */
229 ast_expression *on_true;
230 ast_expression *on_false;
231 /* After a ternary expression we find ourselves in a new IR block
232 * and start with a PHI node */
235 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
236 void ast_ternary_delete(ast_ternary*);
238 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
246 ast_expression_common expression;
248 MEM_VECTOR_MAKE(ast_value*, locals);
249 MEM_VECTOR_MAKE(ast_expression*, exprs);
251 ast_block* ast_block_new(lex_ctx ctx);
252 void ast_block_delete(ast_block*);
254 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
255 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
257 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
261 * Contains a list of blocks... at least in theory.
262 * Usually there's just the main block, other blocks are inside that.
264 * Technically, functions don't need to be an AST node, since we have
265 * neither functions inside functions, nor lambdas, and function
266 * pointers could just work with a name. However, this way could be
267 * more flexible, and adds no real complexity.
269 struct ast_function_s
271 ast_node_common node;
276 ir_function *ir_func;
278 MEM_VECTOR_MAKE(ast_block*, blocks);
280 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
281 /* This will NOT delete the underlying ast_value */
282 void ast_function_delete(ast_function*);
284 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
286 bool ast_function_codegen(ast_function *self, ir_builder *builder);
290 union ast_expression_u
292 ast_expression_common expression;
302 ast_node_common node;
303 ast_expression expression;