ast.h

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