]> git.xonotic.org Git - xonotic/gmqcc.git/blobdiff - ast.h
Added test for variadic arguments
[xonotic/gmqcc.git] / ast.h
diff --git a/ast.h b/ast.h
index 9609a08d678600d2a44fe4b741203c40e5da0b4f..16f980709d518f3eddf66b7120b90d2f71b928d6 100644 (file)
--- a/ast.h
+++ b/ast.h
 typedef union ast_node_u ast_node;
 typedef union ast_expression_u ast_expression;
 
-typedef struct ast_value_s      ast_value;
-typedef struct ast_function_s   ast_function;
-typedef struct ast_block_s      ast_block;
-typedef struct ast_binary_s     ast_binary;
-typedef struct ast_store_s      ast_store;
-typedef struct ast_entfield_s   ast_entfield;
-typedef struct ast_ifthen_s     ast_ifthen;
-typedef struct ast_ternary_s    ast_ternary;
+typedef struct ast_value_s       ast_value;
+typedef struct ast_function_s    ast_function;
+typedef struct ast_block_s       ast_block;
+typedef struct ast_binary_s      ast_binary;
+typedef struct ast_store_s       ast_store;
+typedef struct ast_binstore_s    ast_binstore;
+typedef struct ast_entfield_s    ast_entfield;
+typedef struct ast_ifthen_s      ast_ifthen;
+typedef struct ast_ternary_s     ast_ternary;
+typedef struct ast_loop_s        ast_loop;
+typedef struct ast_call_s        ast_call;
+typedef struct ast_unary_s       ast_unary;
+typedef struct ast_return_s      ast_return;
+typedef struct ast_member_s      ast_member;
+typedef struct ast_array_index_s ast_array_index;
+
+enum {
+    TYPE_ast_node,
+    TYPE_ast_expression,
+    TYPE_ast_value,
+    TYPE_ast_function,
+    TYPE_ast_block,
+    TYPE_ast_binary,
+    TYPE_ast_store,
+    TYPE_ast_binstore,
+    TYPE_ast_entfield,
+    TYPE_ast_ifthen,
+    TYPE_ast_ternary,
+    TYPE_ast_loop,
+    TYPE_ast_call,
+    TYPE_ast_unary,
+    TYPE_ast_return,
+    TYPE_ast_member,
+    TYPE_ast_array_index
+};
+
+#define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
+#define ast_ctx(node) (((ast_node_common*)(node))->context)
 
 /* Node interface with common components
  */
@@ -48,6 +78,7 @@ typedef struct
     lex_ctx          context;
     /* I don't feel comfortable using keywords like 'delete' as names... */
     ast_node_delete *destroy;
+    int              nodetype;
     /* keep: if a node contains this node, 'keep'
      * prevents its dtor from destroying this node as well.
      */
@@ -71,10 +102,33 @@ typedef bool ast_expression_codegen(ast_expression*,
                                     ast_function*,
                                     bool lvalue,
                                     ir_value**);
+/* TODO: the codegen function should take an output-type parameter
+ * indicating whether a variable, type, label etc. is expected, and
+ * an environment!
+ * Then later an ast_ident could have a codegen using this to figure
+ * out what to look for.
+ * eg. in code which uses a not-yet defined variable, the expression
+ * would take an ast_ident, and the codegen would be called with
+ * type `expression`, so the ast_ident's codegen would search for
+ * variables through the environment (or functions, constants...).
+ */
 typedef struct
 {
     ast_node_common         node;
     ast_expression_codegen *codegen;
+    int                     vtype;
+    ast_expression         *next;
+    /* arrays get a member-count */
+    size_t                  count;
+    ast_value*             *params;
+    bool                    variadic;
+    /* The codegen functions should store their output values
+     * so we can call it multiple times without re-evaluating.
+     * Store lvalue and rvalue seperately though. So that
+     * ast_entfield for example can generate both if required.
+     */
+    ir_value               *outl;
+    ir_value               *outr;
 } ast_expression_common;
 
 /* Value
@@ -90,8 +144,10 @@ struct ast_value_s
 
     const char *name;
 
+    /*
     int         vtype;
     ast_value  *next;
+    */
 
     bool isconst;
     union {
@@ -103,22 +159,36 @@ struct ast_value_s
         ast_function *vfunc;
     } constval;
 
