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