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_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
  49 enum {
  50     TYPE_ast_node,
  51     TYPE_ast_expression,
  52     TYPE_ast_value,
  53     TYPE_ast_function,
  54     TYPE_ast_block,
  55     TYPE_ast_binary,
  56     TYPE_ast_store,
  57     TYPE_ast_binstore,
  58     TYPE_ast_entfield,
  59     TYPE_ast_ifthen,
  60     TYPE_ast_ternary,
  61     TYPE_ast_loop,
  62     TYPE_ast_call,
  63     TYPE_ast_unary,
  64     TYPE_ast_return,
  65     TYPE_ast_member
  66 };
  67
  68 #define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
  69 #define ast_ctx(node) (((ast_node_common*)(node))->context)
  70
  71 /* Node interface with common components
  72  */
  73 typedef void ast_node_delete(ast_node*);
  74 typedef struct
  75 {
  76     lex_ctx          context;
  77     /* I don't feel comfortable using keywords like 'delete' as names... */
  78     ast_node_delete *destroy;
  79     int              nodetype;
  80     /* keep: if a node contains this node, 'keep'
  81      * prevents its dtor from destroying this node as well.
  82      */
  83     bool             keep;
  84 } ast_node_common;
  85
  86 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
  87 #define ast_unref(x) do                     \
  88 {                                           \
  89     if (! (((ast_node*)(x))->node.keep) ) { \
  90         ast_delete(x);                      \
  91     }                                       \
  92 } while(0)
  93
  94 /* Expression interface
  95  *
  96  * Any expression or block returns an ir_value, and needs
  97  * to know the current function.
  98  */
  99 typedef bool ast_expression_codegen(ast_expression*,
 100                                     ast_function*,
 101                                     bool lvalue,
 102                                     ir_value**);
 103 typedef struct
 104 {
 105     ast_node_common         node;
 106     ast_expression_codegen *codegen;
 107     int                     vtype;
 108     ast_expression         *next;
 109     MEM_VECTOR_MAKE(ast_value*, params);
 110     /* The codegen functions should store their output values
 111      * so we can call it multiple times without re-evaluating.
 112      * Store lvalue and rvalue seperately though. So that
 113      * ast_entfield for example can generate both if required.
 114      */
 115     ir_value               *outl;
 116     ir_value               *outr;
 117 } ast_expression_common;
 118 MEM_VECTOR_PROTO(ast_expression_common, ast_value*, params);
 119
 120 /* Value
 121  *
 122  * Types are also values, both have a type and a name.
 123  * especially considering possible constructs like typedefs.
 124  * typedef float foo;
 125  * is like creating a 'float foo', foo serving as the type's name.
 126  */
 127 struct ast_value_s
 128 {
 129     ast_expression_common expression;
 130
 131     const char *name;
 132
 133     /*
 134     int         vtype;
 135     ast_value  *next;
 136     */
 137
 138     bool isconst;
 139     union {
 140         double        vfloat;
 141         int           vint;
 142         vector        vvec;
 143         const char   *vstring;
 144         int           ventity;
 145         ast_function *vfunc;
 146     } constval;
 147
 148     ir_value *ir_v;
 149 };
 150
 151 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
 152 /* This will NOT delete an underlying ast_function */
 153 void ast_value_delete(ast_value*);
 154
 155 bool ast_value_set_name(ast_value*, const char *name);
 156
 157 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
 158 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
 159 bool ast_global_codegen(ast_value *self, ir_builder *ir);
 160
 161 bool GMQCC_WARN ast_value_params_add(ast_value*, ast_value*);
 162
 163 /* Binary
 164  *
 165  * A value-returning binary expression.
 166  */
 167 struct ast_binary_s
 168 {
 169     ast_expression_common expression;
 170
 171     int             op;
 172     ast_expression *left;
 173     ast_expression *right;
 174 };
 175 ast_binary* ast_binary_new(lex_ctx    ctx,
 176                            int        op,
 177                            ast_expression *left,
 178                            ast_expression *right);
 179 void ast_binary_delete(ast_binary*);
 180
 181 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
 182
 183 /* Binstore
 184  *
 185  * An assignment including a binary expression with the source as left operand.
 186  * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
 187  */
 188 struct ast_binstore_s
 189 {
 190     ast_expression_common expression;
 191
 192     int             opstore;
 193     int             opbin;
 194     ast_expression *dest;
 195     ast_expression *source;
 196 };
 197 ast_binstore* ast_binstore_new(lex_ctx    ctx,
 198                                int        storeop,
 199                                int        op,
 200                                ast_expression *left,
 201                                ast_expression *right);
 202 void ast_binstore_delete(ast_binstore*);
 203
 204 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
 205
 206 /* Unary
 207  *
 208  * Regular unary expressions: not,neg
 209  */
 210 struct ast_unary_s
 211 {
 212     ast_expression_common expression;
 213
 214     int             op;
 215     ast_expression *operand;
 216 };
 217 ast_unary* ast_unary_new(lex_ctx    ctx,
 218                          int        op,
 219                          ast_expression *expr);
 220 void ast_unary_delete(ast_unary*);
 221
 222 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
 223
 224 /* Return
 225  *
 226  * Make sure 'return' only happens at the end of a block, otherwise the IR
 227  * will refuse to create further instructions.
 228  * This should be honored by the parser.
 229  */
 230 struct ast_return_s
 231 {
 232     ast_expression_common expression;
 233     ast_expression *operand;
 234 };
 235 ast_return* ast_return_new(lex_ctx    ctx,
 236                            ast_expression *expr);
 237 void ast_return_delete(ast_return*);
 238
 239 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
 240
 241 /* Entity-field
 242  *
 243  * This must do 2 things:
 244  * -) Provide a way to fetch an entity field value. (Rvalue)
 245  * -) Provide a pointer to an entity field. (Lvalue)
 246  * The problem:
 247  * In original QC, there's only a STORE via pointer, but
 248  * no LOAD via pointer.
 249  * So we must know beforehand if we are going to read or assign
 250  * the field.
 251  * For this we will have to extend the codegen() functions with
 252  * a flag saying whether or not we need an L or an R-value.
 253  */
 254 struct ast_entfield_s
 255 {
 256     ast_expression_common expression;
 257     /* The entity can come from an expression of course. */
 258     ast_expression *entity;
 259     /* As can the field, it just must result in a value of TYPE_FIELD */
 260     ast_expression *field;
 261 };
 262 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
 263 void ast_entfield_delete(ast_entfield*);
 264
 265 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
 266
 267 /* Member access:
 268  *
 269  * For now used for vectors. If we get structs or unions
 270  * we can have them handled here as well.
 271  */
 272 struct ast_member_s
 273 {
 274     ast_expression_common expression;
 275     ast_expression *owner;
 276     unsigned int    field;
 277 };
 278 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field);
 279 void ast_member_delete(ast_member*);
 280
 281 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
 282
 283 /* Store
 284  *
 285  * Stores left<-right and returns left.
 286  * Specialized binary expression node
 287  */
 288 struct ast_store_s
 289 {
 290     ast_expression_common expression;
 291     int             op;
 292     ast_expression *dest;
 293     ast_expression *source;
 294 };
 295 ast_store* ast_store_new(lex_ctx ctx, int op,
 296                          ast_expression *d, ast_expression *s);
 297 void ast_store_delete(ast_store*);
 298
 299 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
 300
 301 /* If
 302  *
 303  * A general 'if then else' statement, either side can be NULL and will
 304  * thus be omitted. It is an error for *both* cases to be NULL at once.
 305  *
 306  * During its 'codegen' it'll be changing the ast_function's block.
 307  *
 308  * An if is also an "expression". Its codegen will put NULL into the
 309  * output field though. For ternary expressions an ast_ternary will be
 310  * added.
 311  */
 312 struct ast_ifthen_s
 313 {
 314     ast_expression_common expression;
 315     ast_expression *cond;
 316     /* It's all just 'expressions', since an ast_block is one too. */
 317     ast_expression *on_true;
 318     ast_expression *on_false;
 319 };
 320 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
 321 void ast_ifthen_delete(ast_ifthen*);
 322
 323 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
 324
 325 /* Ternary expressions...
 326  *
 327  * Contrary to 'if-then-else' nodes, ternary expressions actually
 328  * return a value, otherwise they behave the very same way.
 329  * The difference in 'codegen' is that it'll return the value of
 330  * a PHI node.
 331  *
 332  * The other difference is that in an ast_ternary, NEITHER side
 333  * must be NULL, there's ALWAYS an else branch.
 334  *
 335  * This is the only ast_node beside ast_value which contains
 336  * an ir_value. Theoretically we don't need to remember it though.
 337  */
 338 struct ast_ternary_s
 339 {
 340     ast_expression_common expression;
 341     ast_expression *cond;
 342     /* It's all just 'expressions', since an ast_block is one too. */
 343     ast_expression *on_true;
 344     ast_expression *on_false;
 345     /* After a ternary expression we find ourselves in a new IR block
 346      * and start with a PHI node */
 347     ir_value       *phi_out;
 348 };
 349 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
 350 void ast_ternary_delete(ast_ternary*);
 351
 352 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
 353
 354 /* A general loop node
 355  *
 356  * For convenience it contains 4 parts:
 357  * -) (ini) = initializing expression
 358  * -) (pre) = pre-loop condition
 359  * -) (pst) = post-loop condition
 360  * -) (inc) = "increment" expression
 361  * The following is a psudo-representation of this loop
 362  * note that '=>' bears the logical meaning of "implies".
 363  * (a => b) equals (!a || b)
 364
 365 {ini};
 366 while (has_pre => {pre})
 367 {
 368     {body};
 369
 370 continue:      // a 'continue' will jump here
 371     if (has_pst => {pst})
 372         break;
 373
 374     {inc};
 375 }
 376  */
 377 struct ast_loop_s
 378 {
 379     ast_expression_common expression;
 380     ast_expression *initexpr;
 381     ast_expression *precond;
 382     ast_expression *postcond;
 383     ast_expression *increment;
 384     ast_expression *body;
 385 };
 386 ast_loop* ast_loop_new(lex_ctx ctx,
 387                        ast_expression *initexpr,
 388                        ast_expression *precond,
 389                        ast_expression *postcond,
 390                        ast_expression *increment,
 391                        ast_expression *body);
 392 void ast_loop_delete(ast_loop*);
 393
 394 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
 395
 396 /* CALL node
 397  *
 398  * Contains an ast_expression as target, rather than an ast_function/value.
 399  * Since it's how QC works, every ast_function has an ast_value
 400  * associated anyway - in other words, the VM contains function
 401  * pointers for every function anyway. Thus, this node will call
 402  * expression.
 403  * Additionally it contains a list of ast_expressions as parameters.
 404  * Since calls can return values, an ast_call is also an ast_expression.
 405  */
 406 struct ast_call_s
 407 {
 408     ast_expression_common expression;
 409     ast_expression *func;
 410     MEM_VECTOR_MAKE(ast_expression*, params);
 411 };
 412 ast_call* ast_call_new(lex_ctx ctx,
 413                        ast_expression *funcexpr);
 414 void ast_call_delete(ast_call*);
 415 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
 416
 417 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
 418
 419 /* Blocks
 420  *
 421  */
 422 struct ast_block_s
 423 {
 424     ast_expression_common expression;
 425
 426     MEM_VECTOR_MAKE(ast_value*,      locals);
 427     MEM_VECTOR_MAKE(ast_expression*, exprs);
 428 };
 429 ast_block* ast_block_new(lex_ctx ctx);
 430 void ast_block_delete(ast_block*);
 431 bool ast_block_set_type(ast_block*, ast_expression *from);
 432
 433 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
 434 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
 435
 436 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
 437
 438 /* Function
 439  *
 440  * Contains a list of blocks... at least in theory.
 441  * Usually there's just the main block, other blocks are inside that.
 442  *
 443  * Technically, functions don't need to be an AST node, since we have
 444  * neither functions inside functions, nor lambdas, and function
 445  * pointers could just work with a name. However, this way could be
 446  * more flexible, and adds no real complexity.
 447  */
 448 struct ast_function_s
 449 {
 450     ast_node_common node;
 451
 452     ast_value  *vtype;
 453     const char *name;
 454
 455     int builtin;
 456
 457     ir_function *ir_func;
 458     ir_block    *curblock;
 459     ir_block    *breakblock;
 460     ir_block    *continueblock;
 461
 462     size_t       labelcount;
 463     /* in order for thread safety - for the optional
 464      * channel abesed multithreading... keeping a buffer
 465      * here to use in ast_function_label.
 466      */
 467     char         labelbuf[64];
 468
 469     MEM_VECTOR_MAKE(ast_block*, blocks);
 470 };
 471 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
 472 /* This will NOT delete the underlying ast_value */
 473 void ast_function_delete(ast_function*);
 474 /* For "optimized" builds this can just keep returning "foo"...
 475  * or whatever...
 476  */
 477 const char* ast_function_label(ast_function*, const char *prefix);
 478
 479 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
 480
 481 bool ast_function_codegen(ast_function *self, ir_builder *builder);
 482
 483 /* Expression union
 484  */
 485 union ast_expression_u
 486 {
 487     ast_expression_common expression;
 488
 489     ast_value    value;
 490     ast_binary   binary;
 491     ast_block    block;
 492     ast_ternary  ternary;
 493     ast_ifthen   ifthen;
 494     ast_store    store;
 495     ast_entfield entfield;
 496 };
 497
 498 /* Node union
 499  */
 500 union ast_node_u
 501 {
 502     ast_node_common node;
 503     ast_expression  expression;
 504 };
 505
 506 #endif