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