]> git.xonotic.org Git - xonotic/gmqcc.git/blobdiff - gmqcc.h
Updated README
[xonotic/gmqcc.git] / gmqcc.h
diff --git a/gmqcc.h b/gmqcc.h
index 43d90df396158d7d21fbba788138b64eef35bee2..e5d1a5603bb5965cb7d31c9eedab700771063161 100644 (file)
--- a/gmqcc.h
+++ b/gmqcc.h
  */
 #ifndef GMQCC_HDR
 #define GMQCC_HDR
+#include <limits.h>
+#include <stdlib.h>
+#include <string.h>
 #include <stdio.h>
-
-/* The types supported by the language */
-#define TYPE_VOID     0
-#define TYPE_STRING   1
-#define TYPE_FLOAT    2
-#define TYPE_VECTOR   3
-#define TYPE_ENTITY   4
-#define TYPE_FIELD    5
-#define TYPE_FUNCTION 6
-#define TYPE_POINTER  7
-
+#include <ctype.h>
 /*
- * there are 3 accessible memory zones -
- * globals
- *     array of 32bit ints/floats, mixed, LE,
- * entities
- *     structure is up to the engine but the fields are a linear array
- *     of mixed ints/floats, there are globals referring to the offsets
- *     of these in the entity struct so there are ADDRESS and STOREP and
- *     LOAD instructions that use globals containing field offsets.
- * strings
- *     a static array in the progs.dat, with file parsing creating
- *     additional constants, and some engine fields are mapped by 
- *     address as well to unique string offsets
+ * stdint.h and inttypes.h -less subset
+ * for systems that don't have it, which we must
+ * assume is all systems. (int8_t not required)
  */
-/* 
- * Instructions 
- * These are the external instructions supported by the interperter
- * this is what things compile to (from the C code). This is not internal
- * instructions for support like int, and such (which are translated)
- */
-#define INSTR_DONE      0
-// math
-#define INSTR_MUL_F     1 /* multiplication float         */
-#define INSTR_MUL_V     2 /* multiplication vector        */
-#define INSTR_MUL_FV    3 /* multiplication float->vector */
-#define INSTR_MUL_VF    4 /* multiplication vector->float */
-#define INSTR_DIV_F     5
-#define INSTR_ADD_F     6
-#define INSTR_ADD_V     7
-#define INSTR_SUB_F     8
-#define INSTR_SUB_V     9
-// compare
-#define INSTR_EQ_F      10
-#define INSTR_EQ_V      11
-#define INSTR_EQ_S      12
-#define INSTR_EQ_E      13
-#define INSTR_EQ_FNC    14
-#define INSTR_NE_F      15
-#define INSTR_NE_V      16
-#define INSTR_NE_S      17
-#define INSTR_NE_E      18
-#define INSTR_NE_FNC    19
-// multi compare
-#define INSTR_LE        20
-#define INSTR_GE        21
-#define INSTR_LT        22
-#define INSTR_GT        23
-// load and store
-#define INSTR_LOAD_F    24
-#define INSTR_LOAD_V    25
-#define INSTR_LOAD_S    26
-#define INSTR_LOAD_ENT  27
-#define INSTR_LOAD_FLD  28
-#define INSTR_LOAD_FNC  29
-#define INSTR_STORE_F   31
-#define INSTR_STORE_V   32
-#define INSTR_STORE_S   33
-#define INSTR_STORE_ENT 34
-#define INSTR_STORE_FLD 35
-#define INSTR_STORE_FNC 36
-// others
-#define INSTR_ADDRESS   30
-#define INSTR_RETURN    37
-#define INSTR_NOT_F     38
-#define INSTR_NOT_V     39
-#define INSTR_NOT_S     40
-#define INSTR_NOT_ENT   41
-#define INSTR_NOT_FNC   42
-#define INSTR_IF        43
-#define INSTR_IFNOT     44
-#define INSTR_CALL0     45
-#define INSTR_CALL1     46
-#define INSTR_CALL2     47
-#define INSTR_CALL3     48
-#define INSTR_CALL4     49
-#define INSTR_CALL5     50
-#define INSTR_CALL6     51
-#define INSTR_CALL7     52
-#define INSTR_CALL8     53
-#define INSTR_STATE     54
-#define INSTR_GOTO      55
-#define INSTR_AND       56
-#define INSTR_OR        57
-#define INSTR_BITAND    59
-#define INSTR_BITOR     60
+#if   CHAR_MIN  == -128
+       typedef unsigned char  uint8_t; /* same as below */
+#elif SCHAR_MIN == -128
+       typedef unsigned char  uint8_t; /* same as above */
+#endif
+#if   SHRT_MAX  == 0x7FFF
+       typedef short          int16_t;
+       typedef unsigned short uint16_t;
+#elif INT_MAX   == 0x7FFF
+       typedef int            int16_t;
+       typedef unsigned int   uint16_t;
+#endif
+#if   INT_MAX   == 0x7FFFFFFF 
+       typedef int            int32_t;
+       typedef unsigned int   uint32_t;
+#elif LONG_MAX  == 0x7FFFFFFF
+       typedef long           int32_t;
+       typedef unsigned long  uint32_t;
+#endif
+#ifdef _LP64 /* long pointer == 64 */
+       typedef unsigned long  uintptr_t;
+       typedef long           intptr_t;
+#else
+       typedef unsigned int   uintptr_t;
+       typedef int            intptr_t;
+#endif 
+/* Ensure type sizes are correct: */
+typedef char uint8_size_is_correct  [sizeof(uint8_t)  == 1?1:-1];
+typedef char uint16_size_if_correct [sizeof(uint16_t) == 2?1:-1];
+typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
+typedef char int8_size_is_correct   [sizeof(int8_t)   == 1?1:-1];
+typedef char int16_size_if_correct  [sizeof(int16_t)  == 2?1:-1];
+typedef char int32_size_is_correct  [sizeof(int32_t)  == 4?1:-1];
+/* intptr_t / uintptr_t correct size check */
+typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
+typedef char uintptr_size_is_correct[sizeof(uintptr_t)== sizeof(int*)?1:-1];
 
