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