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