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