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