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