-/*
- * This is the smallest lexer I've ever wrote: and I must say, it's quite
- * more nicer than those large bulky complex parsers that most people write
- * which has some sort of a complex state.
- */
+//===================================================================
+//============================ lex.c ================================
+//===================================================================
 struct lex_file {
-       /*
-        * This is a simple state for lexing, no need to be complex for qc
-        * code.  It's trivial stuff.
-        */
-       FILE *file;
-       char  peek[5]; /* extend for depthier peeks */
-       int   last;
-       int   current;
-       int   length;
-       int   size;
-       long  line;         /* Line the lexer is on                     */
-       char  lastok[8192]; /* No token shall ever be bigger than this! */
+       FILE *file;        /* file handler */
+       char *name;        /* name of file */
+       char  peek  [5];  
+       char  lastok[8192];
+       
+       int   last;    /* last token                   */
+       int   current; /* current token                */
+       int   length;  /* bytes left to parse          */
+       int   size;    /* never changes (size of file) */
+       int   line;    /* what line are we on?         */
 };
 
 /*
@@ -155,60 +99,295 @@ struct lex_file {
 #define TOKEN_GOTO     7
 #define TOKEN_FOR      8   // extension
 #define TOKEN_TYPEDEF  9   // extension
-#define TOKEN_INT      10  // extension
-#define TOKEN_VOID     11
-#define TOKEN_STRING   12
-#define TOKEN_FLOAT    13
-#define TOKEN_VECTOR   14
-#define TOKEN_ENTITY   15
+
+// ensure the token types are out of the
+// bounds of anyothers that may conflict.
+#define TOKEN_FLOAT    110
+#define TOKEN_VECTOR   111
+#define TOKEN_STRING   112
+#define TOKEN_ENTITY   113
+#define TOKEN_VOID     114
 
 /*
  * Lexer state constants, these are numbers for where exactly in
  * the lexing the lexer is at. Or where it decided to stop if a lexer
- * error occurs.
+ * error occurs.  These numbers must be > where the ascii-table ends
+ * and > the last type token which is TOKEN_VOID
  */
-#define LEX_COMMENT    128 /* higher than ascii */
-#define LEX_CHRLIT     129
-#define LEX_STRLIT     130
-#define LEX_IDENT      131
+#define LEX_COMMENT    1128 
+#define LEX_CHRLIT     1129
+#define LEX_STRLIT     1130
+#define LEX_IDENT      1131
 
-int              lex_token(struct lex_file *);
-void             lex_reset(struct lex_file *);
-int              lex_close(struct lex_file *);
-struct lex_file *lex_open (FILE *);
+int              lex_token  (struct lex_file *);
+void             lex_reset  (struct lex_file *);
+void             lex_close  (struct lex_file *);
+struct lex_file *lex_include(struct lex_file *, char *);
+struct lex_file *lex_open   (FILE *);
 
-/* errors */
+//===================================================================
+//========================== error.c ================================
+//===================================================================
 #define ERROR_LEX      (SHRT_MAX+0)
 #define ERROR_PARSE    (SHRT_MAX+1)
 #define ERROR_INTERNAL (SHRT_MAX+2)
 #define ERROR_COMPILER (SHRT_MAX+3)
 #define ERROR_PREPRO   (SHRT_MAX+4)
