]> git.xonotic.org Git - xonotic/gmqcc.git/blobdiff - gmqcc.h
This should be the tag
[xonotic/gmqcc.git] / gmqcc.h
diff --git a/gmqcc.h b/gmqcc.h
index b1da366a766f053e6e5fcb6efaef77b8a11bf41a..ff74f45163d098c4e33c1f4684b32201ac7dae5c 100644 (file)
--- a/gmqcc.h
+++ b/gmqcc.h
@@ -41,7 +41,7 @@
 #define GMQCC_VERSION \
     GMQCC_VERSION_BUILD(GMQCC_VERSION_MAJOR, GMQCC_VERSION_MINOR, GMQCC_VERSION_PATCH)
 /* Undefine the following on a release-tag: */
-#define GMQCC_VERSION_TYPE_DEVEL
+/*#define GMQCC_VERSION_TYPE_DEVEL*/
 
 /* Full version string in case we need it */
 #ifdef GMQCC_VERSION_TYPE_DEVEL
@@ -81,8 +81,8 @@ GMQCC_IND_STRING(GMQCC_VERSION_PATCH) \
 #   ifdef  true
 #       undef true
 #   endif /*! true  */
-#   define false (0)
-#   define true  (1)
+#   define false (unsigned)(0)
+#   define true  (unsigned)(1)
 #   ifdef __STDC_VERSION__
 #       if __STDC_VERSION__ < 199901L && __GNUC__ < 3
             typedef int  bool;
@@ -106,11 +106,6 @@ GMQCC_IND_STRING(GMQCC_VERSION_PATCH) \
 #   define GMQCC_WARN
 #   define GMQCC_USED
 #endif /*! defined(__GNUC__) || defined (__CLANG__) */
-/*
- * This is a hack to silent clang regarding empty
- * body if statements.
- */
-#define GMQCC_SUPPRESS_EMPTY_BODY do { } while (0)
 
 /*
  * Inline is not supported in < C90, however some compilers
@@ -154,6 +149,16 @@ GMQCC_IND_STRING(GMQCC_VERSION_PATCH) \
 #    define GMQCC_NORETURN
 #endif /*! (defined(__GNUC__) && __GNUC__ >= 2) || defined (__CLANG__) */
 
+#if (defined(__GNUC__)) || defined(__CLANG__)
+#   define GMQCC_LIKELY(X)   __builtin_expect((X), 1)
+#   define GMQCC_UNLIKELY(X) __builtin_expect((X), 0)
+#else
+#   define GMQCC_LIKELY(X)   (X)
+#   define GMQCC_UNLIKELY(X) (X)
+#endif
+
+#define GMQCC_ARRAY_COUNT(X) (sizeof(X) / sizeof((X)[0]))
+
 #ifndef _MSC_VER
 #   include <stdint.h>
 #else
