gmqcc.h

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