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