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