@@ -259,7 +264,7 @@ GMQCC_IND_STRING(GMQCC_VERSION_PATCH) \
 #   include <fcntl.h>
 
     struct dirent {
-        long d_ino;
+        long               d_ino;
         unsigned short     d_reclen;
         unsigned short     d_namlen;
         char               d_name[FILENAME_MAX];
@@ -305,14 +310,34 @@ void *stat_mem_allocate  (size_t, size_t, const char *);
 /*===================================================================*/
 /*=========================== util.c ================================*/
 /*===================================================================*/
+
+/*
+ * Microsoft implements against the spec versions of ctype.h. Which
+ * means what ever the current set locale is will render the actual
+ * results of say isalpha('A') wrong for what ever retarded locale
+ * is used. Simalerly these are also implemented inefficently on
+ * some toolchains and end up becoming actual library calls. Perhaps
+ * this is why tools like yacc provide their own? Regardless implementing
+ * these as functions is equally as silly, the call overhead is not
+ * justified when this could happen on every character from an input
+ * stream. We provide our own as macros for absolute inlinability.
+ */
+#define util_isalpha(a) ((((unsigned)(a)|32)-'a') < 26)
+#define util_isdigit(a) (((unsigned)(a)-'0') < 10)
+#define util_islower(a) (((unsigned)(a)-'a') < 26)
+#define util_isupper(a) (((unsigned)(a)-'A') < 26)
+#define util_isprint(a) (((unsigned)(a)-0x20) < 0x5F)
+#define util_isspace(a) (((a) >= 9 && (a) <= 13) || (a) == ' ')
+
 bool  util_filexists     (const char *);
 bool  util_strupper      (const char *);
 bool  util_strdigit      (const char *);
 void  util_debug         (const char *, const char *, ...);
 void  util_endianswap    (void *,  size_t, unsigned int);
 
-size_t util_strtocmd    (const char *, char *, size_t);
-size_t util_strtononcmd (const char *, char *, size_t);
+size_t util_strtocmd         (const char *, char *, size_t);
+size_t util_strtononcmd      (const char *, char *, size_t);
+size_t util_optimizationtostr(const char *, char *, size_t);
 
 uint16_t util_crc16(uint16_t crc, const char *data, size_t len);
 
@@ -365,17 +390,16 @@ void _util_vec_grow(void **a, size_t i, size_t s);
 #define vec_shrinkto(A,N) ((void)(vec_meta(A)->used  = (N)))
 #define vec_shrinkby(A,N) ((void)(vec_meta(A)->used -= (N)))
 #define vec_append(A,N,S) ((void)(memcpy(vec_add((A), (N)), (S), (N) * sizeof(*(S)))))
-#define vec_upload(X,Y,S) ((void)(memcpy(vec_add((X), (S) * sizeof(*(Y))), (Y), (S) * sizeof(*(Y)))))
 #define vec_remove(A,I,N) ((void)(memmove((A)+(I),(A)+((I)+(N)),sizeof(*(A))*(vec_meta(A)->used-(I)-(N))),vec_meta(A)->used-=(N)))
 
-typedef struct trie_s {
-    void          *value;
-    struct trie_s *entries;
+typedef struct correct_trie_s {
+    void                  *value;
+    struct correct_trie_s *entries;
 } correct_trie_t;
 
 correct_trie_t* correct_trie_new(void);
 
-typedef struct hash_table_t {
+typedef struct hash_table_s {
     size_t                size;
     struct hash_node_t **table;
 } hash_table_t, *ht;
@@ -465,7 +489,6 @@ void  correct_free(correction_t *);
 /*=========================== code.c ================================*/
 /*===================================================================*/
 
-/* TODO: cleanup */
 /* Note: if you change the order, fix type_sizeof in ir.c */
 enum {
     TYPE_VOID     ,
@@ -512,21 +535,21 @@ extern const uint16_t type_not_instr   [TYPE_COUNT];
 typedef struct {
     uint32_t offset;      /* Offset in file of where data begins  */
     uint32_t length;      /* Length of section (how many of)      */
-} prog_section;
+} prog_section_t;
 
 typedef struct {
-    uint32_t     version;      /* Program version (6)     */
-    uint16_t     crc16;
-    uint16_t     skip;
-
-    prog_section statements;   /* prog_section_statement  */
-    prog_section defs;         /* prog_section_def        */
-    prog_section fields;       /* prog_section_field      */
-    prog_section functions;    /* prog_section_function   */
-    prog_section strings;
-    prog_section globals;
-    uint32_t     entfield;     /* Number of entity fields */
-} prog_header;
+    uint32_t       version;      /* Program version (6)     */
+    uint16_t       crc16;
+    uint16_t       skip;
+
+    prog_section_t statements;   /* prog_section_statement  */
+    prog_section_t defs;         /* prog_section_def        */
+    prog_section_t fields;       /* prog_section_field      */
+    prog_section_t functions;    /* prog_section_function   */
+    prog_section_t strings;
+    prog_section_t globals;
+    uint32_t       entfield;     /* Number of entity fields */
+} prog_header_t;
 
 /*
  * Each paramater incerements by 3 since vector types hold
@@ -571,7 +594,7 @@ typedef struct {
      * But this one is more sane to work with, and the
      * type sizes are guranteed.
      */
-} prog_section_statement;
+} prog_section_statement_t;
 
 typedef struct {
     /*
@@ -589,10 +612,10 @@ typedef struct {
     uint16_t type;
     uint16_t offset;
     uint32_t name;
-} prog_section_both;
+} prog_section_both_t;
 
-typedef prog_section_both prog_section_def;
-typedef prog_section_both prog_section_field;
+typedef prog_section_both_t prog_section_def_t;
+typedef prog_section_both_t prog_section_field_t;
 
 /* this is ORed to the type */
 #define DEF_SAVEGLOBAL (1<<15)
@@ -607,7 +630,7 @@ typedef struct {
     uint32_t  file;       /* file of the source file              */
     int32_t   nargs;      /* number of arguments                  */
     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
-} prog_section_function;
+} prog_section_function_t;
 
 /*
  * Instructions
@@ -697,22 +720,26 @@ enum {
     VINSTR_NRCALL
 };
 
-/* uhh? */
-typedef float   qcfloat;
-typedef int32_t qcint;
+/* TODO: elide */
+extern const char *util_instr_str[VINSTR_END];
+
+
+typedef float    qcfloat_t;
+typedef int32_t  qcint_t;
+typedef uint32_t qcuint_t;
 
 typedef struct {
-    prog_section_statement *statements;
-    int                    *linenums;
-    prog_section_def       *defs;
-    prog_section_field     *fields;
-    prog_section_function  *functions;
-    int                    *globals;
-    char                   *chars;
-    uint16_t                crc;
-    uint32_t                entfields;
-    ht                      string_cache;
-    qcint                   string_cached_empty;
+    prog_section_statement_t *statements;
+    int                      *linenums;
+    prog_section_def_t       *defs;
+    prog_section_field_t     *fields;
+    prog_section_function_t  *functions;
+    int                      *globals;
+    char                     *chars;
+    uint16_t                  crc;
+    uint32_t                  entfields;
+    ht                        string_cache;
+    qcint_t                   string_cached_empty;
 } code_t;
 
 /*
@@ -728,8 +755,8 @@ GMQCC_WARN
 code_t   *code_init          (void);
 void      code_cleanup       (code_t *);
 uint32_t  code_genstring     (code_t *, const char *string);
-qcint     code_alloc_field   (code_t *, size_t qcsize);
-void      code_push_statement(code_t *, prog_section_statement *stmt, int linenum);
+qcint_t   code_alloc_field   (code_t *, size_t qcsize);
+void      code_push_statement(code_t *, prog_section_statement_t *stmt, int linenum);
 void      code_pop_statement (code_t *);
 
 /*
@@ -740,7 +767,7 @@ typedef struct {
     const char *file;
     size_t      line;
     size_t      column;
-} lex_ctx;
+} lex_ctx_t;
 
 /*===================================================================*/
 /*============================ con.c ================================*/
