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