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         quaternion    vquat;
 111         matrix        vmat;
 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 /* Entity-field
 154  *
 155  * This must do 2 things:
 156  * -) Provide a way to fetch an entity field value. (Rvalue)
 157  * -) Provide a pointer to an entity field. (Lvalue)
 158  * The problem:
 159  * In original QC, there's only a STORE via pointer, but
 160  * no LOAD via pointer.
 161  * So we must know beforehand if we are going to read or assign
 162  * the field.
 163  * For this we will have to extend the codegen() functions with
 164  * a flag saying whether or not we need an L or an R-value.
 165  */
 166 struct ast_entfield_s
 167 {
 168     ast_expression_common expression;
 169     /* The entity can come from an expression of course. */
 170     ast_expression *entity;
 171     /* As can the field, it just must result in a value of TYPE_FIELD */
 172     ast_expression *field;
 173 };
 174 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
 175 void ast_entfield_delete(ast_entfield*);
 176
 177 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
 178
 179 /* Store
 180  *
 181  * Stores left<-right and returns left.
 182  * Specialized binary expression node
 183  */
 184 struct ast_store_s
 185 {
 186     ast_expression_common expression;
 187     int             op;
 188     ast_value      *dest; /* When we add pointers this might have to change to expression */
 189     ast_expression *source;
 190 };
 191 ast_store* ast_store_new(lex_ctx ctx, int op,
 192                          ast_value *d, ast_expression *s);
 193 void ast_store_delete(ast_store*);
 194
 195 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
 196
 197 /* If
 198  *
 199  * A general 'if then else' statement, either side can be NULL and will
 200  * thus be omitted. It is an error for *both* cases to be NULL at once.
 201  *
 202  * During its 'codegen' it'll be changing the ast_function's block.
 203  *
 204  * An if is also an "expression". Its codegen will put NULL into the
 205  * output field though. For ternary expressions an ast_ternary will be
 206  * added.
 207  */
 208 struct ast_ifthen_s
 209 {
 210     ast_expression_common expression;
 211     ast_expression *cond;
 212     /* It's all just 'expressions', since an ast_block is one too. */
 213     ast_expression *on_true;
 214     ast_expression *on_false;
 215 };
 216 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
 217 void ast_ifthen_delete(ast_ifthen*);
 218
 219 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
 220
 221 /* Ternary expressions...
 222  *
 223  * Contrary to 'if-then-else' nodes, ternary expressions actually
 224  * return a value, otherwise they behave the very same way.
 225  * The difference in 'codegen' is that it'll return the value of
 226  * a PHI node.
 227  *
 228  * The other difference is that in an ast_ternary, NEITHER side
 229  * must be NULL, there's ALWAYS an else branch.
 230  *
 231  * This is the only ast_node beside ast_value which contains
 232  * an ir_value. Theoretically we don't need to remember it though.
 233  */
 234 struct ast_ternary_s
 235 {
 236     ast_expression_common expression;
 237     ast_expression *cond;
 238     /* It's all just 'expressions', since an ast_block is one too. */
 239     ast_expression *on_true;
 240     ast_expression *on_false;
 241     /* After a ternary expression we find ourselves in a new IR block
 242      * and start with a PHI node */
 243     ir_value       *phi_out;
 244 };
 245 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
 246 void ast_ternary_delete(ast_ternary*);
 247
 248 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
 249
 250 /* A general loop node
 251  *
 252  * For convenience it contains 4 parts:
 253  * -) (ini) = initializing expression
 254  * -) (pre) = pre-loop condition
 255  * -) (pst) = post-loop condition
 256  * -) (inc) = "increment" expression
 257  * The following is a psudo-representation of this loop
 258  * note that '=>' bears the logical meaning of "implies".
 259  * (a => b) equals (!a || b)
 260
 261 {ini};
 262 while (has_pre => {pre})
 263 {
 264     {body};
 265
 266 continue:      // a 'continue' will jump here
 267     if (has_pst => {pst})
 268         break;
 269
 270     {inc};
 271 }
 272  */
 273 struct ast_loop_s
 274 {
 275     ast_expression_common expression;
 276     ast_expression *initexpr;
 277     ast_expression *precond;
 278     ast_expression *postcond;
 279     ast_expression *increment;
 280     ast_expression *body;
 281 };
 282 ast_loop* ast_loop_new(lex_ctx ctx,
 283                        ast_expression *initexpr,
 284                        ast_expression *precond,
 285                        ast_expression *postcond,
 286                        ast_expression *increment,
 287                        ast_expression *body);
 288 void ast_loop_delete(ast_loop*);
 289
 290 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
 291
 292 /* CALL node
 293  *
 294  * Contains an ast_expression as target, rather than an ast_function/value.
 295  * Since it's how QC works, every ast_function has an ast_value
 296  * associated anyway - in other words, the VM contains function
 297  * pointers for every function anyway. Thus, this node will call
 298  * expression.
 299  * Additionally it contains a list of ast_expressions as parameters.
 300  * Since calls can return values, an ast_call is also an ast_expression.
 301  */
 302 struct ast_call_s
 303 {
 304     ast_expression_common expression;
 305     ast_expression *func;
 306     MEM_VECTOR_MAKE(ast_expression*, params);
 307 };
 308 ast_call* ast_call_new(lex_ctx ctx,
 309                        ast_expression *funcexpr);
 310 void ast_call_delete(ast_call*);
 311 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
 312
 313 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
 314
 315 /* Blocks
 316  *
 317  */
 318 struct ast_block_s
 319 {
 320     ast_expression_common expression;
 321
 322     MEM_VECTOR_MAKE(ast_value*,      locals);
 323     MEM_VECTOR_MAKE(ast_expression*, exprs);
 324 };
 325 ast_block* ast_block_new(lex_ctx ctx);
 326 void ast_block_delete(ast_block*);
 327
 328 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
 329 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
 330
 331 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
 332
 333 /* Function
 334  *
 335  * Contains a list of blocks... at least in theory.
 336  * Usually there's just the main block, other blocks are inside that.
 337  *
 338  * Technically, functions don't need to be an AST node, since we have
 339  * neither functions inside functions, nor lambdas, and function
 340  * pointers could just work with a name. However, this way could be
 341  * more flexible, and adds no real complexity.
 342  */
 343 struct ast_function_s
 344 {
 345     ast_node_common node;
 346
 347     ast_value  *vtype;
 348     const char *name;
 349
 350     int builtin;
 351
 352     ir_function *ir_func;
 353     ir_block    *curblock;
 354     ir_block    *breakblock;
 355     ir_block    *continueblock;
 356
 357     size_t       labelcount;
 358     /* in order for thread safety - for the optional
 359      * channel abesed multithreading... keeping a buffer
 360      * here to use in ast_function_label.
 361      */
 362     char         labelbuf[64];
 363
 364     MEM_VECTOR_MAKE(ast_block*, blocks);
 365
 366     /* contrary to the params in ast_value, these are the parameter variables
 367      * which are to be used in expressions.
 368      * The ast_value for the function contains only the parameter types used
 369      * to generate ast_calls, and ast_call contains the parameter values
 370      * used in that call.
 371      */
 372 };
 373 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
 374 /* This will NOT delete the underlying ast_value */
 375 void ast_function_delete(ast_function*);
 376 /* For "optimized" builds this can just keep returning "foo"...
 377  * or whatever...
 378  */
 379 const char* ast_function_label(ast_function*, const char *prefix);
 380
 381 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
 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