@@ -768,8 +795,8 @@ FILE *con_default_err(void);
 
 void con_vprintmsg (int level, const char *name, size_t line, size_t column, const char *msgtype, const char *msg, va_list ap);
 void con_printmsg  (int level, const char *name, size_t line, size_t column, const char *msgtype, const char *msg, ...);
-void con_cvprintmsg(void *ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
-void con_cprintmsg (void *ctx, int lvl, const char *msgtype, const char *msg, ...);
+void con_cvprintmsg(lex_ctx_t ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
+void con_cprintmsg (lex_ctx_t ctx, int lvl, const char *msgtype, const char *msg, ...);
 
 void con_close (void);
 void con_init  (void);
@@ -786,90 +813,12 @@ extern size_t compile_errors;
 extern size_t compile_Werrors;
 extern size_t compile_warnings;
 
-void /********/ compile_error   (lex_ctx ctx, /*LVL_ERROR*/ const char *msg, ...);
-void /********/ vcompile_error  (lex_ctx ctx, /*LVL_ERROR*/ const char *msg, va_list ap);
-bool GMQCC_WARN compile_warning (lex_ctx ctx, int warntype, const char *fmt, ...);
-bool GMQCC_WARN vcompile_warning(lex_ctx ctx, int warntype, const char *fmt, va_list ap);
+void /********/ compile_error   (lex_ctx_t ctx, /*LVL_ERROR*/ const char *msg, ...);
+void /********/ vcompile_error  (lex_ctx_t ctx, /*LVL_ERROR*/ const char *msg, va_list ap);
+bool GMQCC_WARN compile_warning (lex_ctx_t ctx, int warntype, const char *fmt, ...);
+bool GMQCC_WARN vcompile_warning(lex_ctx_t ctx, int warntype, const char *fmt, va_list ap);
 void            compile_show_werrors(void);
 
-/*===================================================================*/
-/*========================= assembler.c =============================*/
-/*===================================================================*/
-/* TODO: remove this ... */
-static const struct {
-    const char  *m; /* menomic     */
-    const size_t o; /* operands    */
-    const size_t l; /* menomic len */
-} asm_instr[] = {
-    { "DONE"      , 1, 4 },
-    { "MUL_F"     , 3, 5 },
-    { "MUL_V"     , 3, 5 },
-    { "MUL_FV"    , 3, 6 },
-    { "MUL_VF"    , 3, 6 },
-    { "DIV"       , 0, 3 },
-    { "ADD_F"     , 3, 5 },
-    { "ADD_V"     , 3, 5 },
-    { "SUB_F"     , 3, 5 },
-    { "SUB_V"     , 3, 5 },
-    { "EQ_F"      , 0, 4 },
-    { "EQ_V"      , 0, 4 },
-    { "EQ_S"      , 0, 4 },
-    { "EQ_E"      , 0, 4 },
-    { "EQ_FNC"    , 0, 6 },
-    { "NE_F"      , 0, 4 },
-    { "NE_V"      , 0, 4 },
-    { "NE_S"      , 0, 4 },
-    { "NE_E"      , 0, 4 },
-    { "NE_FNC"    , 0, 6 },
-    { "LE"        , 0, 2 },
-    { "GE"        , 0, 2 },
-    { "LT"        , 0, 2 },
-    { "GT"        , 0, 2 },
-    { "FIELD_F"   , 0, 7 },
-    { "FIELD_V"   , 0, 7 },
-    { "FIELD_S"   , 0, 7 },
-    { "FIELD_ENT" , 0, 9 },
-    { "FIELD_FLD" , 0, 9 },
-    { "FIELD_FNC" , 0, 9 },
-    { "ADDRESS"   , 0, 7 },
-    { "STORE_F"   , 0, 7 },
-    { "STORE_V"   , 0, 7 },
-    { "STORE_S"   , 0, 7 },
-    { "STORE_ENT" , 0, 9 },
-    { "STORE_FLD" , 0, 9 },
-    { "STORE_FNC" , 0, 9 },
-    { "STOREP_F"  , 0, 8 },
-    { "STOREP_V"  , 0, 8 },
-    { "STOREP_S"  , 0, 8 },
-    { "STOREP_ENT", 0, 10},
-    { "STOREP_FLD", 0, 10},
-    { "STOREP_FNC", 0, 10},
-    { "RETURN"    , 0, 6 },
-    { "NOT_F"     , 0, 5 },
-    { "NOT_V"     , 0, 5 },
-    { "NOT_S"     , 0, 5 },
-    { "NOT_ENT"   , 0, 7 },
-    { "NOT_FNC"   , 0, 7 },
-    { "IF"        , 0, 2 },
-    { "IFNOT"     , 0, 5 },
-    { "CALL0"     , 1, 5 },
-    { "CALL1"     , 2, 5 },
-    { "CALL2"     , 3, 5 },
-    { "CALL3"     , 4, 5 },
-    { "CALL4"     , 5, 5 },
-    { "CALL5"     , 6, 5 },
-    { "CALL6"     , 7, 5 },
-    { "CALL7"     , 8, 5 },
-    { "CALL8"     , 9, 5 },
-    { "STATE"     , 0, 5 },
-    { "GOTO"      , 0, 4 },
-    { "AND"       , 0, 3 },
-    { "OR"        , 0, 2 },
-    { "BITAND"    , 0, 6 },
-    { "BITOR"     , 0, 5 },
-
-    { "END"       , 0, 3 } /* virtual assembler instruction */
-};
 /*===================================================================*/
 /*============================= ir.c ================================*/
 /*===================================================================*/
@@ -883,13 +832,8 @@ enum store_types {
 };
 
 typedef struct {
-    qcfloat x, y, z;
-} vector;
-
-vector  vec3_add  (vector, vector);
-vector  vec3_sub  (vector, vector);
-qcfloat vec3_mulvv(vector, vector);
-vector  vec3_mulvf(vector, float);
+    qcfloat_t x, y, z;
+} vec3_t;
 
 /*===================================================================*/
 /*============================= exec.c ==============================*/
@@ -903,22 +847,21 @@ vector  vec3_mulvf(vector, float);
  * float and int here.
  */
 typedef union {
-    qcint   _int;
-    qcint    string;
-    qcint    function;
-    qcint    edict;
-    qcfloat _float;
-    qcfloat vector[3];
-    qcint   ivector[3];
-} qcany;
-
-typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
-typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
+    qcint_t   _int;
+    qcint_t    string;
+    qcint_t    function;
+    qcint_t    edict;
+    qcfloat_t _float;
+    qcfloat_t vector[3];
+    qcint_t   ivector[3];
+} qcany_t;
+
+typedef char qcfloat_t_size_is_correct [sizeof(qcfloat_t) == 4 ?1:-1];
+typedef char qcint_t_size_is_correct   [sizeof(qcint_t)   == 4 ?1:-1];
 
 enum {
     VMERR_OK,
     VMERR_TEMPSTRING_ALLOC,
-
     VMERR_END
 };
 