-int error(int, const char *, ...);
+int error(struct lex_file *, int, const char *, ...);
 
-/* parse.c */
-int parse(struct lex_file *);
-struct parsenode {
-       struct parsenode *next;
-       int               type; /* some token */
-};
+//===================================================================
+//========================== parse.c ================================
+//===================================================================
+int parse_gen(struct lex_file *);
 
-/* typedef.c */
+//===================================================================
+//========================== typedef.c ==============================
+//===================================================================
 typedef struct typedef_node_t {
-       char      *name; /* name of actual type */
+       char      *name;
 } typedef_node;
 
 void          typedef_init();
+void          typedef_clear();
 typedef_node *typedef_find(const char *);
-int           typedef_add (const char *, const char *);
+int           typedef_add (struct lex_file *file, const char *, const char *);
+
+
+//===================================================================
+//=========================== util.c ================================
+//===================================================================
+void *util_memory_a(unsigned int, unsigned int, const char *);
+void  util_memory_d(void       *, unsigned int, const char *);
+char *util_strdup  (const char *);
+char *util_strrq   (char *);
+void  util_debug   (const char *, const char *, ...);
 
-/* alloc.c */
-void *memory_a(unsigned int, unsigned int, const char *);
-void  memory_d(void       *, unsigned int, const char *);
 #ifdef NOTRACK
 #      define mem_a(x) malloc(x)
 #      define mem_d(x) free  (x)
 #else
-#      define mem_a(x) memory_a((x), __LINE__, __FILE__)
-#      define mem_d(x) memory_d((x), __LINE__, __FILE__)
+#      define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
+#      define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
 #endif
