747aef4862ad7069d3a3500e6415661e457dac6a
[xonotic/gmqcc.git] / 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 <limits.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <stdarg.h>
30 #include <stdio.h>
31 #include <ctype.h>
32
33 /*
34  * Disable some over protective warnings in visual studio because fixing them is a waste
35  * of my time.
36  */
37 #ifdef _MSC_VER
38 #   pragma warning(disable : 4244 ) /* conversion from 'int' to 'float', possible loss of data */
39 #   pragma warning(disable : 4018 ) /* signed/unsigned mismatch                                */
40 #endif /*! _MSC_VER */
41
42 #define GMQCC_VERSION_MAJOR 0
43 #define GMQCC_VERSION_MINOR 3
44 #define GMQCC_VERSION_PATCH 0
45 #define GMQCC_VERSION_BUILD(J,N,P) (((J)<<16)|((N)<<8)|(P))
46 #define GMQCC_VERSION \
47     GMQCC_VERSION_BUILD(GMQCC_VERSION_MAJOR, GMQCC_VERSION_MINOR, GMQCC_VERSION_PATCH)
48 /* Undefine the following on a release-tag: */
49 #define GMQCC_VERSION_TYPE_DEVEL
50
51 /* Full version string in case we need it */
52 #ifdef GMQCC_GITINFO
53 #    define GMQCC_DEV_VERSION_STRING "git build: " GMQCC_GITINFO "\n"
54 #elif defined(GMQCC_VERSION_TYPE_DEVEL)
55 #    define GMQCC_DEV_VERSION_STRING "development build\n"
56 #else
57 #    define GMQCC_DEV_VERSION_STRING
58 #endif /*! GMQCC_GITINGO */
59
60 #define GMQCC_STRINGIFY(x) #x
61 #define GMQCC_IND_STRING(x) GMQCC_STRINGIFY(x)
62 #define GMQCC_FULL_VERSION_STRING \
63 "GMQCC " \
64 GMQCC_IND_STRING(GMQCC_VERSION_MAJOR) "." \
65 GMQCC_IND_STRING(GMQCC_VERSION_MINOR) "." \
66 GMQCC_IND_STRING(GMQCC_VERSION_PATCH) \
67 " Built " __DATE__ " " __TIME__ \
68 "\n" GMQCC_DEV_VERSION_STRING
69
70 /*
71  * We cannot rely on C99 at all, since compilers like MSVC
72  * simply don't support it.  We define our own boolean type
73  * as a result (since we cannot include <stdbool.h>). For
74  * compilers that are in 1999 mode (C99 compliant) we can use
75  * the language keyword _Bool which can allow for better code
76  * on GCC and GCC-like compilers, opposed to `int`.
77  */
78 #ifndef __cplusplus
79 #   ifdef  false
80 #       undef  false
81 #   endif /*! false */
82 #   ifdef  true
83 #       undef true
84 #   endif /*! true  */
85 #   define false (0)
86 #   define true  (1)
87 #   ifdef __STDC_VERSION__
88 #       if __STDC_VERSION__ < 199901L && __GNUC__ < 3
89             typedef int  bool;
90 #       else
91             typedef _Bool bool;
92 #       endif /*! __STDC_VERSION__ < 199901L && __GNUC__ < 3 */
93 #   else
94         typedef int bool;
95 #   endif /*! __STDC_VERSION__ */
96 #endif /*! __cplusplus      */
97
98 /*
99  * Of some functions which are generated we want to make sure
100  * that the result isn't ignored. To find such function calls,
101  * we use this macro.
102  */
103 #if defined(__GNUC__) || defined(__CLANG__)
104 #   define GMQCC_WARN __attribute__((warn_unused_result))
105 #   define GMQCC_USED __attribute__((used))
106 #else
107 #   define GMQCC_WARN
108 #   define GMQCC_USED
109 #endif /*! defined(__GNUC__) || defined (__CLANG__) */
110 /*
111  * This is a hack to silent clang regarding empty
112  * body if statements.
113  */
114 #define GMQCC_SUPPRESS_EMPTY_BODY do { } while (0)
115
116 /*
117  * Inline is not supported in < C90, however some compilers
118  * like gcc and clang might have an inline attribute we can
119  * use if present.
120  */
121 #ifdef __STDC_VERSION__
122 #    if __STDC_VERSION__ < 199901L
123 #       if defined(__GNUC__) || defined (__CLANG__)
124 #           if __GNUC__ < 2
125 #               define GMQCC_INLINE
126 #           else
127 #               define GMQCC_INLINE __attribute__ ((always_inline))
128 #           endif /*! __GNUC__ < 2 */
129 #       else
130 #           define GMQCC_INLINE
131 #       endif /*! defined(__GNUC__) || defined (__CLANG__) */
132 #    else
133 #       define GMQCC_INLINE inline
134 #    endif /*! __STDC_VERSION < 199901L */
135 /*
136  * Visual studio has __forcinline we can use.  So lets use that
137  * I suspect it also has just __inline of some sort, but our use
138  * of inline is correct (not guessed), WE WANT IT TO BE INLINE
139  */
140 #elif defined(_MSC_VER)
141 #    define GMQCC_INLINE __forceinline
142 #else
143 #    define GMQCC_INLINE
144 #endif /*! __STDC_VERSION__ */
145
146 /*
147  * noreturn is present in GCC and clang
148  * it's required for _ast_node_destory otherwise -Wmissing-noreturn
149  * in clang complains about there being no return since abort() is
150  * called.
151  */
152 #if (defined(__GNUC__) && __GNUC__ >= 2) || defined(__CLANG__)
153 #    define GMQCC_NORETURN __attribute__ ((noreturn))
154 #else
155 #    define GMQCC_NORETURN
156 #endif /*! (defined(__GNUC__) && __GNUC__ >= 2) || defined (__CLANG__) */
157
158 #ifndef _MSC_VER
159 #   include <stdint.h>
160 #else
161     typedef unsigned __int8  uint8_t;
162     typedef unsigned __int16 uint16_t;
163     typedef unsigned __int32 uint32_t;
164     typedef unsigned __int64 uint64_t;
165
166     typedef __int16          int16_t;
167     typedef __int32          int32_t;
168     typedef __int64          int64_t;
169 #endif /*! _MSC_VER */
170
171 /* 
172  *windows makes these prefixed because they're C99
173  * TODO: utility versions that are type-safe and not
174  * just plain textual subsitution.
175  */
176 #ifdef _MSC_VER
177 #    define snprintf(X, Y, Z, ...) _snprintf(X, Y, Z, __VA_ARGS__)
178     /* strtof doesn't exist -> strtod does though :) */
179 #    define strtof(X, Y)          (float)(strtod(X, Y))
180 #endif /*! _MSC_VER */
181
182 /*
183  * Very roboust way at determining endianess at compile time: this handles
184  * almost every possible situation.  Otherwise a runtime check has to be
185  * performed.
186  */
187 #define GMQCC_BYTE_ORDER_LITTLE 1234
188 #define GMQCC_BYTE_ORDER_BIG    4321
189
190 #if defined (__GNUC__) || defined (__GNU_LIBRARY__)
191 #   if defined (__FreeBSD__) || defined (__OpenBSD__)
192 #       include <sys/endian.h>
193 #   elif defined (BSD) && (BSD >= 199103) || defined (__DJGPP__) || defined (__CYGWIN32__)
194 #       include <machine/endian.h>
195 #   elif defined (__APPLE__)
196 #       if defined (__BIG_ENDIAN__) && !defined(BIG_ENDIAN)
197 #           define BIG_ENDIAN
198 #       elif defined (__LITTLE_ENDIAN__) && !defined (LITTLE_ENDIAN)
199 #           define LITTLE_ENDIAN
200 #       endif /*! defined (__BIG_ENDIAN__) && !defined(BIG_ENDIAN) */
201 #   elif !defined (__MINGW32__)
202 #       include <endian.h>
203 #       if !defined (__BEOS__)
204 #           include <byteswap.h>
205 #       endif /*! !definde (__BEOS__) */
206 #   endif /*! defined (__FreeBSD__) || defined (__OpenBSD__) */
207 #endif /*! defined (__GNUC__) || defined (__GNU_LIBRARY__) */
208 #if !defined(PLATFORM_BYTE_ORDER)
209 #   if defined (LITTLE_ENDIAN) || defined (BIG_ENDIAN)
210 #       if defined (LITTLE_ENDIAN) && !defined(BIG_ENDIAN)
211 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
212 #       elif !defined (LITTLE_ENDIAN) && defined (BIG_ENDIAN)
213 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
214 #       elif defined (BYTE_ORDER) && (BYTE_ORDER == LITTLE_ENDIAN)
215 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
216 #       elif defined (BYTE_ORDER) && (BYTE_ORDER == BIG_ENDIAN)
217 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
218 #       endif /*! defined (LITTLE_ENDIAN) && !defined(BIG_ENDIAN) */
219 #   elif defined (_LITTLE_ENDIAN) || defined (_BIG_ENDIAN)
220 #       if defined (_LITTLE_ENDIAN) && !defined(_BIG_ENDIAN)
221 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
222 #       elif !defined (_LITTLE_ENDIAN) && defined (_BIG_ENDIAN)
223 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
224 #       elif defined (_BYTE_ORDER) && (_BYTE_ORDER == _LITTLE_ENDIAN)
225 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
226 #       elif defined (_BYTE_ORDER) && (_BYTE_ORDER == _BIG_ENDIAN)
227 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
228 #       endif /*! defined (_LITTLE_ENDIAN) && !defined(_BIG_ENDIAN) */
229 #   elif defined (__LITTLE_ENDIAN__) || defined (__BIG_ENDIAN__)
230 #       if defined (__LITTLE_ENDIAN__) && !defined (__BIG_ENDIAN__)
231 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
232 #       elif !defined (__LITTLE_ENDIAN__) && defined (__BIG_ENDIAN__)
233 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
234 #       elif defined (__BYTE_ORDER__) && (__BYTE_ORDER__ == __LITTLE_ENDIAN__)
235 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
236 #       elif defined (__BYTE_ORDER__) && (__BYTE_ORDER__ == __BIG_ENDIAN__)
237 #           define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
238 #       endif /*! defined (__LITTLE_ENDIAN__) && !defined (__BIG_ENDIAN__) */
239 #   endif /*! defined(LITTLE_ENDIAN) || defined (BIG_ENDIAN) */
240 #endif /*! !defined(PLATFORM_BYTE_ORDER) */
241 #if !defined (PLATFORM_BYTE_ORDER)
242 #   if   defined (__alpha__) || defined (__alpha)    || defined (i386)       || \
243          defined (__i386__)  || defined (_M_I86)     || defined (_M_IX86)    || \
244          defined (__OS2__)   || defined (sun386)     || defined (__TURBOC__) || \
245          defined (vax)       || defined (vms)        || defined (VMS)        || \
246          defined (__VMS)     || defined (__x86_64__) || defined (_M_IA64)    || \
247          defined (_M_X64)    || defined (__i386)     || defined (__x86_64)
248 #       define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_LITTLE
249 #   elif defined (AMIGA)     || defined (applec)     || defined (__AS400__)  || \
250          defined (_CRAY)     || defined (__hppa)     || defined (__hp9000)   || \
251          defined (ibm370)    || defined (mc68000)    || defined (m68k)       || \
252          defined (__MRC__)   || defined (__MVS__)    || defined (__MWERKS__) || \
253          defined (sparc)     || defined (__sparc)    || defined (SYMANTEC_C) || \
254          defined (__TANDEM)  || defined (THINK_C)    || defined (__VMCMS__)  || \
255          defined (__PPC__)   || defined (__PPC)      || defined (PPC)
256 #       define PLATFORM_BYTE_ORDER GMQCC_BYTE_ORDER_BIG
257 #   else
258 #       define PLATFORM_BYTE_ORDER -1
259 #   endif
260 #endif /*! !defined (PLATFORM_BYTE_ORDER) */
261
262 /*
263  * On windows systems where we're not compiling with MING32 we need a
264  * little extra help on dependinces for implementing our own dirent.h
265  * in fs.c.
266  */   
267 #if defined(_WIN32) && !defined(__MINGW32__)
268 #   define _WIN32_LEAN_AND_MEAN
269 #   include <windows.h>
270 #   include <io.h>
271 #   include <fcntl.h>
272
273     struct dirent {
274         long d_ino;
275         unsigned short     d_reclen;
276         unsigned short     d_namlen;
277         char               d_name[FILENAME_MAX];
278     }
279
280     typedef struct {
281         struct _finddata_t dd_dta;
282         struct dirent      dd_dir;
283         long               dd_handle;
284         int                dd_stat;
285         char               dd_name[1];
286     } DIR;
287 #else
288 #   include <dirent.h>
289 #endif /*! _WIN32 && !defined(__MINGW32__) */
290
291
292 /*===================================================================*/
293 /*=========================== util.c ================================*/
294 /*===================================================================*/
295 void *util_memory_a      (size_t, /*****/ unsigned int, const char *);
296 void *util_memory_r      (void *, size_t, unsigned int, const char *);
297 void  util_memory_d      (void *);
298 void  util_meminfo       ();
299
300 bool  util_filexists     (const char *);
301 bool  util_strupper      (const char *);
302 bool  util_strdigit      (const char *);
303 char *_util_Estrdup      (const char *, const char *, size_t);
304 char *_util_Estrdup_empty(const char *, const char *, size_t);
305 void  util_debug         (const char *, const char *, ...);
306 void  util_endianswap    (void *,  size_t, unsigned int);
307
308 size_t util_strtocmd    (const char *, char *, size_t);
309 size_t util_strtononcmd (const char *, char *, size_t);
310
311 uint16_t util_crc16(uint16_t crc, const char *data, size_t len);
312
313 void     util_seed(uint32_t);
314 uint32_t util_rand();
315
316 int util_vasprintf(char **ret, const char *fmt, va_list);
317 int util_asprintf (char **ret, const char *fmt, ...);
318
319
320 #ifdef NOTRACK
321 #    define mem_a(x)      malloc (x)
322 #    define mem_d(x)      free   ((void*)x)
323 #    define mem_r(x, n)   realloc((void*)x, n)
324 #    define mem_af(x,f,l) malloc (x)
325 #else
326 #    define mem_a(x)      util_memory_a((x), __LINE__, __FILE__)
327 #    define mem_d(x)      util_memory_d((void*)(x))
328 #    define mem_r(x, n)   util_memory_r((void*)(x), (n), __LINE__, __FILE__)
329 #    define mem_af(x,f,l) util_memory_a((x), __LINE__, __FILE__)
330 #endif /*! NOTRACK */
331
332 #define util_strdup(X)  _util_Estrdup((X), __FILE__, __LINE__)
333 #define util_strdupe(X) _util_Estrdup_empty((X), __FILE__, __LINE__)
334
335 /*
336  * A flexible vector implementation: all vector pointers contain some
337  * data about themselfs exactly - sizeof(vector_t) behind the pointer
338  * this data is represented in the structure below.  Doing this allows
339  * us to use the array [] to access individual elements from the vector
340  * opposed to using set/get methods.
341  */
342 typedef struct {
343     size_t  allocated;
344     size_t  used;
345
346     /* can be extended now! whoot */
347 } vector_t;
348
349 /* hidden interface */
350 void _util_vec_grow(void **a, size_t i, size_t s);
351 #define GMQCC_VEC_WILLGROW(X,Y) ( \
352     ((!(X) || vec_meta(X)->used + Y >= vec_meta(X)->allocated)) ? \
353         (void)_util_vec_grow(((void**)&(X)), (Y), sizeof(*(X))) : \
354         (void)0                                                   \
355 )
356
357 /* exposed interface */
358 #define vec_meta(A)       (((vector_t*)(A)) - 1)
359 #define vec_free(A)       ((void)((A) ? (mem_d((void*)vec_meta(A)), (A) = NULL) : 0))
360 #define vec_push(A,V)     (GMQCC_VEC_WILLGROW((A),1), (A)[vec_meta(A)->used++] = (V))
361 #define vec_size(A)       ((A) ? vec_meta(A)->used : 0)
362 #define vec_add(A,N)      (GMQCC_VEC_WILLGROW((A),(N)), vec_meta(A)->used += (N), &(A)[vec_meta(A)->used-(N)])
363 #define vec_last(A)       ((A)[vec_meta(A)->used - 1])
364 #define vec_pop(A)        ((void)(vec_meta(A)->used -= 1))
365 #define vec_shrinkto(A,N) ((void)(vec_meta(A)->used  = (N)))
366 #define vec_shrinkby(A,N) ((void)(vec_meta(A)->used -= (N)))
367 #define vec_append(A,N,S) ((void)(memcpy(vec_add((A), (N)), (S), (N) * sizeof(*(S)))))
368 #define vec_upload(X,Y,S) ((void)(memcpy(vec_add((X), (S) * sizeof(*(Y))), (Y), (S) * sizeof(*(Y)))))
369 #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)))
370
371 typedef struct trie_s {
372     void          *value;
373     struct trie_s *entries;
374 } correct_trie_t;
375
376 correct_trie_t* correct_trie_new();
377
378 typedef struct hash_table_t {
379     size_t                size;
380     struct hash_node_t **table;
381 } hash_table_t, *ht;
382
383 typedef struct hash_set_t {
384     size_t  bits;
385     size_t  mask;
386     size_t  capacity;
387     size_t *items;
388     size_t  total;
389 } hash_set_t, *hs;
390
391 /*
392  * hashtable implementation:
393  *
394  * Note:
395  *      This was designed for pointers:  you manage the life of the object yourself
396  *      if you do use this for non-pointers please be warned that the object may not
397  *      be valid if the duration of it exceeds (i.e on stack).  So you need to allocate
398  *      yourself, or put those in global scope to ensure duration is for the whole
399  *      runtime.
400  *
401  * util_htnew(size)                             -- to make a new hashtable
402  * util_htset(table, key, value, sizeof(value)) -- to set something in the table
403  * util_htget(table, key)                       -- to get something from the table
404  * util_htdel(table)                            -- to delete the table
405  *
406  * example of use:
407  *
408  * ht    foo  = util_htnew(1024);
409  * int   data = 100;
410  * char *test = "hello world\n";
411  * util_htset(foo, "foo", (void*)&data);
412  * util_gtset(foo, "bar", (void*)test);
413  *
414  * printf("foo: %d, bar %s",
415  *     *((int *)util_htget(foo, "foo")),
416  *      ((char*)util_htget(foo, "bar"))
417  * );
418  *
419  * util_htdel(foo);
420  */
421 hash_table_t *util_htnew (size_t size);
422 void          util_htrem (hash_table_t *ht, void (*callback)(void *data));
423 void          util_htset (hash_table_t *ht, const char *key, void *value);
424 void          util_htdel (hash_table_t *ht);
425 size_t        util_hthash(hash_table_t *ht, const char *key);
426 void          util_htseth(hash_table_t *ht, const char *key, size_t hash, void *value);
427 void          util_htrmh (hash_table_t *ht, const char *key, size_t bin, void (*cb)(void*));
428 void          util_htrm  (hash_table_t *ht, const char *key, void (*cb)(void*));
429
430 void         *util_htget (hash_table_t *ht, const char *key);
431 void         *util_htgeth(hash_table_t *ht, const char *key, size_t hash);
432
433 /*
434  * hashset implementation:
435  *      This was designed for pointers:  you manage the life of the object yourself
436  *      if you do use this for non-pointers please be warned that the object may not
437  *      be valid if the duration of it exceeds (i.e on stack).  So you need to allocate
438  *      yourself, or put those in global scope to ensure duration is for the whole
439  *      runtime.
440  *
441  * util_hsnew()                             -- to make a new hashset
442  * util_hsadd(set, key)                     -- to add something in the set
443  * util_hshas(set, key)                     -- to check if something is in the set
444  * util_hsrem(set, key)                     -- to remove something in the set
445  * util_hsdel(set)                          -- to delete the set
446  *
447  * example of use:
448  * 
449  * hs    foo = util_hsnew();
450  * char *bar = "hello blub\n";
451  * char *baz = "hello dale\n";
452  *
453  * util_hsadd(foo, bar);
454  * util_hsadd(foo, baz);
455  * util_hsrem(foo, baz);
456  *
457  * printf("bar %d | baz %d\n",
458  *     util_hshas(foo, bar),
459  *     util_hshad(foo, baz)
460  * );
461  *
462  * util_hsdel(foo);  
463  */
464
465 hash_set_t *util_hsnew(void);
466 int         util_hsadd(hash_set_t *, void *);
467 int         util_hshas(hash_set_t *, void *);
468 int         util_hsrem(hash_set_t *, void *);
469 void        util_hsdel(hash_set_t *);
470  
471 /*===================================================================*/
472 /*============================ file.c ===============================*/
473 /*===================================================================*/
474 /* file handling */
475 void           fs_file_close  (FILE *);
476 int            fs_file_error  (FILE *);
477 int            fs_file_getc   (FILE *);
478 int            fs_file_printf (FILE *, const char *, ...);
479 int            fs_file_puts   (FILE *, const char *);
480 int            fs_file_seek   (FILE *, long int, int);
481 long int       fs_file_tell   (FILE *); 
482
483 size_t         fs_file_read   (void *,        size_t, size_t, FILE *);
484 size_t         fs_file_write  (const void *,  size_t, size_t, FILE *);
485
486 FILE          *fs_file_open   (const char *, const char *);
487 int            fs_file_getline(char  **, size_t *, FILE *);
488
489 /* directory handling */
490 int            fs_dir_make    (const char *);
491 DIR           *fs_dir_open    (const char *);
492 int            fs_dir_close   (DIR *);
493 struct dirent *fs_dir_read    (DIR *);
494
495
496 /*===================================================================*/
497 /*=========================== correct.c =============================*/
498 /*===================================================================*/
499 typedef struct {
500     char   ***edits;
501     size_t  **lens;
502 } correction_t;
503
504 void  correct_del (correct_trie_t*, size_t **);
505 void  correct_add (correct_trie_t*, size_t ***, const char *);
506 char *correct_str (correction_t *, correct_trie_t*, const char *);
507 void  correct_init(correction_t *);
508 void  correct_free(correction_t *);
509
510 /*===================================================================*/
511 /*=========================== code.c ================================*/
512 /*===================================================================*/
513
514 /* TODO: cleanup */
515 /* Note: if you change the order, fix type_sizeof in ir.c */
516 enum {
517     TYPE_VOID     ,
518     TYPE_STRING   ,
519     TYPE_FLOAT    ,
520     TYPE_VECTOR   ,
521     TYPE_ENTITY   ,
522     TYPE_FIELD    ,
523     TYPE_FUNCTION ,
524     TYPE_POINTER  ,
525     TYPE_INTEGER  ,
526     TYPE_VARIANT  ,
527     TYPE_STRUCT   ,
528     TYPE_UNION    ,
529     TYPE_ARRAY    ,
530
531     TYPE_NIL      , /* it's its own type / untyped */
532     TYPE_NOEXPR   , /* simply invalid in expressions */
533
534     TYPE_COUNT
535 };
536
537 /* const/var qualifiers */
538 #define CV_NONE   0
539 #define CV_CONST  1
540 #define CV_VAR   -1
541 #define CV_WRONG  0x8000 /* magic number to help parsing */
542
543 extern const char *type_name        [TYPE_COUNT];
544 extern uint16_t    type_store_instr [TYPE_COUNT];
545 extern uint16_t    field_store_instr[TYPE_COUNT];
546
547 /*
548  * could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
549  * but this breaks when TYPE_INTEGER is added, since with the enhanced
550  * instruction set, the old ones are left untouched, thus the _I instructions
551  * are at a seperate place.
552  */
553 extern uint16_t type_storep_instr[TYPE_COUNT];
554 extern uint16_t type_eq_instr    [TYPE_COUNT];
555 extern uint16_t type_ne_instr    [TYPE_COUNT];
556 extern uint16_t type_not_instr   [TYPE_COUNT];
557
558 typedef struct {
559     uint32_t offset;      /* Offset in file of where data begins  */
560     uint32_t length;      /* Length of section (how many of)      */
561 } prog_section;
562
563 typedef struct {
564     uint32_t     version;      /* Program version (6)     */
565     uint16_t     crc16;
566     uint16_t     skip;
567
568     prog_section statements;   /* prog_section_statement  */
569     prog_section defs;         /* prog_section_def        */
570     prog_section fields;       /* prog_section_field      */
571     prog_section functions;    /* prog_section_function   */
572     prog_section strings;
573     prog_section globals;
574     uint32_t     entfield;     /* Number of entity fields */
575 } prog_header;
576
577 /*
578  * Each paramater incerements by 3 since vector types hold
579  * 3 components (x,y,z).
580  */
581 #define OFS_NULL      0
582 #define OFS_RETURN    1
583 #define OFS_PARM0     (OFS_RETURN+3)
584 #define OFS_PARM1     (OFS_PARM0 +3)
585 #define OFS_PARM2     (OFS_PARM1 +3)
586 #define OFS_PARM3     (OFS_PARM2 +3)
587 #define OFS_PARM4     (OFS_PARM3 +3)
588 #define OFS_PARM5     (OFS_PARM4 +3)
589 #define OFS_PARM6     (OFS_PARM5 +3)
590 #define OFS_PARM7     (OFS_PARM6 +3)
591
592 typedef struct {
593     uint16_t opcode;
594
595     /* operand 1 */
596     union {
597         int16_t  s1; /* signed   */
598         uint16_t u1; /* unsigned */
599     } o1;
600     /* operand 2 */
601     union {
602         int16_t  s1; /* signed   */
603         uint16_t u1; /* unsigned */
604     } o2;
605     /* operand 3 */
606     union {
607         int16_t  s1; /* signed   */
608         uint16_t u1; /* unsigned */
609     } o3;
610
611     /*
612      * This is the same as the structure in darkplaces
613      * {
614      *     unsigned short op;
615      *     short          a,b,c;
616      * }
617      * But this one is more sane to work with, and the
618      * type sizes are guranteed.
619      */
620 } prog_section_statement;
621
622 typedef struct {
623     /*
624      * The types:
625      * 0 = ev_void
626      * 1 = ev_string
627      * 2 = ev_float
628      * 3 = ev_vector
629      * 4 = ev_entity
630      * 5 = ev_field
631      * 6 = ev_function
632      * 7 = ev_pointer -- engine only
633      * 8 = ev_bad     -- engine only
634      */
635     uint16_t type;
636     uint16_t offset;
637     uint32_t name;
638 } prog_section_both;
639
640 typedef prog_section_both prog_section_def;
641 typedef prog_section_both prog_section_field;
642
643 /* this is ORed to the type */
644 #define DEF_SAVEGLOBAL (1<<15)
645 #define DEF_TYPEMASK   ((1<<15)-1)
646
647 typedef struct {
648     int32_t   entry;      /* in statement table for instructions  */
649     uint32_t  firstlocal; /* First local in local table           */
650     uint32_t  locals;     /* Total ints of params + locals        */
651     uint32_t  profile;    /* Always zero (engine uses this)       */
652     uint32_t  name;       /* name of function in string table     */
653     uint32_t  file;       /* file of the source file              */
654     int32_t   nargs;      /* number of arguments                  */
655     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
656 } prog_section_function;
657
658 /*
659  * Instructions
660  * These are the external instructions supported by the interperter
661  * this is what things compile to (from the C code).
662  */
663 enum {
664     INSTR_DONE,
665     INSTR_MUL_F,
666     INSTR_MUL_V,
667     INSTR_MUL_FV, /* NOTE: the float operands must NOT be at the same locations: A != C */
668     INSTR_MUL_VF, /* and here: B != C */
669     INSTR_DIV_F,
670     INSTR_ADD_F,
671     INSTR_ADD_V,
672     INSTR_SUB_F,
673     INSTR_SUB_V,
674     INSTR_EQ_F,
675     INSTR_EQ_V,
676     INSTR_EQ_S,
677     INSTR_EQ_E,
678     INSTR_EQ_FNC,
679     INSTR_NE_F,
680     INSTR_NE_V,
681     INSTR_NE_S,
682     INSTR_NE_E,
683     INSTR_NE_FNC,
684     INSTR_LE,
685     INSTR_GE,
686     INSTR_LT,
687     INSTR_GT,
688     INSTR_LOAD_F,
689     INSTR_LOAD_V,
690     INSTR_LOAD_S,
691     INSTR_LOAD_ENT,
692     INSTR_LOAD_FLD,
693     INSTR_LOAD_FNC,
694     INSTR_ADDRESS,
695     INSTR_STORE_F,
696     INSTR_STORE_V,
697     INSTR_STORE_S,
698     INSTR_STORE_ENT,
699     INSTR_STORE_FLD,
700     INSTR_STORE_FNC,
701     INSTR_STOREP_F,
702     INSTR_STOREP_V,
703     INSTR_STOREP_S,
704     INSTR_STOREP_ENT,
705     INSTR_STOREP_FLD,
706     INSTR_STOREP_FNC,
707     INSTR_RETURN,
708     INSTR_NOT_F,
709     INSTR_NOT_V,
710     INSTR_NOT_S,
711     INSTR_NOT_ENT,
712     INSTR_NOT_FNC,
713     INSTR_IF,
714     INSTR_IFNOT,
715     INSTR_CALL0,
716     INSTR_CALL1,
717     INSTR_CALL2,
718     INSTR_CALL3,
719     INSTR_CALL4,
720     INSTR_CALL5,
721     INSTR_CALL6,
722     INSTR_CALL7,
723     INSTR_CALL8,
724     INSTR_STATE,
725     INSTR_GOTO,
726     INSTR_AND,
727     INSTR_OR,
728     INSTR_BITAND,
729     INSTR_BITOR,
730
731     /*
732      * Virtual instructions used by the IR
733      * Keep at the end!
734      */
735     VINSTR_END,
736     VINSTR_PHI,
737     VINSTR_JUMP,
738     VINSTR_COND,
739     /* A never returning CALL.
740      * Creating this causes IR blocks to be marked as 'final'.
741      * No-Return-Call
742      */
743     VINSTR_NRCALL
744 };
745
746 /* TODO: cleanup this mess */
747 extern prog_section_statement *code_statements;
748 extern int                    *code_linenums;
749 extern prog_section_def       *code_defs;
750 extern prog_section_field     *code_fields;
751 extern prog_section_function  *code_functions;
752 extern int                    *code_globals;
753 extern char                   *code_chars;
754 extern uint16_t code_crc;
755
756 /* uhh? */
757 typedef float   qcfloat;
758 typedef int32_t qcint;
759
760 /*
761  * code_write -- writes out the compiled file
762  * code_init  -- prepares the code file
763  */
764 bool     code_write       (const char *filename, const char *lno);
765 void     code_init        ();
766 uint32_t code_genstring   (const char *string);
767 qcint    code_alloc_field (size_t qcsize);
768
769 /* this function is used to keep statements and linenumbers together */
770 void     code_push_statement(prog_section_statement *stmt, int linenum);
771 void     code_pop_statement();
772
773 /*
774  * A shallow copy of a lex_file to remember where which ast node
775  * came from.
776  */
777 typedef struct {
778     const char *file;
779     size_t      line;
780 } lex_ctx;
781
782 /*===================================================================*/
783 /*============================ con.c ================================*/
784 /*===================================================================*/
785 enum {
786     CON_BLACK   = 30,
787     CON_RED,
788     CON_GREEN,
789     CON_BROWN,
790     CON_BLUE,
791     CON_MAGENTA,
792     CON_CYAN ,
793     CON_WHITE
794 };
795
796 /* message level */
797 enum {
798     LVL_MSG,
799     LVL_WARNING,
800     LVL_ERROR
801 };
802
803 FILE *con_default_out();
804 FILE *con_default_err();
805
806 void con_vprintmsg (int level, const char *name, size_t line, const char *msgtype, const char *msg, va_list ap);
807 void con_printmsg  (int level, const char *name, size_t line, const char *msgtype, const char *msg, ...);
808 void con_cvprintmsg(void *ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
809 void con_cprintmsg (void *ctx, int lvl, const char *msgtype, const char *msg, ...);
810
811 void con_close ();
812 void con_init  ();
813 void con_reset ();
814 void con_color (int);
815 int  con_change(const char *, const char *);
816 int  con_verr  (const char *, va_list);
817 int  con_vout  (const char *, va_list);
818 int  con_err   (const char *, ...);
819 int  con_out   (const char *, ...);
820
821 /* error/warning interface */
822 extern size_t compile_errors;
823 extern size_t compile_Werrors;
824 extern size_t compile_warnings;
825
826 void /********/ compile_error   (lex_ctx ctx, /*LVL_ERROR*/ const char *msg, ...);
827 void /********/ vcompile_error  (lex_ctx ctx, /*LVL_ERROR*/ const char *msg, va_list ap);
828 bool GMQCC_WARN compile_warning (lex_ctx ctx, int warntype, const char *fmt, ...);
829 bool GMQCC_WARN vcompile_warning(lex_ctx ctx, int warntype, const char *fmt, va_list ap);
830 void            compile_show_werrors();
831
832 /*===================================================================*/
833 /*========================= assembler.c =============================*/
834 /*===================================================================*/
835 /* TODO: remove this ... */
836 static const struct {
837     const char  *m; /* menomic     */
838     const size_t o; /* operands    */
839     const size_t l; /* menomic len */
840 } asm_instr[] = {
841     { "DONE"      , 1, 4 },
842     { "MUL_F"     , 3, 5 },
843     { "MUL_V"     , 3, 5 },
844     { "MUL_FV"    , 3, 6 },
845     { "MUL_VF"    , 3, 6 },
846     { "DIV"       , 0, 3 },
847     { "ADD_F"     , 3, 5 },
848     { "ADD_V"     , 3, 5 },
849     { "SUB_F"     , 3, 5 },
850     { "SUB_V"     , 3, 5 },
851     { "EQ_F"      , 0, 4 },
852     { "EQ_V"      , 0, 4 },
853     { "EQ_S"      , 0, 4 },
854     { "EQ_E"      , 0, 4 },
855     { "EQ_FNC"    , 0, 6 },
856     { "NE_F"      , 0, 4 },
857     { "NE_V"      , 0, 4 },
858     { "NE_S"      , 0, 4 },
859     { "NE_E"      , 0, 4 },
860     { "NE_FNC"    , 0, 6 },
861     { "LE"        , 0, 2 },
862     { "GE"        , 0, 2 },
863     { "LT"        , 0, 2 },
864     { "GT"        , 0, 2 },
865     { "FIELD_F"   , 0, 7 },
866     { "FIELD_V"   , 0, 7 },
867     { "FIELD_S"   , 0, 7 },
868     { "FIELD_ENT" , 0, 9 },
869     { "FIELD_FLD" , 0, 9 },
870     { "FIELD_FNC" , 0, 9 },
871     { "ADDRESS"   , 0, 7 },
872     { "STORE_F"   , 0, 7 },
873     { "STORE_V"   , 0, 7 },
874     { "STORE_S"   , 0, 7 },
875     { "STORE_ENT" , 0, 9 },
876     { "STORE_FLD" , 0, 9 },
877     { "STORE_FNC" , 0, 9 },
878     { "STOREP_F"  , 0, 8 },
879     { "STOREP_V"  , 0, 8 },
880     { "STOREP_S"  , 0, 8 },
881     { "STOREP_ENT", 0, 10},
882     { "STOREP_FLD", 0, 10},
883     { "STOREP_FNC", 0, 10},
884     { "RETURN"    , 0, 6 },
885     { "NOT_F"     , 0, 5 },
886     { "NOT_V"     , 0, 5 },
887     { "NOT_S"     , 0, 5 },
888     { "NOT_ENT"   , 0, 7 },
889     { "NOT_FNC"   , 0, 7 },
890     { "IF"        , 0, 2 },
891     { "IFNOT"     , 0, 5 },
892     { "CALL0"     , 1, 5 },
893     { "CALL1"     , 2, 5 },
894     { "CALL2"     , 3, 5 },
895     { "CALL3"     , 4, 5 },
896     { "CALL4"     , 5, 5 },
897     { "CALL5"     , 6, 5 },
898     { "CALL6"     , 7, 5 },
899     { "CALL7"     , 8, 5 },
900     { "CALL8"     , 9, 5 },
901     { "STATE"     , 0, 5 },
902     { "GOTO"      , 0, 4 },
903     { "AND"       , 0, 3 },
904     { "OR"        , 0, 2 },
905     { "BITAND"    , 0, 6 },
906     { "BITOR"     , 0, 5 },
907
908     { "END"       , 0, 3 } /* virtual assembler instruction */
909 };
910 /*===================================================================*/
911 /*============================= ir.c ================================*/
912 /*===================================================================*/
913
914 enum store_types {
915     store_global,
916     store_local,  /* local, assignable for now, should get promoted later */
917     store_param,  /* parameters, they are locals with a fixed position */
918     store_value,  /* unassignable */
919     store_return  /* unassignable, at OFS_RETURN */
920 };
921
922 typedef struct {
923     qcfloat x, y, z;
924 } vector;
925
926 vector  vec3_add  (vector, vector);
927 vector  vec3_sub  (vector, vector);
928 qcfloat vec3_mulvv(vector, vector);
929 vector  vec3_mulvf(vector, float);
930
931 /*===================================================================*/
932 /*============================= exec.c ==============================*/
933 /*===================================================================*/
934
935 /* TODO: cleanup */
936 /*
937  * Darkplaces has (or will have) a 64 bit prog loader
938  * where the 32 bit qc program is autoconverted on load.
939  * Since we may want to support that as well, let's redefine
940  * float and int here.
941  */
942 typedef union {
943     qcint   _int;
944     qcint    string;
945     qcint    function;
946     qcint    edict;
947     qcfloat _float;
948     qcfloat vector[3];
949     qcint   ivector[3];
950 } qcany;
951
952 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
953 typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
954
955 enum {
956     VMERR_OK,
957     VMERR_TEMPSTRING_ALLOC,
958
959     VMERR_END
960 };
961
962 #define VM_JUMPS_DEFAULT 1000000
963
964 /* execute-flags */
965 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
966 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
967 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
968
969 struct qc_program_s;
970
971 typedef int (*prog_builtin)(struct qc_program_s *prog);
972
973 typedef struct {
974     qcint                  stmt;
975     size_t                 localsp;
976     prog_section_function *function;
977 } qc_exec_stack;
978
979 typedef struct qc_program_s {
980     char           *filename;
981
982     prog_section_statement *code;
983     prog_section_def       *defs;
984     prog_section_def       *fields;
985     prog_section_function  *functions;
986     char                   *strings;
987     qcint                  *globals;
988     qcint                  *entitydata;
989     bool                   *entitypool;
990
991     const char*            *function_stack;
992
993     uint16_t crc16;
994
995     size_t tempstring_start;
996     size_t tempstring_at;
997
998     qcint  vmerror;
999
1000     size_t *profile;
1001
1002     prog_builtin *builtins;
1003     size_t        builtins_count;
1004
1005     /* size_t ip; */
1006     qcint  entities;
1007     size_t entityfields;
1008     bool   allowworldwrites;
1009
1010     qcint         *localstack;
1011     qc_exec_stack *stack;
1012     size_t statement;
1013
1014     size_t xflags;
1015
1016     int    argc; /* current arg count for debugging */
1017 } qc_program;
1018
1019 qc_program* prog_load(const char *filename, bool ignoreversion);
1020 void        prog_delete(qc_program *prog);
1021
1022 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
1023
1024 char*             prog_getstring (qc_program *prog, qcint str);
1025 prog_section_def* prog_entfield  (qc_program *prog, qcint off);
1026 prog_section_def* prog_getdef    (qc_program *prog, qcint off);
1027 qcany*            prog_getedict  (qc_program *prog, qcint e);
1028 qcint             prog_tempstring(qc_program *prog, const char *_str);
1029
1030
1031 /*===================================================================*/
1032 /*===================== parser.c commandline ========================*/
1033 /*===================================================================*/
1034 struct parser_s;
1035
1036 struct parser_s *parser_create        ();
1037 bool             parser_compile_file  (struct parser_s *parser, const char *);
1038 bool             parser_compile_string(struct parser_s *parser, const char *, const char *, size_t);
1039 bool             parser_finish        (struct parser_s *parser, const char *);
1040 void             parser_cleanup       (struct parser_s *parser);
1041
1042 /*===================================================================*/
1043 /*====================== ftepp.c commandline ========================*/
1044 /*===================================================================*/
1045 struct lex_file_s;
1046 struct ftepp_s;
1047
1048 typedef struct {
1049     const char  *name;
1050     char      *(*func)(struct lex_file_s *);
1051 } ftepp_predef_t;
1052
1053 /*
1054  * line, file, counter, counter_last, random, random_last, date, time
1055  * increment when items are added
1056  */
1057 #define FTEPP_PREDEF_COUNT 8
1058
1059 struct ftepp_s *ftepp_create           ();
1060 bool            ftepp_preprocess_file  (struct ftepp_s *ftepp, const char *filename);
1061 bool            ftepp_preprocess_string(struct ftepp_s *ftepp, const char *name, const char *str);
1062 void            ftepp_finish           (struct ftepp_s *ftepp);
1063 const char     *ftepp_get              (struct ftepp_s *ftepp);
1064 void            ftepp_flush            (struct ftepp_s *ftepp);
1065 void            ftepp_add_define       (struct ftepp_s *ftepp, const char *source, const char *name);
1066 void            ftepp_add_macro        (struct ftepp_s *ftepp, const char *name,   const char *value);
1067
1068 extern const ftepp_predef_t ftepp_predefs[FTEPP_PREDEF_COUNT];
1069
1070 /*===================================================================*/
1071 /*======================= main.c commandline ========================*/
1072 /*===================================================================*/
1073
1074 #if 1
1075 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
1076  * to 32 or 64 -f options...
1077  */
1078 typedef struct {
1079     size_t  idx; /* index into an array of 32 bit words */
1080     uint8_t bit; /* bit index for the 8 bit group idx points to */
1081 } longbit;
1082 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
1083 #define LONGBIT_SET(B, I) ((B).idx = (I)/32, (B).bit = ((I)%32))
1084 #else
1085 typedef uint32_t longbit;
1086 #define LONGBIT(bit) (bit)
1087 #define LONGBIT_SET(B, I) ((B) = (I))
1088 #endif
1089
1090 /*===================================================================*/
1091 /*=========================== utf8lib.c =============================*/
1092 /*===================================================================*/
1093 typedef uint32_t uchar_t;
1094
1095 bool    u8_analyze (const char *_s, size_t *_start, size_t *_len, uchar_t *_ch, size_t _maxlen);
1096 size_t  u8_strlen  (const char*);
1097 size_t  u8_strnlen (const char*, size_t);
1098 uchar_t u8_getchar (const char*, const char**);
1099 uchar_t u8_getnchar(const char*, const char**, size_t);
1100 int     u8_fromchar(uchar_t w,   char *to,     size_t maxlen);
1101
1102 /*===================================================================*/
1103 /*============================= opts.c ==============================*/
1104 /*===================================================================*/
1105 typedef struct {
1106     const char *name;
1107     longbit     bit;
1108 } opts_flag_def;
1109
1110 bool opts_setflag  (const char *, bool);
1111 bool opts_setwarn  (const char *, bool);
1112 bool opts_setwerror(const char *, bool);
1113 bool opts_setoptim (const char *, bool);
1114
1115 void opts_init         (const char *, int, size_t);
1116 void opts_set          (uint32_t   *, size_t, bool);
1117 void opts_setoptimlevel(unsigned int);
1118 void opts_ini_init     (const char *);
1119
1120 /* Saner flag handling */
1121 void opts_backup_non_Wall();
1122 void opts_restore_non_Wall();
1123 void opts_backup_non_Werror_all();
1124 void opts_restore_non_Werror_all();
1125
1126 enum {
1127 # define GMQCC_TYPE_FLAGS
1128 # define GMQCC_DEFINE_FLAG(X) X,
1129 #  include "opts.def"
1130     COUNT_FLAGS
1131 };
1132 static const opts_flag_def opts_flag_list[] = {
1133 # define GMQCC_TYPE_FLAGS
1134 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
1135 #  include "opts.def"
1136     { NULL, LONGBIT(0) }
1137 };
1138
1139 enum {
1140 # define GMQCC_TYPE_WARNS
1141 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
1142 #  include "opts.def"
1143     COUNT_WARNINGS
1144 };
1145 static const opts_flag_def opts_warn_list[] = {
1146 # define GMQCC_TYPE_WARNS
1147 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
1148 #  include "opts.def"
1149     { NULL, LONGBIT(0) }
1150 };
1151
1152 enum {
1153 # define GMQCC_TYPE_OPTIMIZATIONS
1154 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) OPTIM_##NAME,
1155 #  include "opts.def"
1156     COUNT_OPTIMIZATIONS
1157 };
1158 static const opts_flag_def opts_opt_list[] = {
1159 # define GMQCC_TYPE_OPTIMIZATIONS
1160 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) { #NAME, LONGBIT(OPTIM_##NAME) },
1161 #  include "opts.def"
1162     { NULL, LONGBIT(0) }
1163 };
1164 static const unsigned int opts_opt_oflag[] = {
1165 # define GMQCC_TYPE_OPTIMIZATIONS
1166 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) MIN_O,
1167 #  include "opts.def"
1168     0
1169 };
1170
1171 enum {
1172 #   define GMQCC_TYPE_OPTIONS
1173 #   define GMQCC_DEFINE_FLAG(X) OPTION_##X,
1174 #   include "opts.def"
1175     OPTION_COUNT
1176 };
1177
1178 extern unsigned int opts_optimizationcount[COUNT_OPTIMIZATIONS];
1179
1180 /* other options: */
1181 typedef enum {
1182     COMPILER_QCC,     /* circa  QuakeC */
1183     COMPILER_FTEQCC,  /* fteqcc QuakeC */
1184     COMPILER_QCCX,    /* qccx   QuakeC */
1185     COMPILER_GMQCC    /* this   QuakeC */
1186 } opts_std_t;
1187
1188 typedef union {
1189     bool     B;
1190     uint16_t U16;
1191     uint32_t U32;
1192     char    *STR;
1193 } opt_value_t;
1194
1195
1196 typedef struct {
1197     opt_value_t  options      [OPTION_COUNT];
1198     uint32_t     flags        [1 + (COUNT_FLAGS         / 32)];
1199     uint32_t     warn         [1 + (COUNT_WARNINGS      / 32)];
1200     uint32_t     werror       [1 + (COUNT_WARNINGS      / 32)];
1201     uint32_t     warn_backup  [1 + (COUNT_WARNINGS      / 32)];
1202     uint32_t     werror_backup[1 + (COUNT_WARNINGS      / 32)];
1203     uint32_t     optimization [1 + (COUNT_OPTIMIZATIONS / 32)];
1204     bool         optimizeoff; /* True when -O0 */
1205 } opts_cmd_t;
1206
1207 extern opts_cmd_t opts;
1208
1209 #define OPTS_GENERIC(f,i)    (!! (((f)[(i)/32]) & (1<< ((i)%32))))
1210 #define OPTS_FLAG(i)         OPTS_GENERIC(opts.flags,        (i))
1211 #define OPTS_WARN(i)         OPTS_GENERIC(opts.warn,         (i))
1212 #define OPTS_WERROR(i)       OPTS_GENERIC(opts.werror,       (i))
1213 #define OPTS_OPTIMIZATION(i) OPTS_GENERIC(opts.optimization, (i))
1214 #define OPTS_OPTION_BOOL(X) (opts.options[X].B)
1215 #define OPTS_OPTION_U16(X)  (opts.options[X].U16)
1216 #define OPTS_OPTION_U32(X)  (opts.options[X].U32)
1217 #define OPTS_OPTION_STR(X)  (opts.options[X].STR)
1218
1219 #endif /*! GMQCC_HDR */