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