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