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