@@ -930,65 +873,61 @@ enum {
 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
 
 struct qc_program_s;
-
-typedef int (*prog_builtin)(struct qc_program_s *prog);
+typedef int (*prog_builtin_t)(struct qc_program_s *prog);
 
 typedef struct {
-    qcint                  stmt;
-    size_t                 localsp;
-    prog_section_function *function;
-} qc_exec_stack;
+    qcint_t                    stmt;
+    size_t                   localsp;
+    prog_section_function_t *function;
+} qc_exec_stack_t;
 
 typedef struct qc_program_s {
-    char           *filename;
-
-    prog_section_statement *code;
-    prog_section_def       *defs;
-    prog_section_def       *fields;
-    prog_section_function  *functions;
-    char                   *strings;
-    qcint                  *globals;
-    qcint                  *entitydata;
-    bool                   *entitypool;
-
-    const char*            *function_stack;
+    char                    *filename;
+    prog_section_statement_t *code;
+    prog_section_def_t       *defs;
+    prog_section_def_t       *fields;
+    prog_section_function_t  *functions;
+    char                    *strings;
+    qcint_t                   *globals;
+    qcint_t                   *entitydata;
+    bool                    *entitypool;
+
+    const char*             *function_stack;
 
     uint16_t crc16;
 
     size_t tempstring_start;
     size_t tempstring_at;
 
-    qcint  vmerror;
+    qcint_t  vmerror;
 
     size_t *profile;
 
-    prog_builtin *builtins;
-    size_t        builtins_count;
+    prog_builtin_t *builtins;
+    size_t          builtins_count;
 
     /* size_t ip; */
-    qcint  entities;
+    qcint_t  entities;
     size_t entityfields;
     bool   allowworldwrites;
 
-    qcint         *localstack;
-    qc_exec_stack *stack;
+    qcint_t         *localstack;
+    qc_exec_stack_t *stack;
     size_t statement;
 
     size_t xflags;
 
     int    argc; /* current arg count for debugging */
-} qc_program;
-
-qc_program* prog_load(const char *filename, bool ignoreversion);
-void        prog_delete(qc_program *prog);
-
-bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
+} qc_program_t;
 
