/*
- * Copyright (C) 2012
+ * Copyright (C) 2012, 2013
* Wolfgang Bumiller
+ * Dale Weiler
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* "main" ast node types for now.
*/
-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_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_node_common ast_node;
+typedef struct ast_expression_common 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_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;
+typedef struct ast_breakcont_s ast_breakcont;
+typedef struct ast_switch_s ast_switch;
+typedef struct ast_label_s ast_label;
+typedef struct ast_goto_s ast_goto;
+typedef struct ast_argpipe_s ast_argpipe;
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_node, /* 0 */
+ TYPE_ast_expression, /* 1 */
+ TYPE_ast_value, /* 2 */
+ TYPE_ast_function, /* 3 */
+ TYPE_ast_block, /* 4 */
+ TYPE_ast_binary, /* 5 */
+ TYPE_ast_store, /* 6 */
+ TYPE_ast_binstore, /* 7 */
+ TYPE_ast_entfield, /* 8 */
+ TYPE_ast_ifthen, /* 9 */
+ TYPE_ast_ternary, /* 10 */
+ TYPE_ast_loop, /* 11 */
+ TYPE_ast_call, /* 12 */
+ TYPE_ast_unary, /* 13 */
+ TYPE_ast_return, /* 14 */
+ TYPE_ast_member, /* 15 */
+ TYPE_ast_array_index, /* 16 */
+ TYPE_ast_breakcont, /* 17 */
+ TYPE_ast_switch, /* 18 */
+ TYPE_ast_label, /* 19 */
+ TYPE_ast_goto, /* 20 */
+ TYPE_ast_argpipe /* 21 */
};
-#define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
-#define ast_ctx(node) (((ast_node_common*)(node))->context)
+#define ast_istype(x, t) ( ((ast_node*)x)->nodetype == (TYPE_##t) )
+#define ast_ctx(node) (((ast_node*)(node))->context)
+#define ast_side_effects(node) (((ast_node*)(node))->side_effects)
/* Node interface with common components
*/
typedef void ast_node_delete(ast_node*);
-typedef struct
+struct ast_node_common
{
- lex_ctx context;
+ lex_ctx_t context;
/* I don't feel comfortable using keywords like 'delete' as names... */
ast_node_delete *destroy;
int nodetype;
* prevents its dtor from destroying this node as well.
*/
bool keep;
-} ast_node_common;
-
-#define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
-#define ast_unref(x) do \
-{ \
- if (! (((ast_node*)(x))->node.keep) ) { \
- ast_delete(x); \
- } \
+ bool side_effects;
+};
+
+#define ast_delete(x) (*( ((ast_node*)(x))->destroy ))((ast_node*)(x))
+#define ast_unref(x) do \
+{ \
+ if (! (((ast_node*)(x))->keep) ) { \
+ ast_delete(x); \
+ } \
} while(0)
/* Expression interface
ast_function*,
bool lvalue,
ir_value**);
-typedef struct
+/* 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...).
+ */
+struct ast_expression_common
{
- ast_node_common node;
+ ast_node node;
ast_expression_codegen *codegen;
int vtype;
ast_expression *next;
- MEM_VECTOR_MAKE(ast_value*, params);
- bool variadic;
+ /* arrays get a member-count */
+ size_t count;
+ ast_value* *params;
+ uint32_t flags;
+ /* void foo(string...) gets varparam set as a restriction
+ * for variadic parameters
+ */
+ ast_expression *varparam;
/* 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
*/
ir_value *outl;
ir_value *outr;
-} ast_expression_common;
-MEM_VECTOR_PROTO(ast_expression_common, ast_value*, params);
+};
+#define AST_FLAG_VARIADIC (1<<0)
+#define AST_FLAG_NORETURN (1<<1)
+#define AST_FLAG_INLINE (1<<2)
+#define AST_FLAG_INITIALIZED (1<<3)
+#define AST_FLAG_DEPRECATED (1<<4)
+#define AST_FLAG_INCLUDE_DEF (1<<5)
+#define AST_FLAG_IS_VARARG (1<<6)
+#define AST_FLAG_ALIAS (1<<7)
+/* An array declared as []
+ * so that the size is taken from the initializer */
+#define AST_FLAG_ARRAY_INIT (1<<8)
+#define AST_FLAG_TYPE_MASK (AST_FLAG_VARIADIC | AST_FLAG_NORETURN)
/* Value
*
* typedef float foo;
* is like creating a 'float foo', foo serving as the type's name.
*/
+typedef union {
+ double vfloat;
+ int vint;
+ vec3_t vvec;
+ const char *vstring;
+ int ventity;
+ ast_function *vfunc;
+ ast_value *vfield;
+} basic_value_t;
struct ast_value_s
{
- ast_expression_common expression;
+ ast_expression expression;
const char *name;
+ const char *desc;
+
+ const char *argcounter;
+
+ int cvq; /* const/var qualifier */
+ bool isfield; /* this declares a field */
+ bool isimm; /* an immediate, not just const */
+ bool hasvalue;
+ basic_value_t constval;
+ /* for TYPE_ARRAY we have an optional vector
+ * of constants when an initializer list
+ * was provided.
+ */
+ basic_value_t *initlist;
- /*
- int vtype;
- ast_value *next;
- */
-
- bool isconst;
- union {
- double vfloat;
- int vint;
- vector vvec;
- const char *vstring;
- int ventity;
- ast_function *vfunc;
- } constval;
+ /* usecount for the parser */
+ size_t uses;
ir_value *ir_v;
+ ir_value **ir_values;
+ size_t ir_value_count;
+
+ /* 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_new(lex_ctx_t 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 isparam);
-bool ast_global_codegen(ast_value *self, ir_builder *ir);
+*/
+
+bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
-bool GMQCC_WARN ast_value_params_add(ast_value*, ast_value*);
+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);
+ast_expression* ast_type_copy(lex_ctx_t 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_adopt_impl(ast_expression *self, const ast_expression *other);
+void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
+
+typedef enum ast_binary_ref_s {
+ AST_REF_NONE = 0,
+ AST_REF_LEFT = 1 << 1,
+ AST_REF_RIGHT = 1 << 2,
+ AST_REF_ALL = (AST_REF_LEFT | AST_REF_RIGHT)
+} ast_binary_ref;
+
/* Binary
*
*/
struct ast_binary_s
{
- ast_expression_common expression;
+ ast_expression expression;
int op;
ast_expression *left;
ast_expression *right;
+ ast_binary_ref refs;
+
};
-ast_binary* ast_binary_new(lex_ctx ctx,
+ast_binary* ast_binary_new(lex_ctx_t ctx,
int op,
ast_expression *left,
ast_expression *right);
-void ast_binary_delete(ast_binary*);
-
-bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
/* Binstore
*
*/
struct ast_binstore_s
{
- ast_expression_common expression;
+ ast_expression expression;
int opstore;
int opbin;
ast_expression *dest;
ast_expression *source;
+ /* for &~= which uses the destination in a binary in source we can use this */
+ bool keep_dest;
};
-ast_binstore* ast_binstore_new(lex_ctx ctx,
+ast_binstore* ast_binstore_new(lex_ctx_t 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
*
*/
struct ast_unary_s
{
- ast_expression_common expression;
+ ast_expression expression;
int op;
ast_expression *operand;
};
-ast_unary* ast_unary_new(lex_ctx ctx,
+ast_unary* ast_unary_new(lex_ctx_t 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
*
*/
struct ast_return_s
{
- ast_expression_common expression;
+ ast_expression expression;
ast_expression *operand;
};
-ast_return* ast_return_new(lex_ctx ctx,
+ast_return* ast_return_new(lex_ctx_t ctx,
ast_expression *expr);
-void ast_return_delete(ast_return*);
-
-bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
/* Entity-field
*
*/
struct ast_entfield_s
{
- ast_expression_common expression;
+ ast_expression expression;
/* The entity can come from an expression of course. */
ast_expression *entity;
/* As can the field, it just must result in a value of TYPE_FIELD */
ast_expression *field;
};
-ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
-void ast_entfield_delete(ast_entfield*);
-
-bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
+ast_entfield* ast_entfield_new(lex_ctx_t ctx, ast_expression *entity, ast_expression *field);
+ast_entfield* ast_entfield_new_force(lex_ctx_t ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
/* Member access:
*
*/
struct ast_member_s
{
- ast_expression_common expression;
+ ast_expression expression;
ast_expression *owner;
unsigned int field;
+ const char *name;
+ bool rvalue;
};
-ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field);
+ast_member* ast_member_new(lex_ctx_t ctx, ast_expression *owner, unsigned int field, const char *name);
void ast_member_delete(ast_member*);
+bool ast_member_set_name(ast_member*, const char *name);
-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 expression;
+ ast_expression *array;
+ ast_expression *index;
+};
+ast_array_index* ast_array_index_new(lex_ctx_t ctx, ast_expression *array, ast_expression *index);
+
+/* Vararg pipe node:
+ *
+ * copy all varargs starting from a specific index
+ */
+struct ast_argpipe_s
+{
+ ast_expression expression;
+ ast_expression *index;
+};
+ast_argpipe* ast_argpipe_new(lex_ctx_t ctx, ast_expression *index);
/* Store
*
*/
struct ast_store_s
{
- ast_expression_common expression;
+ ast_expression expression;
int op;
ast_expression *dest;
ast_expression *source;
};
-ast_store* ast_store_new(lex_ctx ctx, int op,
+ast_store* ast_store_new(lex_ctx_t ctx, int op,
ast_expression *d, ast_expression *s);
-void ast_store_delete(ast_store*);
-
-bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
/* If
*
*/
struct ast_ifthen_s
{
- ast_expression_common expression;
+ ast_expression expression;
ast_expression *cond;
/* It's all just 'expressions', since an ast_block is one too. */
ast_expression *on_true;
ast_expression *on_false;
};
-ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
-void ast_ifthen_delete(ast_ifthen*);
-
-bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
+ast_ifthen* ast_ifthen_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
/* Ternary expressions...
*
*/
struct ast_ternary_s
{
- ast_expression_common expression;
+ ast_expression expression;
ast_expression *cond;
/* It's all just 'expressions', since an ast_block is one too. */
ast_expression *on_true;
ast_expression *on_false;
- /* After a ternary expression we find ourselves in a new IR block
- * and start with a PHI node */
- ir_value *phi_out;
};
-ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
-void ast_ternary_delete(ast_ternary*);
-
-bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
+ast_ternary* ast_ternary_new(lex_ctx_t ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
/* A general loop node
*
*/
struct ast_loop_s
{
- ast_expression_common expression;
+ ast_expression expression;
ast_expression *initexpr;
ast_expression *precond;
ast_expression *postcond;
ast_expression *increment;
ast_expression *body;
+ /* For now we allow a seperate flag on whether or not the condition
+ * is supposed to be true or false.
+ * That way, the parser can generate a 'while not(!x)' for `while(x)`
+ * if desired, which is useful for the new -f{true,false}-empty-strings
+ * flag.
+ */
+ bool pre_not;
+ bool post_not;
};
-ast_loop* ast_loop_new(lex_ctx ctx,
+ast_loop* ast_loop_new(lex_ctx_t ctx,
ast_expression *initexpr,
- ast_expression *precond,
- ast_expression *postcond,
+ ast_expression *precond, bool pre_not,
+ ast_expression *postcond, bool post_not,
ast_expression *increment,
ast_expression *body);
-void ast_loop_delete(ast_loop*);
-bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
+/* Break/Continue
+ */
+struct ast_breakcont_s
+{
+ ast_expression expression;
+ bool is_continue;
+ unsigned int levels;
+};
+ast_breakcont* ast_breakcont_new(lex_ctx_t ctx, bool iscont, unsigned int levels);
+
+/* Switch Statements
+ *
+ * A few notes about this: with the original QCVM, no real optimization
+ * is possible. The SWITCH instruction set isn't really helping a lot, since
+ * it only collapes the EQ and IF instructions into one.
+ * Note: Declaring local variables inside caseblocks is normal.
+ * Since we don't have to deal with a stack there's no unnatural behaviour to
+ * be expected from it.
+ * TODO: Ticket #20
+ */
+typedef struct {
+ ast_expression *value; /* #20 will replace this */
+ ast_expression *code;
+} ast_switch_case;
+struct ast_switch_s
+{
+ ast_expression expression;
+
+ ast_expression *operand;
+ ast_switch_case *cases;
+};
+
+ast_switch* ast_switch_new(lex_ctx_t ctx, ast_expression *op);
+
+/* Label nodes
+ *
+ * Introduce a label which can be used together with 'goto'
+ */
+struct ast_label_s
+{
+ ast_expression expression;
+ const char *name;
+ ir_block *irblock;
+ ast_goto **gotos;
+ /* means it has not yet been defined */
+ bool undefined;
+};
+
+ast_label* ast_label_new(lex_ctx_t ctx, const char *name, bool undefined);
+
+/* GOTO nodes
+ *
+ * Go to a label, the label node is filled in at a later point!
+ */
+struct ast_goto_s
+{
+ ast_expression expression;
+ const char *name;
+ ast_label *target;
+ ir_block *irblock_from;
+};
+
+ast_goto* ast_goto_new(lex_ctx_t ctx, const char *name);
+void ast_goto_set_label(ast_goto*, ast_label*);
/* CALL node
*
*/
struct ast_call_s
{
- ast_expression_common expression;
+ ast_expression expression;
ast_expression *func;
- MEM_VECTOR_MAKE(ast_expression*, params);
+ ast_expression* *params;
+ ast_expression *va_count;
};
-ast_call* ast_call_new(lex_ctx ctx,
+ast_call* ast_call_new(lex_ctx_t ctx,
ast_expression *funcexpr);
-void ast_call_delete(ast_call*);
-bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
-
-MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
+bool ast_call_check_types(ast_call*, ast_expression *this_func_va_type);
/* Blocks
*
*/
struct ast_block_s
{
- ast_expression_common expression;
+ ast_expression expression;
- MEM_VECTOR_MAKE(ast_value*, locals);
- MEM_VECTOR_MAKE(ast_expression*, exprs);
- MEM_VECTOR_MAKE(ast_expression*, collect);
+ ast_value* *locals;
+ ast_expression* *exprs;
+ ast_expression* *collect;
};
-ast_block* ast_block_new(lex_ctx ctx);
+ast_block* ast_block_new(lex_ctx_t ctx);
void ast_block_delete(ast_block*);
-bool ast_block_set_type(ast_block*, ast_expression *from);
+void ast_block_set_type(ast_block*, ast_expression *from);
+void ast_block_collect(ast_block*, ast_expression*);
-MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
-MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
-MEM_VECTOR_PROTO(ast_block, ast_expression*, collect);
-
-bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
-bool ast_block_collect(ast_block*, ast_expression*);
+bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
/* Function
*
*/
struct ast_function_s
{
- ast_node_common node;
+ ast_node node;
ast_value *vtype;
const char *name;
ir_function *ir_func;
ir_block *curblock;
- ir_block *breakblock;
- ir_block *continueblock;
+ ir_block **breakblocks;
+ ir_block **continueblocks;
+
+#if 0
+ /* In order for early-out logic not to go over
+ * excessive jumps, we remember their target
+ * blocks...
+ */
+ ir_block *iftrue;
+ ir_block *iffalse;
+#endif
size_t labelcount;
/* in order for thread safety - for the optional
*/
char labelbuf[64];
- MEM_VECTOR_MAKE(ast_block*, blocks);
+ ast_block* *blocks;
+
+ ast_value *varargs;
+ ast_value *argc;
+ ast_value *fixedparams;
+ ast_value *return_value;
};
-ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
+ast_function* ast_function_new(lex_ctx_t ctx, const char *name, ast_value *vtype);
/* This will NOT delete the underlying ast_value */
void ast_function_delete(ast_function*);
/* For "optimized" builds this can just keep returning "foo"...
* or whatever...
*/
-const char* ast_function_label(ast_function*, const char *prefix);
-
-MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
+/*const char* ast_function_label(ast_function*, const char *prefix);*/
bool ast_function_codegen(ast_function *self, ir_builder *builder);
-
-/* Expression union
- */
-union ast_expression_u
-{
- ast_expression_common expression;
-
- ast_value value;
- ast_binary binary;
- ast_block block;
- ast_ternary ternary;
- ast_ifthen ifthen;
- ast_store store;
- ast_entfield entfield;
-};
-
-/* Node union
- */
-union ast_node_u
-{
- ast_node_common node;
- ast_expression expression;
-};
+bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
#endif
projects / xonotic / gmqcc.git / blobdiff