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 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;
  51 typedef struct ast_label_s       ast_label;
  52 typedef struct ast_goto_s        ast_goto;
  53
  54 enum {
  55     TYPE_ast_node,        /*  0 */
  56     TYPE_ast_expression,  /*  1 */
  57     TYPE_ast_value,       /*  2 */
  58     TYPE_ast_function,    /*  3 */
  59     TYPE_ast_block,       /*  4 */
  60     TYPE_ast_binary,      /*  5 */
  61     TYPE_ast_store,       /*  6 */
  62     TYPE_ast_binstore,    /*  7 */
  63     TYPE_ast_entfield,    /*  8 */
  64     TYPE_ast_ifthen,      /*  9 */
  65     TYPE_ast_ternary,     /* 10 */
  66     TYPE_ast_loop,        /* 11 */
  67     TYPE_ast_call,        /* 12 */
  68     TYPE_ast_unary,       /* 13 */
  69     TYPE_ast_return,      /* 14 */
  70     TYPE_ast_member,      /* 15 */
  71     TYPE_ast_array_index, /* 16 */
  72     TYPE_ast_breakcont,   /* 17 */
  73     TYPE_ast_switch,      /* 18 */
  74     TYPE_ast_label,       /* 19 */
  75     TYPE_ast_goto         /* 20 */
  76 };
  77
  78 #define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
  79 #define ast_ctx(node) (((ast_node_common*)(node))->context)
  80 #define ast_side_effects(node) (((ast_node_common*)(node))->side_effects)
  81
  82 /* Node interface with common components
  83  */
  84 typedef void ast_node_delete(ast_node*);
  85 typedef struct
  86 {
  87     lex_ctx          context;
  88     /* I don't feel comfortable using keywords like 'delete' as names... */
  89     ast_node_delete *destroy;
  90     int              nodetype;
  91     /* keep: if a node contains this node, 'keep'
  92      * prevents its dtor from destroying this node as well.
  93      */
  94     bool             keep;
  95     bool             side_effects;
  96 } ast_node_common;
  97
  98 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
  99 #define ast_unref(x) do                     \
 100 {                                           \
 101     if (! (((ast_node*)(x))->node.keep) ) { \
 102         ast_delete(x);                      \
 103     }                                       \
 104 } while(0)
 105
 106 /* Expression interface
 107  *
 108  * Any expression or block returns an ir_value, and needs
 109  * to know the current function.
 110  */
 111 typedef bool ast_expression_codegen(ast_expression*,
 112                                     ast_function*,
 113                                     bool lvalue,
 114                                     ir_value**);
 115 /* TODO: the codegen function should take an output-type parameter
 116  * indicating whether a variable, type, label etc. is expected, and
 117  * an environment!
 118  * Then later an ast_ident could have a codegen using this to figure
 119  * out what to look for.
 120  * eg. in code which uses a not-yet defined variable, the expression
 121  * would take an ast_ident, and the codegen would be called with
 122  * type `expression`, so the ast_ident's codegen would search for
 123  * variables through the environment (or functions, constants...).
 124  */
 125 typedef struct
 126 {
 127     ast_node_common         node;
 128     ast_expression_codegen *codegen;
 129     int                     vtype;
 130     ast_expression         *next;
 131     /* arrays get a member-count */
 132     size_t                  count;
 133     ast_value*             *params;
 134     bool                    variadic;
 135     /* The codegen functions should store their output values
 136      * so we can call it multiple times without re-evaluating.
 137      * Store lvalue and rvalue seperately though. So that
 138      * ast_entfield for example can generate both if required.
 139      */
 140     ir_value               *outl;
 141     ir_value               *outr;
 142 } ast_expression_common;
 143
 144 /* Value
 145  *
 146  * Types are also values, both have a type and a name.
 147  * especially considering possible constructs like typedefs.
 148  * typedef float foo;
 149  * is like creating a 'float foo', foo serving as the type's name.
 150  */
 151 struct ast_value_s
 152 {
 153     ast_expression_common expression;
 154
 155     const char *name;
 156
 157     /*
 158     int         vtype;
 159     ast_value  *next;
 160     */
 161
 162     bool cvq;     /* const/var qualifier */
 163     bool isfield; /* this declares a field */
 164     bool hasvalue;
 165     union {
 166         double        vfloat;
 167         int           vint;
 168         vector        vvec;
 169         const char   *vstring;
 170         int           ventity;
 171         ast_function *vfunc;
 172     } constval;
 173
 174     /* usecount for the parser */
 175     size_t uses;
 176
 177     ir_value *ir_v;
 178     ir_value **ir_values;
 179     size_t   ir_value_count;
 180
 181     /* ONLY for arrays in progs version up to 6 */
 182     ast_value *setter;
 183     ast_value *getter;
 184 };
 185
 186 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
 187 ast_value* ast_value_copy(const ast_value *self);
 188 /* This will NOT delete an underlying ast_function */
 189 void ast_value_delete(ast_value*);
 190
 191 bool ast_value_set_name(ast_value*, const char *name);
 192
 193 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
 194 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
 195 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
 196
 197 void ast_value_params_add(ast_value*, ast_value*);
 198
 199 bool ast_compare_type(ast_expression *a, ast_expression *b);
 200 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
 201 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
 202 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
 203 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
 204
 205 /* Binary
 206  *
 207  * A value-returning binary expression.
 208  */
 209 struct ast_binary_s
 210 {
 211     ast_expression_common expression;
 212
 213     int             op;
 214     ast_expression *left;
 215     ast_expression *right;
 216 };
 217 ast_binary* ast_binary_new(lex_ctx    ctx,
 218                            int        op,
 219                            ast_expression *left,
 220                            ast_expression *right);
 221 void ast_binary_delete(ast_binary*);
 222
 223 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
 224
 225 /* Binstore
 226  *
 227  * An assignment including a binary expression with the source as left operand.
 228  * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
 229  */
 230 struct ast_binstore_s
 231 {
 232     ast_expression_common expression;
 233
 234     int             opstore;
 235     int             opbin;
 236     ast_expression *dest;
 237     ast_expression *source;
 238     /* for &~= which uses the destination in a binary in source we can use this */
 239     bool            keep_dest;
 240 };
 241 ast_binstore* ast_binstore_new(lex_ctx    ctx,
 242                                int        storeop,
 243                                int        op,
 244                                ast_expression *left,
 245                                ast_expression *right);
 246 void ast_binstore_delete(ast_binstore*);
 247
 248 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
 249
 250 /* Unary
 251  *
 252  * Regular unary expressions: not,neg
 253  */
 254 struct ast_unary_s
 255 {
 256     ast_expression_common expression;
 257
 258     int             op;
 259     ast_expression *operand;
 260 };
 261 ast_unary* ast_unary_new(lex_ctx    ctx,
 262                          int        op,
 263                          ast_expression *expr);
 264 void ast_unary_delete(ast_unary*);
 265
 266 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
 267
 268 /* Return
 269  *
 270  * Make sure 'return' only happens at the end of a block, otherwise the IR
 271  * will refuse to create further instructions.
 272  * This should be honored by the parser.
 273  */
 274 struct ast_return_s
 275 {
 276     ast_expression_common expression;
 277     ast_expression *operand;
 278 };
 279 ast_return* ast_return_new(lex_ctx    ctx,
 280                            ast_expression *expr);
 281 void ast_return_delete(ast_return*);
 282
 283 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
 284
 285 /* Entity-field
 286  *
 287  * This must do 2 things:
 288  * -) Provide a way to fetch an entity field value. (Rvalue)
 289  * -) Provide a pointer to an entity field. (Lvalue)
 290  * The problem:
 291  * In original QC, there's only a STORE via pointer, but
 292  * no LOAD via pointer.
 293  * So we must know beforehand if we are going to read or assign
 294  * the field.
 295  * For this we will have to extend the codegen() functions with
 296  * a flag saying whether or not we need an L or an R-value.
 297  */
 298 struct ast_entfield_s
 299 {
 300     ast_expression_common expression;
 301     /* The entity can come from an expression of course. */
 302     ast_expression *entity;
 303     /* As can the field, it just must result in a value of TYPE_FIELD */
 304     ast_expression *field;
 305 };
 306 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
 307 ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
 308 void ast_entfield_delete(ast_entfield*);
 309
 310 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
 311
 312 /* Member access:
 313  *
 314  * For now used for vectors. If we get structs or unions
 315  * we can have them handled here as well.
 316  */
 317 struct ast_member_s
 318 {
 319     ast_expression_common expression;
 320     ast_expression *owner;
 321     unsigned int    field;
 322     const char     *name;
 323 };
 324 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field, const char *name);
 325 void ast_member_delete(ast_member*);
 326
 327 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
 328
 329 /* Array index access:
 330  *
 331  * QC forces us to take special action on arrays:
 332  * an ast_store on an ast_array_index must not codegen the index,
 333  * but call its setter - unless we have an instruction set which supports
 334  * what we need.
 335  * Any other array index access will be codegened to a call to the getter.
 336  * In any case, accessing an element via a compiletime-constant index will
 337  * result in quick access to that variable.
 338  */
 339 struct ast_array_index_s
 340 {
 341     ast_expression_common expression;
 342     ast_expression *array;
 343     ast_expression *index;
 344 };
 345 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
 346 void ast_array_index_delete(ast_array_index*);
 347
 348 bool ast_array_index_codegen(ast_array_index*, ast_function*, bool lvalue, ir_value**);
 349
 350 /* Store
 351  *
 352  * Stores left<-right and returns left.
 353  * Specialized binary expression node
 354  */
 355 struct ast_store_s
 356 {
 357     ast_expression_common expression;
 358     int             op;
 359     ast_expression *dest;
 360     ast_expression *source;
 361 };
 362 ast_store* ast_store_new(lex_ctx ctx, int op,
 363                          ast_expression *d, ast_expression *s);
 364 void ast_store_delete(ast_store*);
 365
 366 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
 367
 368 /* If
 369  *
 370  * A general 'if then else' statement, either side can be NULL and will
 371  * thus be omitted. It is an error for *both* cases to be NULL at once.
 372  *
 373  * During its 'codegen' it'll be changing the ast_function's block.
 374  *
 375  * An if is also an "expression". Its codegen will put NULL into the
 376  * output field though. For ternary expressions an ast_ternary will be
 377  * added.
 378  */
 379 struct ast_ifthen_s
 380 {
 381     ast_expression_common expression;
 382     ast_expression *cond;
 383     /* It's all just 'expressions', since an ast_block is one too. */
 384     ast_expression *on_true;
 385     ast_expression *on_false;
 386 };
 387 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
 388 void ast_ifthen_delete(ast_ifthen*);
 389
 390 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
 391
 392 /* Ternary expressions...
 393  *
 394  * Contrary to 'if-then-else' nodes, ternary expressions actually
 395  * return a value, otherwise they behave the very same way.
 396  * The difference in 'codegen' is that it'll return the value of
 397  * a PHI node.
 398  *
 399  * The other difference is that in an ast_ternary, NEITHER side
 400  * must be NULL, there's ALWAYS an else branch.
 401  *
 402  * This is the only ast_node beside ast_value which contains
 403  * an ir_value. Theoretically we don't need to remember it though.
 404  */
 405 struct ast_ternary_s
 406 {
 407     ast_expression_common expression;
 408     ast_expression *cond;
 409     /* It's all just 'expressions', since an ast_block is one too. */
 410     ast_expression *on_true;
 411     ast_expression *on_false;
 412 };
 413 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
 414 void ast_ternary_delete(ast_ternary*);
 415
 416 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
 417
 418 /* A general loop node
 419  *
 420  * For convenience it contains 4 parts:
 421  * -) (ini) = initializing expression
 422  * -) (pre) = pre-loop condition
 423  * -) (pst) = post-loop condition
 424  * -) (inc) = "increment" expression
 425  * The following is a psudo-representation of this loop
 426  * note that '=>' bears the logical meaning of "implies".
 427  * (a => b) equals (!a || b)
 428
 429 {ini};
 430 while (has_pre => {pre})
 431 {
 432     {body};
 433
 434 continue:      // a 'continue' will jump here
 435     if (has_pst => {pst})
 436         break;
 437
 438     {inc};
 439 }
 440  */
 441 struct ast_loop_s
 442 {
 443     ast_expression_common expression;
 444     ast_expression *initexpr;
 445     ast_expression *precond;
 446     ast_expression *postcond;
 447     ast_expression *increment;
 448     ast_expression *body;
 449 };
 450 ast_loop* ast_loop_new(lex_ctx ctx,
 451                        ast_expression *initexpr,
 452                        ast_expression *precond,
 453                        ast_expression *postcond,
 454                        ast_expression *increment,
 455                        ast_expression *body);
 456 void ast_loop_delete(ast_loop*);
 457
 458 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
 459
 460 /* Break/Continue
 461  */
 462 struct ast_breakcont_s
 463 {
 464     ast_expression_common expression;
 465     bool is_continue;
 466 };
 467 ast_breakcont* ast_breakcont_new(lex_ctx ctx, bool iscont);
 468 void ast_breakcont_delete(ast_breakcont*);
 469
 470 bool ast_breakcont_codegen(ast_breakcont*, ast_function*, bool lvalue, ir_value**);
 471
 472 /* Switch Statements
 473  *
 474  * A few notes about this: with the original QCVM, no real optimization
 475  * is possible. The SWITCH instruction set isn't really helping a lot, since
 476  * it only collapes the EQ and IF instructions into one.
 477  * Note: Declaring local variables inside caseblocks is normal.
 478  * Since we don't have to deal with a stack there's no unnatural behaviour to
 479  * be expected from it.
 480  * TODO: Ticket #20
 481  */
 482 typedef struct {
 483     ast_expression *value; /* #20 will replace this */
 484     ast_expression *code;
 485 } ast_switch_case;
 486 struct ast_switch_s
 487 {
 488     ast_expression_common expression;
 489
 490     ast_expression  *operand;
 491     ast_switch_case *cases;
 492 };
 493
 494 ast_switch* ast_switch_new(lex_ctx ctx, ast_expression *op);
 495 void ast_switch_delete(ast_switch*);
 496
 497 bool ast_switch_codegen(ast_switch*, ast_function*, bool lvalue, ir_value**);
 498
 499 /* Label nodes
 500  *
 501  * Introduce a label which can be used together with 'goto'
 502  */
 503 struct ast_label_s
 504 {
 505     ast_expression_common expression;
 506     const char *name;
 507     ir_block   *irblock;
 508     ast_goto  **gotos;
 509 };
 510
 511 ast_label* ast_label_new(lex_ctx ctx, const char *name);
 512 void ast_label_delete(ast_label*);
 513 void ast_label_register_goto(ast_label*, ast_goto*);
 514
 515 bool ast_label_codegen(ast_label*, ast_function*, bool lvalue, ir_value**);
 516
 517 /* GOTO nodes
 518  *
 519  * Go to a label, the label node is filled in at a later point!
 520  */
 521 struct ast_goto_s
 522 {
 523     ast_expression_common expression;
 524     const char *name;
 525     ast_label  *target;
 526     ir_block   *irblock_from;
 527 };
 528
 529 ast_goto* ast_goto_new(lex_ctx ctx, const char *name);
 530 void ast_goto_delete(ast_goto*);
 531 void ast_goto_set_label(ast_goto*, ast_label*);
 532
 533 bool ast_goto_codegen(ast_goto*, ast_function*, bool lvalue, ir_value**);
 534
 535 /* CALL node
 536  *
 537  * Contains an ast_expression as target, rather than an ast_function/value.
 538  * Since it's how QC works, every ast_function has an ast_value
 539  * associated anyway - in other words, the VM contains function
 540  * pointers for every function anyway. Thus, this node will call
 541  * expression.
 542  * Additionally it contains a list of ast_expressions as parameters.
 543  * Since calls can return values, an ast_call is also an ast_expression.
 544  */
 545 struct ast_call_s
 546 {
 547     ast_expression_common expression;
 548     ast_expression *func;
 549     ast_expression* *params;
 550 };
 551 ast_call* ast_call_new(lex_ctx ctx,
 552                        ast_expression *funcexpr);
 553 void ast_call_delete(ast_call*);
 554 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
 555 bool ast_call_check_types(ast_call*);
 556
 557 /* Blocks
 558  *
 559  */
 560 struct ast_block_s
 561 {
 562     ast_expression_common expression;
 563
 564     ast_value*      *locals;
 565     ast_expression* *exprs;
 566     ast_expression* *collect;
 567 };
 568 ast_block* ast_block_new(lex_ctx ctx);
 569 void ast_block_delete(ast_block*);
 570 bool ast_block_set_type(ast_block*, ast_expression *from);
 571
 572 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
 573 void ast_block_collect(ast_block*, ast_expression*);
 574
 575 void ast_block_add_expr(ast_block*, ast_expression*);
 576
 577 /* Function
 578  *
 579  * Contains a list of blocks... at least in theory.
 580  * Usually there's just the main block, other blocks are inside that.
 581  *
 582  * Technically, functions don't need to be an AST node, since we have
 583  * neither functions inside functions, nor lambdas, and function
 584  * pointers could just work with a name. However, this way could be
 585  * more flexible, and adds no real complexity.
 586  */
 587 struct ast_function_s
 588 {
 589     ast_node_common node;
 590
 591     ast_value  *vtype;
 592     const char *name;
 593
 594     int builtin;
 595
 596     ir_function *ir_func;
 597     ir_block    *curblock;
 598     ir_block    *breakblock;
 599     ir_block    *continueblock;
 600
 601 #if 0
 602     /* In order for early-out logic not to go over
 603      * excessive jumps, we remember their target
 604      * blocks...
 605      */
 606     ir_block    *iftrue;
 607     ir_block    *iffalse;
 608 #endif
 609
 610     size_t       labelcount;
 611     /* in order for thread safety - for the optional
 612      * channel abesed multithreading... keeping a buffer
 613      * here to use in ast_function_label.
 614      */
 615     char         labelbuf[64];
 616
 617     ast_block* *blocks;
 618 };
 619 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
 620 /* This will NOT delete the underlying ast_value */
 621 void ast_function_delete(ast_function*);
 622 /* For "optimized" builds this can just keep returning "foo"...
 623  * or whatever...
 624  */
 625 const char* ast_function_label(ast_function*, const char *prefix);
 626
 627 bool ast_function_codegen(ast_function *self, ir_builder *builder);
 628
 629 /* Expression union
 630  */
 631 union ast_expression_u
 632 {
 633     ast_expression_common expression;
 634
 635     ast_value    value;
 636     ast_binary   binary;
 637     ast_block    block;
 638     ast_ternary  ternary;
 639     ast_ifthen   ifthen;
 640     ast_store    store;
 641     ast_entfield entfield;
 642 };
 643
 644 /* Node union
 645  */
 646 union ast_node_u
 647 {
 648     ast_node_common node;
 649     ast_expression  expression;
 650 };
 651
 652 #endif