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