+    /* usecount for the parser */
+    size_t uses;
+
     ir_value *ir_v;
+    ir_value **ir_values;
+    size_t   ir_value_count;
 
-    /* if vtype is qc_function, params contain parameters, and
-     * 'next' the return type.
-     */
-    MEM_VECTOR_MAKE(ast_value*, params);
+    /* ONLY for arrays in progs version up to 6 */
+    ast_value *setter;
+    ast_value *getter;
 };
+
 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
+ast_value* ast_value_copy(const ast_value *self);
 /* This will NOT delete an underlying ast_function */
 void ast_value_delete(ast_value*);
 
 bool ast_value_set_name(ast_value*, const char *name);
 
 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
-bool ast_local_codegen(ast_value *self, ir_function *func);
-bool ast_global_codegen(ast_value *self, ir_builder *ir);
+bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
+bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
+
+void ast_value_params_add(ast_value*, ast_value*);
+
+bool ast_compare_type(ast_expression *a, ast_expression *b);
+ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
+#define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
+bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
+void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
 
 /* Binary
  *
@@ -140,6 +210,64 @@ void ast_binary_delete(ast_binary*);
 
 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
 
+/* Binstore
+ *
+ * An assignment including a binary expression with the source as left operand.
+ * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
+ */
+struct ast_binstore_s
+{
+    ast_expression_common expression;
+
+    int             opstore;
+    int             opbin;
+    ast_expression *dest;
+    ast_expression *source;
+};
+ast_binstore* ast_binstore_new(lex_ctx    ctx,
+                               int        storeop,
+                               int        op,
+                               ast_expression *left,
+                               ast_expression *right);
+void ast_binstore_delete(ast_binstore*);
+
+bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
+
+/* Unary
+ *
+ * Regular unary expressions: not,neg
+ */
+struct ast_unary_s
+{
+    ast_expression_common expression;
+
+    int             op;
+    ast_expression *operand;
+};
+ast_unary* ast_unary_new(lex_ctx    ctx,
+                         int        op,
+                         ast_expression *expr);
+void ast_unary_delete(ast_unary*);
+
+bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
+
+/* Return
+ *
+ * Make sure 'return' only happens at the end of a block, otherwise the IR
+ * will refuse to create further instructions.
+ * This should be honored by the parser.
+ */
+struct ast_return_s
+{
+    ast_expression_common expression;
+    ast_expression *operand;
+};
+ast_return* ast_return_new(lex_ctx    ctx,
+                           ast_expression *expr);
+void ast_return_delete(ast_return*);
+
+bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
+
 /* Entity-field
  *
  * This must do 2 things:
@@ -162,10 +290,48 @@ struct ast_entfield_s
     ast_expression *field;
 };
 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
+ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
 void ast_entfield_delete(ast_entfield*);
 
 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
 
+/* Member access:
+ *
+ * For now used for vectors. If we get structs or unions
+ * we can have them handled here as well.
+ */
+struct ast_member_s
+{
+    ast_expression_common expression;
+    ast_expression *owner;
+    unsigned int    field;
+};
+ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field);
+void ast_member_delete(ast_member*);
+
+bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
+
+/* Array index access:
+ *
+ * QC forces us to take special action on arrays:
+ * an ast_store on an ast_array_index must not codegen the index,
+ * but call its setter - unless we have an instruction set which supports
+ * what we need.
+ * Any other array index access will be codegened to a call to the getter.
+ * In any case, accessing an element via a compiletime-constant index will
+ * result in quick access to that variable.
+ */
+struct ast_array_index_s
+{
+    ast_expression_common expression;
+    ast_expression *array;
+    ast_expression *index;
+};
+ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
+void ast_array_index_delete(ast_array_index*);
+
+bool ast_array_index_codegen(ast_array_index*, ast_function*, bool lvalue, ir_value**);
+
 /* Store
  *
  * Stores left<-right and returns left.
@@ -175,11 +341,11 @@ struct ast_store_s
 {
     ast_expression_common expression;
     int             op;
-    ast_value      *dest; /* When we add pointers this might have to change to expression */
+    ast_expression *dest;
     ast_expression *source;
 };
 ast_store* ast_store_new(lex_ctx ctx, int op,
-                         ast_value *d, ast_expression *s);
+                         ast_expression *d, ast_expression *s);
 void ast_store_delete(ast_store*);
 
 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
