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