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