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