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