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