-const char*       prog_getstring (qc_program *prog, qcint str);
-prog_section_def* prog_entfield  (qc_program *prog, qcint off);
-prog_section_def* prog_getdef    (qc_program *prog, qcint off);
-qcany*            prog_getedict  (qc_program *prog, qcint e);
-qcint             prog_tempstring(qc_program *prog, const char *_str);
+qc_program_t*       prog_load      (const char *filename, bool ignoreversion);
+void                prog_delete    (qc_program_t *prog);
+bool                prog_exec      (qc_program_t *prog, prog_section_function_t *func, size_t flags, long maxjumps);
+const char*         prog_getstring (qc_program_t *prog, qcint_t str);
+prog_section_def_t* prog_entfield  (qc_program_t *prog, qcint_t off);
+prog_section_def_t* prog_getdef    (qc_program_t *prog, qcint_t off);
+qcany_t*            prog_getedict  (qc_program_t *prog, qcint_t e);
+qcint_t               prog_tempstring(qc_program_t *prog, const char *_str);
 
 
 /*===================================================================*/
@@ -1052,7 +991,7 @@ int     u8_fromchar(uchar_t w,   char *to,     size_t maxlen);
 typedef struct {
     const char *name;
     longbit     bit;
-} opts_flag_def;
+} opts_flag_def_t;
 
 bool opts_setflag  (const char *, bool);
 bool opts_setwarn  (const char *, bool);
