ast.h

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