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
  41 /* Node interface with common components
  42  */
  43 typedef void ast_node_delete(ast_node*);
  44 typedef struct
  45 {
  46     lex_ctx          context;
  47     /* I don't feel comfortable using keywords like 'delete' as names... */
  48     ast_node_delete *destroy;
  49     /* keep: if a node contains this node, 'keep'
  50      * prevents its dtor from destroying this node as well.
  51      */
  52     bool             keep;
  53 } ast_node_common;
  54
  55 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
  56 #define ast_unref(x) do                     \
  57 {                                           \
  58     if (! (((ast_node*)(x))->node.keep) ) { \
  59         ast_delete(x);                      \
  60     }                                       \
  61 } while(0)
  62
  63 /* Expression interface
  64  *
  65  * Any expression or block returns an ir_value, and needs
  66  * to know the current function.
  67  */
  68 typedef bool ast_expression_codegen(ast_expression*,
  69                                     ast_function*,
  70                                     bool lvalue,
  71                                     ir_value**);
  72 typedef struct
  73 {
  74     ast_node_common         node;
  75     ast_expression_codegen *codegen;
  76 } ast_expression_common;
  77
  78 /* Value
  79  *
  80  * Types are also values, both have a type and a name.
  81  * especially considering possible constructs like typedefs.
  82  * typedef float foo;
  83  * is like creating a 'float foo', foo serving as the type's name.
  84  */
  85 struct ast_value_s
  86 {
  87     ast_expression_common expression;
  88
  89     const char *name;
  90
  91     int         vtype;
  92     ast_value  *next;
  93
  94     bool isconst;
  95     union {
  96         double        vfloat;
  97         int           vint;
  98         vector        vvec;
  99         const char   *vstring;
 100         int           ventity;
 101         ast_function *vfunc;
 102     } constval;
 103
 104     ir_value *ir_v;
 105
 106     /* if vtype is qc_function, params contain parameters, and
 107      * 'next' the return type.
 108      */
 109     MEM_VECTOR_MAKE(ast_value*, params);
 110 };
 111 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
 112 /* This will NOT delete an underlying ast_function */
 113 void ast_value_delete(ast_value*);
 114
 115 bool ast_value_set_name(ast_value*, const char *name);
 116
 117 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
 118
 119 /* Binary
 120  *
 121  * A value-returning binary expression.
 122  */
 123 struct ast_binary_s
 124 {
 125     ast_expression_common expression;
 126
 127     int             op;
 128     ast_expression *left;
 129     ast_expression *right;
 130 };
 131 ast_binary* ast_binary_new(lex_ctx    ctx,
 132                            int        op,
 133                            ast_expression *left,
 134                            ast_expression *right);
 135 void ast_binary_delete(ast_binary*);
 136
 137 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
 138
 139 /* Entity-field
 140  *
 141  * This must do 2 things:
 142  * -) Provide a way to fetch an entity field value. (Rvalue)
 143  * -) Provide a pointer to an entity field. (Lvalue)
 144  * The problem:
 145  * In original QC, there's only a STORE via pointer, but
 146  * no LOAD via pointer.
 147  * So we must know beforehand if we are going to read or assign
 148  * the field.
 149  * For this we will have to extend the codegen() functions with
 150  * a flag saying whether or not we need an L or an R-value.
 151  */
 152 struct ast_entfield_s
 153 {
 154     ast_expression_common expression;
 155     /* The entity can come from an expression of course. */
 156     ast_expression *entity;
 157     /* As can the field, it just must result in a value of TYPE_FIELD */
 158     ast_expression *field;
 159 };
 160 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
 161 void ast_entfield_delete(ast_entfield*);
 162
 163 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
 164
 165 /* Store
 166  *
 167  * Stores left<-right and returns left.
 168  * Specialized binary expression node
 169  */
 170 struct ast_store_s
 171 {
 172     ast_expression_common expression;
 173     int             op;
 174     ast_value      *dest; /* When we add pointers this might have to change to expression */
 175     ast_expression *source;
 176 };
 177 ast_store* ast_store_new(lex_ctx ctx, int op,
 178                          ast_value *d, ast_expression *s);
 179 void ast_store_delete(ast_store*);
 180
 181 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
 182
 183 /* Blocks
 184  *
 185  */
 186 struct ast_block_s
 187 {
 188     ast_expression_common expression;
 189
 190     MEM_VECTOR_MAKE(ast_value*,      locals);
 191     MEM_VECTOR_MAKE(ast_expression*, exprs);
 192 };
 193 ast_block* ast_block_new(lex_ctx ctx);
 194 void ast_block_delete(ast_block*);
 195
 196 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
 197 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
 198
 199 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
 200
 201 /* Function
 202  *
 203  * Contains a list of blocks... at least in theory.
 204  * Usually there's just the main block, other blocks are inside that.
 205  *
 206  * Technically, functions don't need to be an AST node, since we have
 207  * neither functions inside functions, nor lambdas, and function
 208  * pointers could just work with a name. However, this way could be
 209  * more flexible, and adds no real complexity.
 210  */
 211 struct ast_function_s
 212 {
 213     ast_node_common node;
 214
 215     ast_value  *vtype;
 216     const char *name;
 217
 218     ir_function *ir_func;
 219
 220     MEM_VECTOR_MAKE(ast_block*, blocks);
 221 };
 222 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
 223 /* This will NOT delete the underlying ast_value */
 224 void ast_function_delete(ast_function*);
 225
 226 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
 227
 228 bool ast_function_codegen(ast_function *self, ir_builder *builder);
 229
 230 /* Expression union
 231  */
 232 union ast_expression_u
 233 {
 234     ast_expression_common expression;
 235
 236     ast_binary binary;
 237     ast_block  block;
 238 };
 239
 240 /* Node union
 241  */
 242 union ast_node_u
 243 {
 244     ast_node_common node;
 245     ast_expression  expression;
 246 };
 247
 248 #endif