@@ -237,6 +403,69 @@ void ast_ternary_delete(ast_ternary*);
 
 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
 
+/* A general loop node
+ *
+ * For convenience it contains 4 parts:
+ * -) (ini) = initializing expression
+ * -) (pre) = pre-loop condition
+ * -) (pst) = post-loop condition
+ * -) (inc) = "increment" expression
+ * The following is a psudo-representation of this loop
+ * note that '=>' bears the logical meaning of "implies".
+ * (a => b) equals (!a || b)
+
+{ini};
+while (has_pre => {pre})
+{
+    {body};
+
+continue:      // a 'continue' will jump here
+    if (has_pst => {pst})
+        break;
+
+    {inc};
+}
+ */
+struct ast_loop_s
+{
+    ast_expression_common expression;
+    ast_expression *initexpr;
+    ast_expression *precond;
+    ast_expression *postcond;
+    ast_expression *increment;
+    ast_expression *body;
+};
+ast_loop* ast_loop_new(lex_ctx ctx,
+                       ast_expression *initexpr,
+                       ast_expression *precond,
+                       ast_expression *postcond,
+                       ast_expression *increment,
+                       ast_expression *body);
+void ast_loop_delete(ast_loop*);
+
+bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
+
+/* CALL node
+ *
+ * Contains an ast_expression as target, rather than an ast_function/value.
+ * Since it's how QC works, every ast_function has an ast_value
+ * associated anyway - in other words, the VM contains function
+ * pointers for every function anyway. Thus, this node will call
+ * expression.
+ * Additionally it contains a list of ast_expressions as parameters.
+ * Since calls can return values, an ast_call is also an ast_expression.
+ */
+struct ast_call_s
+{
+    ast_expression_common expression;
+    ast_expression *func;
+    ast_expression* *params;
+};
+ast_call* ast_call_new(lex_ctx ctx,
+                       ast_expression *funcexpr);
+void ast_call_delete(ast_call*);
+bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
+bool ast_call_check_types(ast_call*);
 
 /* Blocks
  *
@@ -245,16 +474,16 @@ struct ast_block_s
 {
     ast_expression_common expression;
 
-    MEM_VECTOR_MAKE(ast_value*,      locals);
-    MEM_VECTOR_MAKE(ast_expression*, exprs);
+    ast_value*      *locals;
+    ast_expression* *exprs;
+    ast_expression* *collect;
 };
 ast_block* ast_block_new(lex_ctx ctx);
 void ast_block_delete(ast_block*);
-
-MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
-MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
+bool ast_block_set_type(ast_block*, ast_expression *from);
 
 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
+void ast_block_collect(ast_block*, ast_expression*);
 
 /* Function
  *
@@ -273,16 +502,29 @@ struct ast_function_s
     ast_value  *vtype;
     const char *name;
 
+    int builtin;
+
     ir_function *ir_func;
     ir_block    *curblock;
+    ir_block    *breakblock;
+    ir_block    *continueblock;
 
-    MEM_VECTOR_MAKE(ast_block*, blocks);
+    size_t       labelcount;
+    /* in order for thread safety - for the optional
+     * channel abesed multithreading... keeping a buffer
+     * here to use in ast_function_label.
+     */
+    char         labelbuf[64];
+
+    ast_block* *blocks;
 };
 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
 /* This will NOT delete the underlying ast_value */
 void ast_function_delete(ast_function*);
-
-MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
+/* For "optimized" builds this can just keep returning "foo"...
+ * or whatever...
+ */
+const char* ast_function_label(ast_function*, const char *prefix);
 
 bool ast_function_codegen(ast_function *self, ir_builder *builder);
 
@@ -292,8 +534,13 @@ union ast_expression_u
 {
     ast_expression_common expression;
 
-    ast_binary binary;
-    ast_block  block;
+    ast_value    value;
+    ast_binary   binary;
+    ast_block    block;
+    ast_ternary  ternary;
+    ast_ifthen   ifthen;
+    ast_store    store;
+    ast_entfield entfield;
 };
 
 /* Node union