ast.h

   1 /*
   2  * Copyright (C) 2012
   3  *     Wolfgang Bumiller
   4  *
   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:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  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
  21  * SOFTWARE.
  22  */
  23 #ifndef GMQCC_AST_HDR
  24 #define GMQCC_AST_HDR
  25 #include "ir.h"
  26
  27 /* Note: I will not be using a _t suffix for the
  28  * "main" ast node types for now.
  29  */
  30
  31 typedef union ast_node_u ast_node;
  32 typedef union ast_expression_u ast_expression;
  33
  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
  45 /* Node interface with common components
  46  */
  47 typedef void ast_node_delete(ast_node*);
  48 typedef struct
  49 {
  50     lex_ctx          context;
  51     /* I don't feel comfortable using keywords like 'delete' as names... */
  52     ast_node_delete *destroy;
  53     /* keep: if a node contains this node, 'keep'
  54      * prevents its dtor from destroying this node as well.
  55      */
  56     bool             keep;
  57 } ast_node_common;
  58
  59 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
  60 #define ast_unref(x) do                     \
  61 {                                           \
  62     if (! (((ast_node*)(x))->node.keep) ) { \
  63         ast_delete(x);                      \
  64     }                                       \
  65 } while(0)
  66
  67 /* Expression interface
  68  *
  69  * Any expression or block returns an ir_value, and needs
  70  * to know the current function.
  71  */
  72 typedef bool ast_expression_codegen(ast_expression*,
  73                                     ast_function*,
  74                                     bool lvalue,
  75                                     ir_value**);
  76 typedef struct
  77 {
  78     ast_node_common         node;
  79     ast_expression_codegen *codegen;
  80     int                     vtype;
  81     ast_expression         *next;
  82 } ast_expression_common;
  83
  84 /* Value
  85  *
  86  * Types are also values, both have a type and a name.
  87  * especially considering possible constructs like typedefs.
  88  * typedef float foo;
  89  * is like creating a 'float foo', foo serving as the type's name.
  90  */
  91 struct ast_value_s
  92 {
  93     ast_expression_common expression;
  94
  95     const char *name;
  96
  97     /*
  98     int         vtype;
  99     ast_value  *next;
 100     */
 101
 102     bool isconst;
 103     union {
 104         double        vfloat;
 105         int           vint;
 106         vector        vvec;
 107         const char   *vstring;
 108         int           ventity;
 109         ast_function *vfunc;
 110     } constval;
 111
 112     ir_value *ir_v;
 113
 114     /* if vtype is qc_function, params contain parameters, and
 115      * 'next' the return type.
 116      */
 117     MEM_VECTOR_MAKE(ast_value*, params);
 118 };
 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*);
 122
 123 bool ast_value_set_name(ast_value*, const char *name);
 124
 125 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
 126 bool ast_local_codegen(ast_value *self, ir_function *func);
 127 bool ast_global_codegen(ast_value *self, ir_builder *ir);
 128
 129 /* Binary
 130  *
 131  * A value-returning binary expression.
 132  */
 133 struct ast_binary_s
 134 {
 135     ast_expression_common expression;
 136
 137     int             op;
 138     ast_expression *left;
 139     ast_expression *right;
 140 };
 141 ast_binary* ast_binary_new(lex_ctx    ctx,
 142                            int        op,
 143                            ast_expression *left,
 144                            ast_expression *right);
 145 void ast_binary_delete(ast_binary*);
 146
 147 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
 148
 149 /* Entity-field
 150  *
 151  * This must do 2 things:
 152  * -) Provide a way to fetch an entity field value. (Rvalue)
 153  * -) Provide a pointer to an entity field. (Lvalue)
 154  * The problem:
 155  * In original QC, there's only a STORE via pointer, but
 156  * no LOAD via pointer.
 157  * So we must know beforehand if we are going to read or assign
 158  * the field.
 159  * For this we will have to extend the codegen() functions with
 160  * a flag saying whether or not we need an L or an R-value.
 161  */
 162 struct ast_entfield_s
 163 {
 164     ast_expression_common expression;
 165     /* The entity can come from an expression of course. */
 166     ast_expression *entity;
 167     /* As can the field, it just must result in a value of TYPE_FIELD */
 168     ast_expression *field;
 169 };
 170 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
 171 void ast_entfield_delete(ast_entfield*);
 172
 173 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
 174
 175 /* Store
 176  *
 177  * Stores left<-right and returns left.
 178  * Specialized binary expression node
 179  */
 180 struct ast_store_s
 181 {
 182     ast_expression_common expression;
 183     int             op;
 184     ast_value      *dest; /* When we add pointers this might have to change to expression */
 185     ast_expression *source;
 186 };
 187 ast_store* ast_store_new(lex_ctx ctx, int op,
 188                          ast_value *d, ast_expression *s);
 189 void ast_store_delete(ast_store*);
 190
 191 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
 192
 193 /* If
 194  *
 195  * A general 'if then else' statement, either side can be NULL and will
 196  * thus be omitted. It is an error for *both* cases to be NULL at once.
 197  *
 198  * During its 'codegen' it'll be changing the ast_function's block.
 199  *
 200  * An if is also an "expression". Its codegen will put NULL into the
 201  * output field though. For ternary expressions an ast_ternary will be
 202  * added.
 203  */
 204 struct ast_ifthen_s
 205 {
 206     ast_expression_common expression;
 207     ast_expression *cond;
 208     /* It's all just 'expressions', since an ast_block is one too. */
 209     ast_expression *on_true;
 210     ast_expression *on_false;
 211 };
 212 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
 213 void ast_ifthen_delete(ast_ifthen*);
 214
 215 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
 216
 217 /* Ternary expressions...
 218  *
 219  * Contrary to 'if-then-else' nodes, ternary expressions actually
 220  * return a value, otherwise they behave the very same way.
 221  * The difference in 'codegen' is that it'll return the value of
 222  * a PHI node.
 223  *
 224  * The other difference is that in an ast_ternary, NEITHER side
 225  * must be NULL, there's ALWAYS an else branch.
 226  *
 227  * This is the only ast_node beside ast_value which contains
 228  * an ir_value. Theoretically we don't need to remember it though.
 229  */
 230 struct ast_ternary_s
 231 {
 232     ast_expression_common expression;
 233     ast_expression *cond;
 234     /* It's all just 'expressions', since an ast_block is one too. */
 235     ast_expression *on_true;
 236     ast_expression *on_false;
 237     /* After a ternary expression we find ourselves in a new IR block
 238      * and start with a PHI node */
 239     ir_value       *phi_out;
 240 };
 241 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
 242 void ast_ternary_delete(ast_ternary*);
 243
 244 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
 245
 246 /* A general loop node
 247  *
 248  * For convenience it contains 4 parts:
 249  * -) (ini) = initializing expression
 250  * -) (pre) = pre-loop condition
 251  * -) (pst) = post-loop condition
 252  * -) (inc) = "increment" expression
 253  * The following is a psudo-representation of this loop
 254  * note that '=>' bears the logical meaning of "implies".
 255  * (a => b) equals (!a || b)
 256
 257 {ini};
 258 while (has_pre => {pre})
 259 {
 260     {body};
 261
 262 continue:      // a 'continue' will jump here
 263     if (has_pst => {pst})
 264         break;
 265
 266     {inc};
 267 }
 268  */
 269 struct ast_loop_s
 270 {
 271     ast_expression_common expression;
 272     ast_expression *initexpr;
 273     ast_expression *precond;
 274     ast_expression *postcond;
 275     ast_expression *increment;
 276     ast_expression *body;
 277 };
 278 ast_loop* ast_loop_new(lex_ctx ctx,
 279                        ast_expression *initexpr,
 280                        ast_expression *precond,
 281                        ast_expression *postcond,
 282                        ast_expression *increment,
 283                        ast_expression *body);
 284 void ast_loop_delete(ast_loop*);
 285
 286 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
 287
 288 /* CALL node
 289  *
 290  * Contains an ast_expression as target, rather than an ast_function/value.
 291  * Since it's how QC works, every ast_function has an ast_value
 292  * associated anyway - in other words, the VM contains function
 293  * pointers for every function anyway. Thus, this node will call
 294  * expression.
 295  * Additionally it contains a list of ast_expressions as parameters.
 296  * Since calls can return values, an ast_call is also an ast_expression.
 297  */
 298 struct ast_call_s
 299 {
 300     ast_expression_common expression;
 301     ast_expression *func;
 302     MEM_VECTOR_MAKE(ast_expression*, params);
 303 };
 304 ast_call* ast_call_new(lex_ctx ctx,
 305                        ast_expression *funcexpr);
 306 void ast_call_delete(ast_call*);
 307 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
 308
 309 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
 310
 311 /* Blocks
 312  *
 313  */
 314 struct ast_block_s
 315 {
 316     ast_expression_common expression;
 317
 318     MEM_VECTOR_MAKE(ast_value*,      locals);
 319     MEM_VECTOR_MAKE(ast_expression*, exprs);
 320 };
 321 ast_block* ast_block_new(lex_ctx ctx);
 322 void ast_block_delete(ast_block*);
 323
 324 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
 325 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
 326
 327 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
 328
 329 /* Function
 330  *
 331  * Contains a list of blocks... at least in theory.
 332  * Usually there's just the main block, other blocks are inside that.
 333  *
 334  * Technically, functions don't need to be an AST node, since we have
 335  * neither functions inside functions, nor lambdas, and function
 336  * pointers could just work with a name. However, this way could be
 337  * more flexible, and adds no real complexity.
 338  */
 339 struct ast_function_s
 340 {
 341     ast_node_common node;
 342
 343     ast_value  *vtype;
 344     const char *name;
 345
 346     int builtin;
 347
 348     ir_function *ir_func;
 349     ir_block    *curblock;
 350     ir_block    *breakblock;
 351     ir_block    *continueblock;
 352
 353     size_t       labelcount;
 354     /* in order for thread safety - for the optional
 355      * channel abesed multithreading... keeping a buffer
 356      * here to use in ast_function_label.
 357      */
 358     char         labelbuf[64];
 359
 360     MEM_VECTOR_MAKE(ast_block*, blocks);
 361     MEM_VECTOR_MAKE(ast_value*, params);
 362 };
 363 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
 364 /* This will NOT delete the underlying ast_value */
 365 void ast_function_delete(ast_function*);
 366 /* For "optimized" builds this can just keep returning "foo"...
 367  * or whatever...
 368  */
 369 const char* ast_function_label(ast_function*, const char *prefix);
 370
 371 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
 372 MEM_VECTOR_PROTO(ast_function, ast_value*, params);
 373
 374 bool ast_function_codegen(ast_function *self, ir_builder *builder);
 375
 376 /* Expression union
 377  */
 378 union ast_expression_u
 379 {
 380     ast_expression_common expression;
 381
 382     ast_value    value;
 383     ast_binary   binary;
 384     ast_block    block;
 385     ast_ternary  ternary;
 386     ast_ifthen   ifthen;
 387     ast_store    store;
 388     ast_entfield entfield;
 389 };
 390
 391 /* Node union
 392  */
 393 union ast_node_u
 394 {
 395     ast_node_common node;
 396     ast_expression  expression;
 397 };
 398
 399 #endif