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 #define ast_unref(x) do                     \
  58 {                                           \
  59     if (! (((ast_node*)(x))->node.keep) ) { \
  60         ast_delete(x);                      \
  61     }                                       \
  62 } while(0)
  63
  64 /* Expression interface
  65  *
  66  * Any expression or block returns an ir_value, and needs
  67  * to know the current function.
  68  */
  69 typedef bool ast_expression_codegen(ast_expression*,
  70                                     ast_function*,
  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_t      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_t ctx, const char *name, int qctype, bool keep);
 112 void ast_value_delete(ast_value*);
 113
 114 bool ast_value_set_name(ast_value*, const char *name);
 115
 116 bool ast_value_codegen(ast_value*, ast_function*, ir_value**);
 117
 118 /* Binary
 119  *
 120  * A value-returning binary expression.
 121  */
 122 struct ast_binary_s
 123 {
 124     ast_expression_common expression;
 125
 126     int       op;
 127     ast_value *left;
 128     ast_value *right;
 129 };
 130 ast_binary* ast_binary_new(lex_ctx_t  ctx,
 131                            int        op,
 132                            ast_value *left,
 133                            ast_value *right);
 134 void ast_binary_delete(ast_binary*);
 135
 136 /* hmm, seperate functions?
 137 bool ast_block_codegen(ast_block*, ast_function*, ir_value**);
 138  */
 139 bool ast_binary_codegen(ast_binary*, ast_function*, ir_value**);
 140
 141 /* Store
 142  *
 143  * Stores left<-right and returns left.
 144  * Specialized binary expression node
 145  */
 146 struct ast_store_s
 147 {
 148     ast_expression_common expression;
 149     int       op;
 150     ast_value *dest;
 151     ast_value *source;
 152 };
 153 ast_store* ast_store_new(lex_ctx_t ctx, int op,
 154                          ast_value *d, ast_value *s);
 155 void ast_store_delete(ast_store*);
 156
 157 bool ast_store_codegen(ast_store*, ast_function*, ir_value**);
 158
 159 /* Blocks
 160  *
 161  */
 162 struct ast_block_s
 163 {
 164     ast_expression_common expression;
 165
 166     MEM_VECTOR_MAKE(ast_value*,      locals);
 167     MEM_VECTOR_MAKE(ast_expression*, exprs);
 168 };
 169 ast_block* ast_block_new(lex_ctx_t ctx);
 170 void ast_block_delete(ast_block*);
 171
 172 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
 173 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
 174
 175 bool ast_block_codegen(ast_block*, ast_function*, ir_value**);
 176
 177 /* Function
 178  *
 179  * Contains a list of blocks... at least in theory.
 180  * Usually there's just the main block, other blocks are inside that.
 181  *
 182  * Technically, functions don't need to be an AST node, since we have
 183  * neither functions inside functions, nor lambdas, and function
 184  * pointers could just work with a name. However, this way could be
 185  * more flexible, and adds no real complexity.
 186  */
 187 struct ast_function_s
 188 {
 189     ast_node_common node;
 190
 191     ast_value  *vtype;
 192     const char *name;
 193
 194     MEM_VECTOR_MAKE(ast_block*, blocks);
 195 };
 196 ast_function* ast_function_new(lex_ctx_t ctx, const char *name, ast_value *vtype);
 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