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         quaternion    vquat;
 135         matrix        vmat;
 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 /* Store
 235  *
 236  * Stores left<-right and returns left.
 237  * Specialized binary expression node
 238  */
 239 struct ast_store_s
 240 {
 241     ast_expression_common expression;
 242     int             op;
 243     ast_expression *dest;
 244     ast_expression *source;
 245 };
 246 ast_store* ast_store_new(lex_ctx ctx, int op,
 247                          ast_expression *d, ast_expression *s);
 248 void ast_store_delete(ast_store*);
 249
 250 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
 251
 252 /* If
 253  *
 254  * A general 'if then else' statement, either side can be NULL and will
 255  * thus be omitted. It is an error for *both* cases to be NULL at once.
 256  *
 257  * During its 'codegen' it'll be changing the ast_function's block.
 258  *
 259  * An if is also an "expression". Its codegen will put NULL into the
 260  * output field though. For ternary expressions an ast_ternary will be
 261  * added.
 262  */
 263 struct ast_ifthen_s
 264 {
 265     ast_expression_common expression;
 266     ast_expression *cond;
 267     /* It's all just 'expressions', since an ast_block is one too. */
 268     ast_expression *on_true;
 269     ast_expression *on_false;
 270 };
 271 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
 272 void ast_ifthen_delete(ast_ifthen*);
 273
 274 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
 275
 276 /* Ternary expressions...
 277  *
 278  * Contrary to 'if-then-else' nodes, ternary expressions actually
 279  * return a value, otherwise they behave the very same way.
 280  * The difference in 'codegen' is that it'll return the value of
 281  * a PHI node.
 282  *
 283  * The other difference is that in an ast_ternary, NEITHER side
 284  * must be NULL, there's ALWAYS an else branch.
 285  *
 286  * This is the only ast_node beside ast_value which contains
 287  * an ir_value. Theoretically we don't need to remember it though.
 288  */
 289 struct ast_ternary_s
 290 {
 291     ast_expression_common expression;
 292     ast_expression *cond;
 293     /* It's all just 'expressions', since an ast_block is one too. */
 294     ast_expression *on_true;
 295     ast_expression *on_false;
 296     /* After a ternary expression we find ourselves in a new IR block
 297      * and start with a PHI node */
 298     ir_value       *phi_out;
 299 };
 300 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
 301 void ast_ternary_delete(ast_ternary*);
 302
 303 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
 304
 305 /* A general loop node
 306  *
 307  * For convenience it contains 4 parts:
 308  * -) (ini) = initializing expression
 309  * -) (pre) = pre-loop condition
 310  * -) (pst) = post-loop condition
 311  * -) (inc) = "increment" expression
 312  * The following is a psudo-representation of this loop
 313  * note that '=>' bears the logical meaning of "implies".
 314  * (a => b) equals (!a || b)
 315
 316 {ini};
 317 while (has_pre => {pre})
 318 {
 319     {body};
 320
 321 continue:      // a 'continue' will jump here
 322     if (has_pst => {pst})
 323         break;
 324
 325     {inc};
 326 }
 327  */
 328 struct ast_loop_s
 329 {
 330     ast_expression_common expression;
 331     ast_expression *initexpr;
 332     ast_expression *precond;
 333     ast_expression *postcond;
 334     ast_expression *increment;
 335     ast_expression *body;
 336 };
 337 ast_loop* ast_loop_new(lex_ctx ctx,
 338                        ast_expression *initexpr,
 339                        ast_expression *precond,
 340                        ast_expression *postcond,
 341                        ast_expression *increment,
 342                        ast_expression *body);
 343 void ast_loop_delete(ast_loop*);
 344
 345 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
 346
 347 /* CALL node
 348  *
 349  * Contains an ast_expression as target, rather than an ast_function/value.
 350  * Since it's how QC works, every ast_function has an ast_value
 351  * associated anyway - in other words, the VM contains function
 352  * pointers for every function anyway. Thus, this node will call
 353  * expression.
 354  * Additionally it contains a list of ast_expressions as parameters.
 355  * Since calls can return values, an ast_call is also an ast_expression.
 356  */
 357 struct ast_call_s
 358 {
 359     ast_expression_common expression;
 360     ast_expression *func;
 361     MEM_VECTOR_MAKE(ast_expression*, params);
 362 };
 363 ast_call* ast_call_new(lex_ctx ctx,
 364                        ast_expression *funcexpr);
 365 void ast_call_delete(ast_call*);
 366 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
 367
 368 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
 369
 370 /* Blocks
 371  *
 372  */
 373 struct ast_block_s
 374 {
 375     ast_expression_common expression;
 376
 377     MEM_VECTOR_MAKE(ast_value*,      locals);
 378     MEM_VECTOR_MAKE(ast_expression*, exprs);
 379 };
 380 ast_block* ast_block_new(lex_ctx ctx);
 381 void ast_block_delete(ast_block*);
 382 bool ast_block_set_type(ast_block*, ast_expression *from);
 383
 384 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
 385 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
 386
 387 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
 388
 389 /* Function
 390  *
 391  * Contains a list of blocks... at least in theory.
 392  * Usually there's just the main block, other blocks are inside that.
 393  *
 394  * Technically, functions don't need to be an AST node, since we have
 395  * neither functions inside functions, nor lambdas, and function
 396  * pointers could just work with a name. However, this way could be
 397  * more flexible, and adds no real complexity.
 398  */
 399 struct ast_function_s
 400 {
 401     ast_node_common node;
 402
 403     ast_value  *vtype;
 404     const char *name;
 405
 406     int builtin;
 407
 408     ir_function *ir_func;
 409     ir_block    *curblock;
 410     ir_block    *breakblock;
 411     ir_block    *continueblock;
 412
 413     size_t       labelcount;
 414     /* in order for thread safety - for the optional
 415      * channel abesed multithreading... keeping a buffer
 416      * here to use in ast_function_label.
 417      */
 418     char         labelbuf[64];
 419
 420     MEM_VECTOR_MAKE(ast_block*, blocks);
 421 };
 422 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
 423 /* This will NOT delete the underlying ast_value */
 424 void ast_function_delete(ast_function*);
 425 /* For "optimized" builds this can just keep returning "foo"...
 426  * or whatever...
 427  */
 428 const char* ast_function_label(ast_function*, const char *prefix);
 429
 430 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
 431
 432 bool ast_function_codegen(ast_function *self, ir_builder *builder);
 433
 434 /* Expression union
 435  */
 436 union ast_expression_u
 437 {
 438     ast_expression_common expression;
 439
 440     ast_value    value;
 441     ast_binary   binary;
 442     ast_block    block;
 443     ast_ternary  ternary;
 444     ast_ifthen   ifthen;
 445     ast_store    store;
 446     ast_entfield entfield;
 447 };
 448
 449 /* Node union
 450  */
 451 union ast_node_u
 452 {
 453     ast_node_common node;
 454     ast_expression  expression;
 455 };
 456
 457 #endif