+
+#define VECTOR_MAKE(T,N)                                                 \
+    T*     N##_data      = NULL;                                         \
+    long   N##_elements  = 0;                                            \
+    long   N##_allocated = 0;                                            \
+    int    N##_add(T element) {                                          \
+        if (N##_elements == N##_allocated) {                             \
+            if (N##_allocated == 0) {                                    \
+                N##_allocated = 12;                                      \
+            } else {                                                     \
+                N##_allocated *= 2;                                      \
+            }                                                            \
+            void *temp = realloc(N##_data, (N##_allocated * sizeof(T))); \
+            if  (!temp) {                                                \
+                free(temp);                                              \
+                return -1;                                               \
+            }                                                            \
+            N##_data = (T*)temp;                                         \
+        }                                                                \
+        N##_data[N##_elements] = element;                                \
+        return   N##_elements++;                                         \
+    }
+
+//===================================================================
+//=========================== code.c ================================
+//===================================================================
+#define TYPE_VOID     0
+#define TYPE_STRING   1
+#define TYPE_FLOAT    2
+#define TYPE_VECTOR   3
+#define TYPE_ENTITY   4
+#define TYPE_FIELD    5
+#define TYPE_FUNCTION 6
+#define TYPE_POINTER  7
+
+/*
+ * Each paramater incerements by 3 since vector types hold
+ * 3 components (x,y,z).
+ */
+#define        OFS_NULL      0
+#define        OFS_RETURN    1
+#define        OFS_PARM0     (OFS_RETURN+3)
+#define        OFS_PARM1     (OFS_PARM0 +3)
+#define        OFS_PARM2     (OFS_PARM1 +3)
+#define        OFS_PARM3     (OFS_PARM2 +3)
+#define        OFS_PARM4     (OFS_PARM3 +3)
+#define OFS_PARM5     (OFS_PARM4 +3)
+#define OFS_PARM6     (OFS_PARM5 +3)
+#define OFS_PARM7     (OFS_PARM6 +3)
+
+typedef struct {
+       uint16_t opcode;
+       
+       /* operand 1 */
+       union {
+               int16_t  s1; /* signed   */
+               uint16_t u1; /* unsigned */
+       };
+       /* operand 2 */
+       union {
+               int16_t  s2; /* signed   */
+               uint16_t u2; /* unsigned */
+       };
+       /* operand 3 */
+       union {
+               int16_t  s3; /* signed   */
+               uint16_t u3; /* unsigned */
+       };
+       
+       /*
+        * This is the same as the structure in darkplaces
+        * {
+        *     unsigned short op;
+        *     short          a,b,c;
+        * }
+        * But this one is more sane to work with, and the
+        * type sizes are guranteed.
+        */
+} prog_section_statement;
+
+typedef struct {
+       /* The types:
+        * 0 = ev_void
+        * 1 = ev_string
+        * 2 = ev_float
+        * 3 = ev_vector
+        * 4 = ev_entity
+        * 5 = ev_field
+        * 6 = ev_function
+        * 7 = ev_pointer -- engine only
+        * 8 = ev_bad     -- engine only
+        */
+       uint16_t type;
+       uint16_t offset;
+       uint32_t name;
+} prog_section_both;
+typedef prog_section_both prog_section_def;
+typedef prog_section_both prog_section_field;
+
+typedef struct {
+       int32_t   entry;      /* in statement table for instructions  */
+       uint32_t  firstlocal; /* First local in local table           */
+       uint32_t  locals;     /* Total ints of params + locals        */
+       uint32_t  profile;    /* Always zero (engine uses this)       */
+       uint32_t  name;       /* name of function in string table     */
+       uint32_t  file;       /* file of the source file              */
+       uint32_t  nargs;      /* number of arguments                  */
+       uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
+} prog_section_function;
+
+/* 
+ * Instructions 
+ * These are the external instructions supported by the interperter
+ * this is what things compile to (from the C code).
+ */
+enum {
+       INSTR_DONE,
+       INSTR_MUL_F,
+       INSTR_MUL_V,
+       INSTR_MUL_FV,
+       INSTR_MUL_VF,
+       INSTR_DIV_F,
+       INSTR_ADD_F,
+       INSTR_ADD_V,
+       INSTR_SUB_F,
+       INSTR_SUB_V,
+       INSTR_EQ_F,
+       INSTR_EQ_V,
+       INSTR_EQ_S,
+       INSTR_EQ_E,
+       INSTR_EQ_FNC,
+       INSTR_NE_F,
+       INSTR_NE_V,
+       INSTR_NE_S,
+       INSTR_NE_E,
+       INSTR_NE_FNC,
+       INSTR_LE,
+       INSTR_GE,
+       INSTR_LT,
+       INSTR_GT,
+       INSTR_LOAD_F,
+       INSTR_LOAD_V,
+       INSTR_LOAD_S,
+       INSTR_LOAD_ENT,
+       INSTR_LOAD_FLD,
+       INSTR_LOAD_FNC,
+       INSTR_ADDRESS,
+       INSTR_STORE_F,
+       INSTR_STORE_V,
+       INSTR_STORE_S,
+       INSTR_STORE_ENT,
+       INSTR_STORE_FLD,
+       INSTR_STORE_FNC,
+       INSTR_STOREP_F,
+       INSTR_STOREP_V,
+       INSTR_STOREP_S,
+       INSTR_STOREP_ENT,
+       INSTR_STOREP_FLD,
+       INSTR_STOREP_FNC,
+       INSTR_RETURN,
+       INSTR_NOT_F,
+       INSTR_NOT_V,
+       INSTR_NOT_S,
+       INSTR_NOT_ENT,
+       INSTR_NOT_FNC,
+       INSTR_IF,
+       INSTR_IFNOT,
+       INSTR_CALL0,
+       INSTR_CALL1,
+       INSTR_CALL2,
+       INSTR_CALL3,
+       INSTR_CALL4,
+       INSTR_CALL5,
+       INSTR_CALL6,
+       INSTR_CALL7,
+       INSTR_CALL8,
+       INSTR_STATE,
+       INSTR_GOTO,
+       INSTR_AND,
+       INSTR_OR,
+       INSTR_BITAND,
+       INSTR_BITOR
+};
+
+/*
+ * The symbols below are created by the following
+ * expanded macros:
+ * 
+ * VECTOR_MAKE(prog_section_statement, code_statements);
+ * VECTOR_MAKE(prog_section_def,       code_defs      );
+ * VECTOR_MAKE(prog_section_field,     code_fields    );
+ * VECTOR_MAKE(prog_section_function,  code_functions );
+ * VECTOR_MAKE(int,                    code_globals   );
+ * VECTOR_MAKE(char,                   code_strings   );
+ */
+int         code_statements_add(prog_section_statement);
+int         code_defs_add     (prog_section_def);
+int         code_fields_add   (prog_section_field);
+int         code_functions_add(prog_section_function);
+int         code_globals_add  (int);
+int         code_strings_add  (char);
+extern long code_statements_elements;
+extern long code_strings_elements;
+extern long code_globals_elements;
+extern long code_functions_elements;
+extern long code_fields_elements;
+extern long code_defs_elements;
+
+/*
+ * code_write -- writes out the compiled file
+ * code_init  -- prepares the code file
+ */
+void code_write ();
+void code_init  ();
+
+//===================================================================
+//========================= assembler.c =============================
+//===================================================================
+void asm_init (const char *, FILE **);
+void asm_close(FILE *);
+void asm_parse(FILE *);
 #endif