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