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