gmqcc.h

   1 /*
   2  * Copyright (C) 2012, 2013, 2014
   3  *     Dale Weiler
   4  *     Wolfgang Bumiller
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   7  * this software and associated documentation files (the "Software"), to deal in
   8  * the Software without restriction, including without limitation the rights to
   9  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  10  * of the Software, and to permit persons to whom the Software is furnished to do
  11  * so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24 #ifndef GMQCC_HDR
  25 #define GMQCC_HDR
  26 #include <stdarg.h>
  27 #include <stddef.h>
  28 #include <time.h>
  29
  30 #define GMQCC_VERSION_MAJOR 0
  31 #define GMQCC_VERSION_MINOR 3
  32 #define GMQCC_VERSION_PATCH 6
  33 #define GMQCC_VERSION ((GMQCC_VERSION_MAJOR<<16)|(GMQCC_VERSION_MINOR<<8)|GMQCC_VERSION_PATCH)
  34
  35 #ifdef GMQCC_VERSION_TYPE_RELEASE
  36 #    ifdef GMQCC_GITINFO
  37 #        define GMQCC_DEV_VERSION_STRING "git build: " GMQCC_GITINFO "\n"
  38 #    elif defined(GMQCC_VERSION_TYPE_DEVEL)
  39 #        define GMQCC_DEV_VERSION_STRING "development build\n"
  40 #    else
  41 #        define GMQCC_DEV_VERSION_STRING
  42 #    endif /*! GMQCC_GITINGO */
  43 #else
  44 #    define GMQCC_DEV_VERSION_STRING
  45 #endif
  46
  47 #define GMQCC_STRINGIFY(x) #x
  48 #define GMQCC_IND_STRING(x) GMQCC_STRINGIFY(x)
  49 #define GMQCC_FULL_VERSION_STRING \
  50 "GMQCC " \
  51 GMQCC_IND_STRING(GMQCC_VERSION_MAJOR) "." \
  52 GMQCC_IND_STRING(GMQCC_VERSION_MINOR) "." \
  53 GMQCC_IND_STRING(GMQCC_VERSION_PATCH) \
  54 " Built " __DATE__ " " __TIME__ \
  55 "\n" GMQCC_DEV_VERSION_STRING
  56
  57 #ifndef __cplusplus
  58 #   define false (unsigned char)(0)
  59 #   define true  (unsigned char)(1)
  60     typedef unsigned char bool;
  61 #endif
  62
  63 #if defined(__GNUC__) || defined(__CLANG__)
  64 #   include <stdint.h>
  65 #   if (__GNUC__ >= 2) || defined(__CLANG__)
  66 #       define GMQCC_NORETURN    __attribute__((noreturn))
  67 #       define GMQCC_FORCEINLINE __attribute__((always_inline))
  68 #       define GMQCC_INLINE      __inline
  69 #   endif
  70 #   define GMQCC_LIKELY(X)   __builtin_expect((X), 1)
  71 #   define GMQCC_UNLIKELY(X) __builtin_expect((X), 0)
  72 #   define GMQCC_WARN        __attribute__((warn_unused_result))
  73 #   define GMQCC_USED        __attribute__((used))
  74 #   define GMQCC_RESTRICT    __restrict__
  75 #else
  76 #   ifdef _MSC_VER
  77         /* conversion from 'int' to 'float', possible loss of data */
  78 #       pragma warning(disable : 4244)
  79
  80         typedef unsigned __int8  uint8_t;
  81         typedef unsigned __int16 uint16_t;
  82         typedef unsigned __int32 uint32_t;
  83         typedef unsigned __int64 uint64_t;
  84         typedef __int16          int16_t;
  85         typedef __int32          int32_t;
  86         typedef __int64          int64_t;
  87 #       define GMQCC_NORETURN    __declspec(noreturn)
  88 #       define GMQCC_FORCEINLINE __forceinline
  89 #       define GMQCC_INLINE      __inline
  90 #       define GMQCC_RESTRICT    __restrict
  91 #   else
  92 #       define GMQCC_NORETURN
  93 #       define GMQCC_FORCEINLINE
  94 #       define GMQCC_INLINE
  95 #       define GMQCC_RESTRICT
  96 #   endif
  97 #   define GMQCC_LIKELY(X)   (X)
  98 #   define GMQCC_UNLIKELY(X) (X)
  99 #   define GMQCC_WARN
 100 #   define GMQCC_USED
 101 #endif
 102
 103 #define GMQCC_BYTE_ORDER_LITTLE 1234
 104 #define GMQCC_BYTE_ORDER_BIG    4321
 105
 106 #if defined (__GNUC__) || defined (__GNU_LIBRARY__)
 107 #   if defined (__FreeBSD__) || defined (__OpenBSD__)
 108 #       include <sys/endian.h>
 109 #   elif defined (BSD) && (BSD >= 199103) || defined (__DJGPP__) || defined (__CYGWIN32__)
 110 #       include <machine/endian.h>
 111 #   elif defined (__APPLE__)
 112 #       if defined (__BIG_ENDIAN__) && !defined(BIG_ENDIAN)
 113 #           define BIG_ENDIAN
 114 #       elif defined (__LITTLE_ENDIAN__) && !defined (LITTLE_ENDIAN)
 115 #           define LITTLE_ENDIAN
 116 #       endif /*! defined (__BIG_ENDIAN__) && !defined(BIG_ENDIAN) */
 117 #   elif !defined (__MINGW32__)
 118 #       include <endian.h>
 119 #       if !defined (__BEOS__)
 120 #           include <byteswap.h>
 121 #       endif /*! !definde (__BEOS__) */
 122 #   endif /*! defined (__FreeBSD__) || defined (__OpenBSD__) */
 123 #endif /*! defined (__GNUC__) || defined (__GNU_LIBRARY__) */
 124 #if !defined(PLATFORM_BYTE_ORDER)
 125 #   if defined (LITTLE_ENDIAN) || defined (BIG_ENDIAN)
 126 #       if defined (LITTLE_ENDIAN) && !defined(BIG_ENDIAN)
 127 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
 128 #       elif !defined (LITTLE_ENDIAN) && defined (BIG_ENDIAN)
 129 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
 130 #       elif defined (BYTE_ORDER) && (BYTE_ORDER == LITTLE_ENDIAN)
 131 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
 132 #       elif defined (BYTE_ORDER) && (BYTE_ORDER == BIG_ENDIAN)
 133 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
 134 #       endif /*! defined (LITTLE_ENDIAN) && !defined(BIG_ENDIAN) */
 135 #   elif defined (_LITTLE_ENDIAN) || defined (_BIG_ENDIAN)
 136 #       if defined (_LITTLE_ENDIAN) && !defined(_BIG_ENDIAN)
 137 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
 138 #       elif !defined (_LITTLE_ENDIAN) && defined (_BIG_ENDIAN)
 139 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
 140 #       elif defined (_BYTE_ORDER) && (_BYTE_ORDER == _LITTLE_ENDIAN)
 141 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
 142 #       elif defined (_BYTE_ORDER) && (_BYTE_ORDER == _BIG_ENDIAN)
 143 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
 144 #       endif /*! defined (_LITTLE_ENDIAN) && !defined(_BIG_ENDIAN) */
 145 #   elif defined (__LITTLE_ENDIAN__) || defined (__BIG_ENDIAN__)
 146 #       if defined (__LITTLE_ENDIAN__) && !defined (__BIG_ENDIAN__)
 147 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
 148 #       elif !defined (__LITTLE_ENDIAN__) && defined (__BIG_ENDIAN__)
 149 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
 150 #       elif defined (__BYTE_ORDER__) && (__BYTE_ORDER__ == __LITTLE_ENDIAN__)
 151 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
 152 #       elif defined (__BYTE_ORDER__) && (__BYTE_ORDER__ == __BIG_ENDIAN__)
 153 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
 154 #       endif /*! defined (__LITTLE_ENDIAN__) && !defined (__BIG_ENDIAN__) */
 155 #   endif /*! defined(LITTLE_ENDIAN) || defined (BIG_ENDIAN) */
 156 #endif /*! !defined(PLATFORM_BYTE_ORDER) */
 157 #if !defined (PLATFORM_BYTE_ORDER)
 158 #   if   defined (__alpha__) || defined (__alpha)    || defined (i386)       || \
 159          defined (__i386__)  || defined (_M_I86)     || defined (_M_IX86)    || \
 160          defined (__OS2__)   || defined (sun386)     || defined (__TURBOC__) || \
 161          defined (vax)       || defined (vms)        || defined (VMS)        || \
 162          defined (__VMS)     || defined (__x86_64__) || defined (_M_IA64)    || \
 163          defined (_M_X64)    || defined (__i386)     || defined (__x86_64)
 164 #       define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
 165 #   elif defined (AMIGA)     || defined (applec)     || defined (__AS400__)  || \
 166          defined (_CRAY)     || defined (__hppa)     || defined (__hp9000)   || \
 167          defined (ibm370)    || defined (mc68000)    || defined (m68k)       || \
 168          defined (__MRC__)   || defined (__MVS__)    || defined (__MWERKS__) || \
 169          defined (sparc)     || defined (__sparc)    || defined (SYMANTEC_C) || \
 170          defined (__TANDEM)  || defined (THINK_C)    || defined (__VMCMS__)  || \
 171          defined (__PPC__)   || defined (__PPC)      || defined (PPC)
 172 #       define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
 173 #   else
 174 #       define PLATFORM_BYTE_ORDER -1
 175 #   endif
 176 #endif
 177
 178 #define GMQCC_ARRAY_COUNT(X) (sizeof(X) / sizeof((X)[0]))
 179
 180 /* stat.c */
 181 void  stat_info          (void);
 182 char *stat_mem_strdup    (const char *, size_t,         const char *, bool);
 183 void *stat_mem_reallocate(void *,       size_t, size_t, const char *, const char *);
 184 void  stat_mem_deallocate(void *);
 185 void *stat_mem_allocate  (size_t, size_t, const char *, const char *);
 186
 187 #define mem_a(SIZE)              stat_mem_allocate  ((SIZE), __LINE__, __FILE__, #SIZE)
 188 #define mem_d(PTRN)              stat_mem_deallocate((void*)(PTRN))
 189 #define mem_r(PTRN, SIZE)        stat_mem_reallocate((void*)(PTRN), (SIZE), __LINE__, __FILE__, #SIZE)
 190 #define mem_af(SIZE, FILE, LINE) stat_mem_allocate  ((SIZE), (LINE), (FILE), #SIZE)
 191
 192 /* TODO: rename to mem variations */
 193 #define util_strdup(SRC)         stat_mem_strdup((char*)(SRC), __LINE__, __FILE__, false)
 194 #define util_strdupe(SRC)        stat_mem_strdup((char*)(SRC), __LINE__, __FILE__, true)
 195
 196 /* util.c */
 197
 198 /*
 199  * Microsoft implements against the spec versions of ctype.h. Which
 200  * means what ever the current set locale is will render the actual
 201  * results of say isalpha('A') wrong for what ever retarded locale
 202  * is used. Simalerly these are also implemented inefficently on
 203  * some toolchains and end up becoming actual library calls. Perhaps
 204  * this is why tools like yacc provide their own? Regardless implementing
 205  * these as functions is equally as silly, the call overhead is not
 206  * justified when this could happen on every character from an input
 207  * stream. We provide our own as macros for absolute inlinability.
 208  */
 209 #define util_isalpha(a) ((((unsigned)(a)|32)-'a') < 26)
 210 #define util_isdigit(a) (((unsigned)(a)-'0') < 10)
 211 #define util_islower(a) (((unsigned)(a)-'a') < 26)
 212 #define util_isupper(a) (((unsigned)(a)-'A') < 26)
 213 #define util_isprint(a) (((unsigned)(a)-0x20) < 0x5F)
 214 #define util_isspace(a) (((a) >= 9 && (a) <= 13) || (a) == ' ')
 215
 216 bool  util_strupper(const char *);
 217 bool  util_strdigit(const char *);
 218
 219 void  util_endianswap(void *, size_t, unsigned int);
 220
 221 size_t util_strtocmd         (const char *, char *, size_t);
 222 size_t util_strtononcmd      (const char *, char *, size_t);
 223 size_t util_optimizationtostr(const char *, char *, size_t);
 224
 225 uint16_t util_crc16(uint16_t crc, const char *data, size_t len);
 226
 227 void     util_seed(uint32_t);
 228 uint32_t util_rand(void);
 229
 230 int      util_asprintf (char **ret, const char *fmt, ...);
 231 int      util_sscanf   (const char *str, const char *format, ...);
 232 char    *util_strncpy  (char *dest, const char *src, size_t n);
 233 char    *util_strncat  (char *dest, const char *src, size_t n);
 234 char    *util_strcat   (char *dest, const char *src);
 235 const char *util_strerror(int err);
 236
 237 const struct tm *util_localtime(const time_t *timer);
 238 const char      *util_ctime    (const time_t *timer);
 239
 240 typedef struct fs_file_s fs_file_t;
 241
 242 bool             util_isatty(fs_file_t *);
 243 size_t           hash(const char *key);
 244
 245 /*
 246  * A flexible vector implementation: all vector pointers contain some
 247  * data about themselfs exactly - sizeof(vector_t) behind the pointer
 248  * this data is represented in the structure below.  Doing this allows
 249  * us to use the array [] to access individual elements from the vector
 250  * opposed to using set/get methods.
 251  */
 252 typedef struct {
 253     size_t  allocated;
 254     size_t  used;
 255
 256     /* can be extended now! whoot */
 257 } vector_t;
 258
 259 /* hidden interface */
 260 void _util_vec_grow(void **a, size_t i, size_t s);
 261 #define GMQCC_VEC_WILLGROW(X,Y) ( \
 262     ((!(X) || vec_meta(X)->used + Y >= vec_meta(X)->allocated)) ? \
 263         (void)_util_vec_grow(((void**)&(X)), (Y), sizeof(*(X))) : \
 264         (void)0                                                   \
 265 )
 266
 267 /* exposed interface */
 268 #define vec_meta(A)       (((vector_t*)((void*)A)) - 1)
 269 #define vec_free(A)       ((void)((A) ? (mem_d((void*)vec_meta(A)), (A) = NULL) : 0))
 270 #define vec_push(A,V)     (GMQCC_VEC_WILLGROW((A),1), (A)[vec_meta(A)->used++] = (V))
 271 #define vec_size(A)       ((A) ? vec_meta(A)->used : 0)
 272 #define vec_add(A,N)      (GMQCC_VEC_WILLGROW((A),(N)), vec_meta(A)->used += (N), &(A)[vec_meta(A)->used-(N)])
 273 #define vec_last(A)       ((A)[vec_meta(A)->used - 1])
 274 #define vec_pop(A)        ((void)(vec_meta(A)->used -= 1))
 275 #define vec_shrinkto(A,N) ((void)(vec_meta(A)->used  = (N)))
 276 #define vec_shrinkby(A,N) ((void)(vec_meta(A)->used -= (N)))
 277 #define vec_append(A,N,S) ((void)(memcpy(vec_add((A), (N)), (S), (N) * sizeof(*(S)))))
 278 #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)))
 279
 280 typedef struct hash_table_s {
 281     size_t                size;
 282     struct hash_node_t **table;
 283 } hash_table_t, *ht;
 284
 285 /*
 286  * hashtable implementation:
 287  *
 288  * Note:
 289  *      This was designed for pointers:  you manage the life of the object yourself
 290  *      if you do use this for non-pointers please be warned that the object may not
 291  *      be valid if the duration of it exceeds (i.e on stack).  So you need to allocate
 292  *      yourself, or put those in global scope to ensure duration is for the whole
 293  *      runtime.
 294  *
 295  * util_htnew(size)                             -- to make a new hashtable
 296  * util_htset(table, key, value, sizeof(value)) -- to set something in the table
 297  * util_htget(table, key)                       -- to get something from the table
 298  * util_htdel(table)                            -- to delete the table
 299  *
 300  * example of use:
 301  *
 302  * ht    foo  = util_htnew(1024);
 303  * int   data = 100;
 304  * char *test = "hello world\n";
 305  * util_htset(foo, "foo", (void*)&data);
 306  * util_gtset(foo, "bar", (void*)test);
 307  *
 308  * printf("foo: %d, bar %s",
 309  *     *((int *)util_htget(foo, "foo")),
 310  *      ((char*)util_htget(foo, "bar"))
 311  * );
 312  *
 313  * util_htdel(foo);
 314  */
 315 hash_table_t *util_htnew (size_t size);
 316 void          util_htrem (hash_table_t *ht, void (*callback)(void *data));
 317 void          util_htset (hash_table_t *ht, const char *key, void *value);
 318 void          util_htdel (hash_table_t *ht);
 319 size_t        util_hthash(hash_table_t *ht, const char *key);
 320 void          util_htseth(hash_table_t *ht, const char *key, size_t hash, void *value);
 321 void          util_htrmh (hash_table_t *ht, const char *key, size_t bin, void (*cb)(void*));
 322 void          util_htrm  (hash_table_t *ht, const char *key, void (*cb)(void*));
 323
 324 void         *util_htget (hash_table_t *ht, const char *key);
 325 void         *util_htgeth(hash_table_t *ht, const char *key, size_t hash);
 326
 327 int           util_snprintf(char *str, size_t, const char *fmt, ...);
 328
 329
 330 /* fs.c */
 331 #define FS_FILE_SEEK_SET  0
 332 #define FS_FILE_SEEK_CUR  1
 333 #define FS_FILE_SEEK_END  2
 334 #define FS_FILE_EOF      -1
 335
 336 typedef struct fs_dir_s  fs_dir_t;
 337 /*typedef struct fs_file_s fs_file_t;*/
 338 typedef struct dirent    fs_dirent_t;
 339
 340 void           fs_file_close  (fs_file_t *);
 341 int            fs_file_error  (fs_file_t *);
 342 int            fs_file_getc   (fs_file_t *);
 343 int            fs_file_printf (fs_file_t *, const char *, ...);
 344 int            fs_file_puts   (fs_file_t *, const char *);
 345 int            fs_file_seek   (fs_file_t *, long int, int);
 346 long           fs_file_tell   (fs_file_t *);
 347 int            fs_file_flush  (fs_file_t *);
 348
 349 size_t         fs_file_read   (void *,        size_t, size_t, fs_file_t *);
 350 size_t         fs_file_write  (const void *,  size_t, size_t, fs_file_t *);
 351
 352 fs_file_t     *fs_file_open   (const char *, const char *);
 353 int            fs_file_getline(char  **, size_t *, fs_file_t *);
 354
 355 int            fs_dir_make    (const char *);
 356 fs_dir_t      *fs_dir_open    (const char *);
 357 int            fs_dir_close   (fs_dir_t *);
 358 fs_dirent_t   *fs_dir_read    (fs_dir_t *);
 359
 360
 361 /* correct.c */
 362 typedef struct correct_trie_s {
 363     void                  *value;
 364     struct correct_trie_s *entries;
 365 } correct_trie_t;
 366
 367 correct_trie_t* correct_trie_new(void);
 368
 369 typedef struct {
 370     char   ***edits;
 371     size_t  **lens;
 372 } correction_t;
 373
 374 void  correct_del (correct_trie_t*, size_t **);
 375 void  correct_add (correct_trie_t*, size_t ***, const char *);
 376 char *correct_str (correction_t *, correct_trie_t*, const char *);
 377 void  correct_init(correction_t *);
 378 void  correct_free(correction_t *);
 379
 380
 381 /* code.c */
 382
 383 /* Note: if you change the order, fix type_sizeof in ir.c */
 384 enum {
 385     TYPE_VOID     ,
 386     TYPE_STRING   ,
 387     TYPE_FLOAT    ,
 388     TYPE_VECTOR   ,
 389     TYPE_ENTITY   ,
 390     TYPE_FIELD    ,
 391     TYPE_FUNCTION ,
 392     TYPE_POINTER  ,
 393     TYPE_INTEGER  ,
 394     TYPE_VARIANT  ,
 395     TYPE_STRUCT   ,
 396     TYPE_UNION    ,
 397     TYPE_ARRAY    ,
 398
 399     TYPE_NIL      , /* it's its own type / untyped */
 400     TYPE_NOEXPR   , /* simply invalid in expressions */
 401
 402     TYPE_COUNT
 403 };
 404
 405 /* const/var qualifiers */
 406 #define CV_NONE   0
 407 #define CV_CONST  1
 408 #define CV_VAR   -1
 409 #define CV_WRONG  0x8000 /* magic number to help parsing */
 410
 411 extern const char    *type_name        [TYPE_COUNT];
 412 extern const uint16_t type_store_instr [TYPE_COUNT];
 413 extern const uint16_t field_store_instr[TYPE_COUNT];
 414
 415 /*
 416  * could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
 417  * but this breaks when TYPE_INTEGER is added, since with the enhanced
 418  * instruction set, the old ones are left untouched, thus the _I instructions
 419  * are at a seperate place.
 420  */
 421 extern const uint16_t type_storep_instr[TYPE_COUNT];
 422 extern const uint16_t type_eq_instr    [TYPE_COUNT];
 423 extern const uint16_t type_ne_instr    [TYPE_COUNT];
 424 extern const uint16_t type_not_instr   [TYPE_COUNT];
 425
 426 typedef struct {
 427     uint32_t offset;      /* Offset in file of where data begins  */
 428     uint32_t length;      /* Length of section (how many of)      */
 429 } prog_section_t;
 430
 431 typedef struct {
 432     uint32_t       version;      /* Program version (6)     */
 433     uint16_t       crc16;
 434     uint16_t       skip;
 435
 436     prog_section_t statements;   /* prog_section_statement  */
 437     prog_section_t defs;         /* prog_section_def        */
 438     prog_section_t fields;       /* prog_section_field      */
 439     prog_section_t functions;    /* prog_section_function   */
 440     prog_section_t strings;
 441     prog_section_t globals;
 442     uint32_t       entfield;     /* Number of entity fields */
 443 } prog_header_t;
 444
 445 /*
 446  * Each paramater incerements by 3 since vector types hold
 447  * 3 components (x,y,z).
 448  */
 449 #define OFS_NULL      0
 450 #define OFS_RETURN    1
 451 #define OFS_PARM0     (OFS_RETURN+3)
 452 #define OFS_PARM1     (OFS_PARM0 +3)
 453 #define OFS_PARM2     (OFS_PARM1 +3)
 454 #define OFS_PARM3     (OFS_PARM2 +3)
 455 #define OFS_PARM4     (OFS_PARM3 +3)
 456 #define OFS_PARM5     (OFS_PARM4 +3)
 457 #define OFS_PARM6     (OFS_PARM5 +3)
 458 #define OFS_PARM7     (OFS_PARM6 +3)
 459
 460 typedef struct {
 461     uint16_t opcode;
 462
 463     /* operand 1 */
 464     union {
 465         int16_t  s1; /* signed   */
 466         uint16_t u1; /* unsigned */
 467     } o1;
 468     /* operand 2 */
 469     union {
 470         int16_t  s1; /* signed   */
 471         uint16_t u1; /* unsigned */
 472     } o2;
 473     /* operand 3 */
 474     union {
 475         int16_t  s1; /* signed   */
 476         uint16_t u1; /* unsigned */
 477     } o3;
 478
 479     /*
 480      * This is the same as the structure in darkplaces
 481      * {
 482      *     unsigned short op;
 483      *     short          a,b,c;
 484      * }
 485      * But this one is more sane to work with, and the
 486      * type sizes are guranteed.
 487      */
 488 } prog_section_statement_t;
 489
 490 typedef struct {
 491     /*
 492      * The types:
 493      * 0 = ev_void
 494      * 1 = ev_string
 495      * 2 = ev_float
 496      * 3 = ev_vector
 497      * 4 = ev_entity
 498      * 5 = ev_field
 499      * 6 = ev_function
 500      * 7 = ev_pointer -- engine only
 501      * 8 = ev_bad     -- engine only
 502      */
 503     uint16_t type;
 504     uint16_t offset;
 505     uint32_t name;
 506 } prog_section_both_t;
 507
 508 typedef prog_section_both_t prog_section_def_t;
 509 typedef prog_section_both_t prog_section_field_t;
 510
 511 /* this is ORed to the type */
 512 #define DEF_SAVEGLOBAL (1<<15)
 513 #define DEF_TYPEMASK   ((1<<15)-1)
 514
 515 typedef struct {
 516     int32_t   entry;      /* in statement table for instructions  */
 517     uint32_t  firstlocal; /* First local in local table           */
 518     uint32_t  locals;     /* Total ints of params + locals        */
 519     uint32_t  profile;    /* Always zero (engine uses this)       */
 520     uint32_t  name;       /* name of function in string table     */
 521     uint32_t  file;       /* file of the source file              */
 522     int32_t   nargs;      /* number of arguments                  */
 523     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
 524 } prog_section_function_t;
 525
 526 /*
 527  * Instructions
 528  * These are the external instructions supported by the interperter
 529  * this is what things compile to (from the C code).
 530  */
 531 enum {
 532     INSTR_DONE,
 533     INSTR_MUL_F,
 534     INSTR_MUL_V,
 535     INSTR_MUL_FV, /* NOTE: the float operands must NOT be at the same locations: A != C */
 536     INSTR_MUL_VF, /* and here: B != C */
 537     INSTR_DIV_F,
 538     INSTR_ADD_F,
 539     INSTR_ADD_V,
 540     INSTR_SUB_F,
 541     INSTR_SUB_V,
 542     INSTR_EQ_F,
 543     INSTR_EQ_V,
 544     INSTR_EQ_S,
 545     INSTR_EQ_E,
 546     INSTR_EQ_FNC,
 547     INSTR_NE_F,
 548     INSTR_NE_V,
 549     INSTR_NE_S,
 550     INSTR_NE_E,
 551     INSTR_NE_FNC,
 552     INSTR_LE,
 553     INSTR_GE,
 554     INSTR_LT,
 555     INSTR_GT,
 556     INSTR_LOAD_F,
 557     INSTR_LOAD_V,
 558     INSTR_LOAD_S,
 559     INSTR_LOAD_ENT,
 560     INSTR_LOAD_FLD,
 561     INSTR_LOAD_FNC,
 562     INSTR_ADDRESS,
 563     INSTR_STORE_F,
 564     INSTR_STORE_V,
 565     INSTR_STORE_S,
 566     INSTR_STORE_ENT,
 567     INSTR_STORE_FLD,
 568     INSTR_STORE_FNC,
 569     INSTR_STOREP_F,
 570     INSTR_STOREP_V,
 571     INSTR_STOREP_S,
 572     INSTR_STOREP_ENT,
 573     INSTR_STOREP_FLD,
 574     INSTR_STOREP_FNC,
 575     INSTR_RETURN,
 576     INSTR_NOT_F,
 577     INSTR_NOT_V,
 578     INSTR_NOT_S,
 579     INSTR_NOT_ENT,
 580     INSTR_NOT_FNC,
 581     INSTR_IF,
 582     INSTR_IFNOT,
 583     INSTR_CALL0,
 584     INSTR_CALL1,
 585     INSTR_CALL2,
 586     INSTR_CALL3,
 587     INSTR_CALL4,
 588     INSTR_CALL5,
 589     INSTR_CALL6,
 590     INSTR_CALL7,
 591     INSTR_CALL8,
 592     INSTR_STATE,
 593     INSTR_GOTO,
 594     INSTR_AND,
 595     INSTR_OR,
 596     INSTR_BITAND,
 597     INSTR_BITOR,
 598
 599     /*
 600      * Virtual instructions used by the IR
 601      * Keep at the end!
 602      */
 603     VINSTR_END,
 604     VINSTR_PHI,
 605     VINSTR_JUMP,
 606     VINSTR_COND,
 607
 608     /* A never returning CALL.
 609      * Creating this causes IR blocks to be marked as 'final'.
 610      * No-Return-Call
 611      */
 612     VINSTR_NRCALL,
 613
 614     /* Emulated instructions. */
 615     VINSTR_BITAND_V, /* BITAND_V must be the first emulated bitop */
 616     VINSTR_BITAND_VF,
 617     VINSTR_BITOR_V,
 618     VINSTR_BITOR_VF,
 619     VINSTR_BITXOR,
 620     VINSTR_BITXOR_V,
 621     VINSTR_BITXOR_VF,
 622     VINSTR_CROSS,
 623     VINSTR_NEG_F,
 624     VINSTR_NEG_V
 625 };
 626
 627 /* TODO: elide */
 628 extern const char *util_instr_str[VINSTR_END];
 629
 630 void util_swap_header     (prog_header_t              *code_header);
 631 void util_swap_statements (prog_section_statement_t   *statements);
 632 void util_swap_defs_fields(prog_section_both_t        *section);
 633 void util_swap_functions  (prog_section_function_t    *functions);
 634 void util_swap_globals    (int32_t                    *globals);
 635
 636 typedef float    qcfloat_t;
 637 typedef int32_t  qcint_t;
 638 typedef uint32_t qcuint_t;
 639
 640 typedef struct {
 641     prog_section_statement_t *statements;
 642     int                      *linenums;
 643     int                      *columnnums;
 644     prog_section_def_t       *defs;
 645     prog_section_field_t     *fields;
 646     prog_section_function_t  *functions;
 647     int                      *globals;
 648     char                     *chars;
 649     uint16_t                  crc;
 650     uint32_t                  entfields;
 651     ht                        string_cache;
 652     qcint_t                   string_cached_empty;
 653 } code_t;
 654
 655 /*
 656  * A shallow copy of a lex_file to remember where which ast node
 657  * came from.
 658  */
 659 typedef struct {
 660     const char *file;
 661     size_t      line;
 662     size_t      column;
 663 } lex_ctx_t;
 664
 665 /*
 666  * code_write          -- writes out the compiled file
 667  * code_init           -- prepares the code file
 668  * code_genstrin       -- generates string for code
 669  * code_alloc_field    -- allocated a field
 670  * code_push_statement -- keeps statements and linenumbers together
 671  * code_pop_statement  -- keeps statements and linenumbers together
 672  */
 673 bool      code_write         (code_t *, const char *filename, const char *lno);
 674 GMQCC_WARN
 675 code_t   *code_init          (void);
 676 void      code_cleanup       (code_t *);
 677 uint32_t  code_genstring     (code_t *, const char *string);
 678 qcint_t   code_alloc_field   (code_t *, size_t qcsize);
 679 void      code_push_statement(code_t *, prog_section_statement_t *stmt, lex_ctx_t ctx);
 680 void      code_pop_statement (code_t *);
 681
 682
 683 /* conout.c */
 684 enum {
 685     CON_BLACK   = 30,
 686     CON_RED,
 687     CON_GREEN,
 688     CON_BROWN,
 689     CON_BLUE,
 690     CON_MAGENTA,
 691     CON_CYAN ,
 692     CON_WHITE
 693 };
 694
 695 /* message level */
 696 enum {
 697     LVL_MSG,
 698     LVL_WARNING,
 699     LVL_ERROR
 700 };
 701
 702 fs_file_t *con_default_out(void);
 703 fs_file_t *con_default_err(void);
 704
 705 void con_vprintmsg (int level, const char *name, size_t line, size_t column, const char *msgtype, const char *msg, va_list ap);
 706 void con_printmsg  (int level, const char *name, size_t line, size_t column, const char *msgtype, const char *msg, ...);
 707 void con_cvprintmsg(lex_ctx_t ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
 708 void con_cprintmsg (lex_ctx_t ctx, int lvl, const char *msgtype, const char *msg, ...);
 709
 710 void con_close (void);
 711 void con_init  (void);
 712 void con_reset (void);
 713 void con_color (int);
 714 int  con_change(const char *, const char *);
 715 int  con_verr  (const char *, va_list);
 716 int  con_vout  (const char *, va_list);
 717 int  con_err   (const char *, ...);
 718 int  con_out   (const char *, ...);
 719
 720 /* error/warning interface */
 721 extern size_t compile_errors;
 722 extern size_t compile_Werrors;
 723 extern size_t compile_warnings;
 724
 725 void /********/ compile_error   (lex_ctx_t ctx, /*LVL_ERROR*/ const char *msg, ...);
 726 void /********/ vcompile_error  (lex_ctx_t ctx, /*LVL_ERROR*/ const char *msg, va_list ap);
 727 bool GMQCC_WARN compile_warning (lex_ctx_t ctx, int warntype, const char *fmt, ...);
 728 bool GMQCC_WARN vcompile_warning(lex_ctx_t ctx, int warntype, const char *fmt, va_list ap);
 729 void            compile_show_werrors(void);
 730
 731 /* ir.c */
 732 /* TODO: cleanup */
 733 enum store_types {
 734     store_global,
 735     store_local,  /* local, assignable for now, should get promoted later */
 736     store_param,  /* parameters, they are locals with a fixed position */
 737     store_value,  /* unassignable */
 738     store_return  /* unassignable, at OFS_RETURN */
 739 };
 740
 741 typedef struct {
 742     qcfloat_t x, y, z;
 743 } vec3_t;
 744
 745 /* exec.c */
 746
 747 /* TODO: cleanup */
 748 /*
 749  * Darkplaces has (or will have) a 64 bit prog loader
 750  * where the 32 bit qc program is autoconverted on load.
 751  * Since we may want to support that as well, let's redefine
 752  * float and int here.
 753  */
 754 typedef union {
 755     qcint_t   _int;
 756     qcint_t    string;
 757     qcint_t    function;
 758     qcint_t    edict;
 759     qcfloat_t _float;
 760     qcfloat_t vector[3];
 761     qcint_t   ivector[3];
 762 } qcany_t;
 763
 764 typedef char qcfloat_t_size_is_correct [sizeof(qcfloat_t) == 4 ?1:-1];
 765 typedef char qcint_t_size_is_correct   [sizeof(qcint_t)   == 4 ?1:-1];
 766
 767 enum {
 768     VMERR_OK,
 769     VMERR_TEMPSTRING_ALLOC,
 770     VMERR_END
 771 };
 772
 773 #define VM_JUMPS_DEFAULT 1000000
 774
 775 /* execute-flags */
 776 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
 777 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
 778 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
 779
 780 struct qc_program_s;
 781 typedef int (*prog_builtin_t)(struct qc_program_s *prog);
 782
 783 typedef struct {
 784     qcint_t                    stmt;
 785     size_t                   localsp;
 786     prog_section_function_t *function;
 787 } qc_exec_stack_t;
 788
 789 typedef struct qc_program_s {
 790     char                    *filename;
 791     prog_section_statement_t *code;
 792     prog_section_def_t       *defs;
 793     prog_section_def_t       *fields;
 794     prog_section_function_t  *functions;
 795     char                    *strings;
 796     qcint_t                   *globals;
 797     qcint_t                   *entitydata;
 798     bool                    *entitypool;
 799
 800     const char*             *function_stack;
 801
 802     uint16_t crc16;
 803
 804     size_t tempstring_start;
 805     size_t tempstring_at;
 806
 807     qcint_t  vmerror;
 808
 809     size_t *profile;
 810
 811     prog_builtin_t *builtins;
 812     size_t          builtins_count;
 813
 814     /* size_t ip; */
 815     qcint_t  entities;
 816     size_t entityfields;
 817     bool   allowworldwrites;
 818
 819     qcint_t         *localstack;
 820     qc_exec_stack_t *stack;
 821     size_t statement;
 822
 823     size_t xflags;
 824
 825     int    argc; /* current arg count for debugging */
 826 } qc_program_t;
 827
 828 qc_program_t*       prog_load      (const char *filename, bool ignoreversion);
 829 void                prog_delete    (qc_program_t *prog);
 830 bool                prog_exec      (qc_program_t *prog, prog_section_function_t *func, size_t flags, long maxjumps);
 831 const char*         prog_getstring (qc_program_t *prog, qcint_t str);
 832 prog_section_def_t* prog_entfield  (qc_program_t *prog, qcint_t off);
 833 prog_section_def_t* prog_getdef    (qc_program_t *prog, qcint_t off);
 834 qcany_t*            prog_getedict  (qc_program_t *prog, qcint_t e);
 835 qcint_t               prog_tempstring(qc_program_t *prog, const char *_str);
 836
 837
 838 /* parser.c */
 839 struct parser_s;
 840 struct parser_s *parser_create        (void);
 841 bool             parser_compile_file  (struct parser_s *parser, const char *);
 842 bool             parser_compile_string(struct parser_s *parser, const char *, const char *, size_t);
 843 bool             parser_finish        (struct parser_s *parser, const char *);
 844 void             parser_cleanup       (struct parser_s *parser);
 845
 846 /* ftepp.c */
 847 struct ftepp_s;
 848 struct ftepp_s *ftepp_create           (void);
 849 bool            ftepp_preprocess_file  (struct ftepp_s *ftepp, const char *filename);
 850 bool            ftepp_preprocess_string(struct ftepp_s *ftepp, const char *name, const char *str);
 851 void            ftepp_finish           (struct ftepp_s *ftepp);
 852 const char     *ftepp_get              (struct ftepp_s *ftepp);
 853 void            ftepp_flush            (struct ftepp_s *ftepp);
 854 void            ftepp_add_define       (struct ftepp_s *ftepp, const char *source, const char *name);
 855 void            ftepp_add_macro        (struct ftepp_s *ftepp, const char *name,   const char *value);
 856
 857 /* main.c */
 858
 859 #if 1
 860 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
 861  * to 32 or 64 -f options...
 862  */
 863 typedef struct {
 864     size_t  idx; /* index into an array of 32 bit words */
 865     uint8_t bit; /* bit index for the 8 bit group idx points to */
 866 } longbit;
 867 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
 868 #define LONGBIT_SET(B, I) ((B).idx = (I)/32, (B).bit = ((I)%32))
 869 #else
 870 typedef uint32_t longbit;
 871 #define LONGBIT(bit) (bit)
 872 #define LONGBIT_SET(B, I) ((B) = (I))
 873 #endif
 874
 875 /* utf.8 */
 876 typedef long utf8ch_t;
 877 int utf8_from(char *, utf8ch_t);
 878 int utf8_to(utf8ch_t *, const unsigned char *, size_t);
 879
 880 /* opts.c */
 881 typedef struct {
 882     const char *name;
 883     longbit     bit;
 884 } opts_flag_def_t;
 885
 886 bool opts_setflag  (const char *, bool);
 887 bool opts_setwarn  (const char *, bool);
 888 bool opts_setwerror(const char *, bool);
 889 bool opts_setoptim (const char *, bool);
 890
 891 void opts_init         (const char *, int, size_t);
 892 void opts_set          (uint32_t   *, size_t, bool);
 893 void opts_setoptimlevel(unsigned int);
 894 void opts_ini_init     (const char *);
 895
 896 /* Saner flag handling */
 897 void opts_backup_non_Wall(void);
 898 void opts_restore_non_Wall(void);
 899 void opts_backup_non_Werror_all(void);
 900 void opts_restore_non_Werror_all(void);
 901
 902
 903 enum {
 904 # define GMQCC_TYPE_FLAGS
 905 # define GMQCC_DEFINE_FLAG(X) X,
 906 #  include "opts.def"
 907     COUNT_FLAGS
 908 };
 909
 910 enum {
 911 # define GMQCC_TYPE_WARNS
 912 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
 913 #  include "opts.def"
 914     COUNT_WARNINGS
 915 };
 916
 917 enum {
 918 # define GMQCC_TYPE_OPTIMIZATIONS
 919 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) OPTIM_##NAME,
 920 #  include "opts.def"
 921     COUNT_OPTIMIZATIONS
 922 };
 923
 924 enum {
 925 #   define GMQCC_TYPE_OPTIONS
 926 #   define GMQCC_DEFINE_FLAG(X) OPTION_##X,
 927 #   include "opts.def"
 928     OPTION_COUNT
 929 };
 930
 931 extern const opts_flag_def_t opts_flag_list[COUNT_FLAGS+1];
 932 extern const opts_flag_def_t opts_warn_list[COUNT_WARNINGS+1];
 933 extern const opts_flag_def_t opts_opt_list[COUNT_OPTIMIZATIONS+1];
 934 extern const unsigned int    opts_opt_oflag[COUNT_OPTIMIZATIONS+1];
 935 extern unsigned int          opts_optimizationcount[COUNT_OPTIMIZATIONS];
 936
 937 /* other options: */
 938 typedef enum {
 939     COMPILER_QCC,     /* circa  QuakeC */
 940     COMPILER_FTEQCC,  /* fteqcc QuakeC */
 941     COMPILER_QCCX,    /* qccx   QuakeC */
 942     COMPILER_GMQCC    /* this   QuakeC */
 943 } opts_std_t;
 944
 945 typedef struct {
 946     union {
 947         bool     b;
 948         uint16_t u16;
 949         uint32_t u32;
 950
 951         union {
 952             char       *p;
 953             const char *c;
 954         } str;
 955     } data;
 956
 957     bool allocated;
 958 } opt_value_t;
 959
 960
 961 typedef struct {
 962     opt_value_t  options      [OPTION_COUNT];
 963     uint32_t     flags        [1 + (COUNT_FLAGS         / 32)];
 964     uint32_t     warn         [1 + (COUNT_WARNINGS      / 32)];
 965     uint32_t     werror       [1 + (COUNT_WARNINGS      / 32)];
 966     uint32_t     warn_backup  [1 + (COUNT_WARNINGS      / 32)];
 967     uint32_t     werror_backup[1 + (COUNT_WARNINGS      / 32)];
 968     uint32_t     optimization [1 + (COUNT_OPTIMIZATIONS / 32)];
 969     bool         optimizeoff; /* True when -O0 */
 970 } opts_cmd_t;
 971
 972 extern opts_cmd_t opts;
 973
 974 #define OPTS_GENERIC(f,i)    (!! (((f)[(i)/32]) & (1<< (unsigned)((i)%32))))
 975
 976 #define OPTS_FLAG(i)         OPTS_GENERIC(opts.flags,        (i))
 977 #define OPTS_WARN(i)         OPTS_GENERIC(opts.warn,         (i))
 978 #define OPTS_WERROR(i)       OPTS_GENERIC(opts.werror,       (i))
 979 #define OPTS_OPTIMIZATION(i) OPTS_GENERIC(opts.optimization, (i))
 980
 981 #define OPTS_OPTION_DUPED(X) (opts.options[X].allocated)
 982 #define OPTS_OPTION_BOOL(X)  (opts.options[X].data.b)
 983 #define OPTS_OPTION_U16(X)   (opts.options[X].data.u16)
 984 #define OPTS_OPTION_U32(X)   (opts.options[X].data.u32)
 985 #define OPTS_OPTION_STR(X)   (opts.options[X].data.str.c)
 986 #define OPTS_OPTION_DUP(X)  *(OPTS_OPTION_DUPED(X)=true, &(opts.options[X].data.str.p))
 987
 988 #endif /*! GMQCC_HDR */