@@ -1070,18 +1009,13 @@ void opts_restore_non_Wall(void);
 void opts_backup_non_Werror_all(void);
 void opts_restore_non_Werror_all(void);
 
+
 enum {
 # define GMQCC_TYPE_FLAGS
 # define GMQCC_DEFINE_FLAG(X) X,
 #  include "opts.def"
     COUNT_FLAGS
 };
-static const opts_flag_def opts_flag_list[] = {
-# define GMQCC_TYPE_FLAGS
-# define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
-#  include "opts.def"
-    { NULL, LONGBIT(0) }
-};
 
 enum {
 # define GMQCC_TYPE_WARNS
@@ -1089,12 +1023,6 @@ enum {
 #  include "opts.def"
     COUNT_WARNINGS
 };
-static const opts_flag_def opts_warn_list[] = {
-# define GMQCC_TYPE_WARNS
-# define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
-#  include "opts.def"
-    { NULL, LONGBIT(0) }
-};
 
 enum {
 # define GMQCC_TYPE_OPTIMIZATIONS
@@ -1102,18 +1030,6 @@ enum {
 #  include "opts.def"
     COUNT_OPTIMIZATIONS
 };
-static const opts_flag_def opts_opt_list[] = {
-# define GMQCC_TYPE_OPTIMIZATIONS
-# define GMQCC_DEFINE_FLAG(NAME, MIN_O) { #NAME, LONGBIT(OPTIM_##NAME) },
-#  include "opts.def"
-    { NULL, LONGBIT(0) }
-};
-static const unsigned int opts_opt_oflag[] = {
-# define GMQCC_TYPE_OPTIMIZATIONS
-# define GMQCC_DEFINE_FLAG(NAME, MIN_O) MIN_O,
-#  include "opts.def"
-    0
-};
 
 enum {
 #   define GMQCC_TYPE_OPTIONS
@@ -1122,7 +1038,11 @@ enum {
     OPTION_COUNT
 };
 
-extern unsigned int opts_optimizationcount[COUNT_OPTIMIZATIONS];
+extern const opts_flag_def_t opts_flag_list[COUNT_FLAGS+1];
+extern const opts_flag_def_t opts_warn_list[COUNT_WARNINGS+1];
+extern const opts_flag_def_t opts_opt_list[COUNT_OPTIMIZATIONS+1];
+extern const unsigned int    opts_opt_oflag[COUNT_OPTIMIZATIONS+1];
+extern unsigned int          opts_optimizationcount[COUNT_OPTIMIZATIONS];
 
 /* other options: */
 typedef enum {