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