42e771459303cc7be78cb564abd28b7d5d73273e
[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 void  util_debug         (const char *, const char *, ...);
305 void  util_endianswap    (void *,  size_t, unsigned int);
306
307 size_t util_strtocmd    (const char *, char *, size_t);
308 size_t util_strtononcmd (const char *, char *, size_t);
309
310 uint16_t util_crc16(uint16_t crc, const char *data, size_t len);
311
312 void     util_seed(uint32_t);
313 uint32_t util_rand();
314
315 int util_vasprintf(char **ret, const char *fmt, va_list);
316 int util_asprintf (char **ret, const char *fmt, ...);
317
318
319 #ifdef NOTRACK
320 #    define mem_a(x)      malloc (x)
321 #    define mem_d(x)      free   ((void*)x)
322 #    define mem_r(x, n)   realloc((void*)x, n)
323 #    define mem_af(x,f,l) malloc (x)
324 #else
325 #    define mem_a(x)      util_memory_a((x), __LINE__, __FILE__)
326 #    define mem_d(x)      util_memory_d((void*)(x))
327 #    define mem_r(x, n)   util_memory_r((void*)(x), (n), __LINE__, __FILE__)
328 #    define mem_af(x,f,l) util_memory_a((x), __LINE__, __FILE__)
329 #endif /*! NOTRACK */
330
331 #define util_strdup(X)  _util_Estrdup((X), __FILE__, __LINE__)
332
333 /*
334  * A flexible vector implementation: all vector pointers contain some
335  * data about themselfs exactly - sizeof(vector_t) behind the pointer
336  * this data is represented in the structure below.  Doing this allows
337  * us to use the array [] to access individual elements from the vector
338  * opposed to using set/get methods.
339  */     
340 typedef struct {
341     size_t  allocated;
342     size_t  used;
343
344     /* can be extended now! whoot */
345 } vector_t;
346
347 /* hidden interface */
348 void _util_vec_grow(void **a, size_t i, size_t s);
349 #define GMQCC_VEC_WILLGROW(X,Y) ( \
350     ((!(X) || vec_meta(X)->used + Y >= vec_meta(X)->allocated)) ? \
351         (void)_util_vec_grow(((void**)&(X)), (Y), sizeof(*(X))) : \
352         (void)0                                                   \
353 )
354
355 /* exposed interface */
356 #define vec_meta(A)       (((vector_t*)(A)) - 1)
357 #define vec_free(A)       ((void)((A) ? (mem_d((void*)vec_meta(A)), (A) = NULL) : 0))
358 #define vec_push(A,V)     (GMQCC_VEC_WILLGROW((A),1), (A)[vec_meta(A)->used++] = (V))
359 #define vec_size(A)       ((A) ? vec_meta(A)->used : 0)
360 #define vec_add(A,N)      (GMQCC_VEC_WILLGROW((A),(N)), vec_meta(A)->used += (N), &(A)[vec_meta(A)->used-(N)])
361 #define vec_last(A)       ((A)[vec_meta(A)->used - 1])
362 #define vec_pop(A)        ((void)(vec_meta(A)->used -= 1))
363 #define vec_shrinkto(A,N) ((void)(vec_meta(A)->used  = (N)))
364 #define vec_shrinkby(A,N) ((void)(vec_meta(A)->used -= (N)))
365 #define vec_append(A,N,S) ((void)(memcpy(vec_add((A), (N)), (S), (N) * sizeof(*(S)))))
366 #define vec_upload(X,Y,S) ((void)(memcpy(vec_add((X), (S) * sizeof(*(Y))), (Y), (S) * sizeof(*(Y)))))
367 #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)))
368
369 typedef struct trie_s {
370     void          *value;
371     struct trie_s *entries;
372 } correct_trie_t;
373
374 correct_trie_t* correct_trie_new();
375
376 typedef struct hash_table_t {
377     size_t                size;
378     struct hash_node_t **table;
379 } hash_table_t, *ht;
380
381 typedef struct hash_set_t {
382     size_t  bits;
383     size_t  mask;
384     size_t  capacity;
385     size_t *items;
386     size_t  total;
387 } hash_set_t, *hs;
388
389 /*
390  * hashtable implementation:
391  *
392  * Note:
393  *      This was designed for pointers:  you manage the life of the object yourself
394  *      if you do use this for non-pointers please be warned that the object may not
395  *      be valid if the duration of it exceeds (i.e on stack).  So you need to allocate
396  *      yourself, or put those in global scope to ensure duration is for the whole
397  *      runtime.
398  *
399  * util_htnew(size)                             -- to make a new hashtable
400  * util_htset(table, key, value, sizeof(value)) -- to set something in the table
401  * util_htget(table, key)                       -- to get something from the table
402  * util_htdel(table)                            -- to delete the table
403  *
404  * example of use:
405  *
406  * ht    foo  = util_htnew(1024);
407  * int   data = 100;
408  * char *test = "hello world\n";
409  * util_htset(foo, "foo", (void*)&data);
410  * util_gtset(foo, "bar", (void*)test);
411  *
412  * printf("foo: %d, bar %s",
413  *     *((int *)util_htget(foo, "foo")),
414  *      ((char*)util_htget(foo, "bar"))
415  * );
416  *
417  * util_htdel(foo);
418  */
419 hash_table_t *util_htnew (size_t size);
420 void          util_htrem (hash_table_t *ht, void (*callback)(void *data));
421 void          util_htset (hash_table_t *ht, const char *key, void *value);
422 void          util_htdel (hash_table_t *ht);
423 size_t        util_hthash(hash_table_t *ht, const char *key);
424 void          util_htseth(hash_table_t *ht, const char *key, size_t hash, void *value);
425 void          util_htrmh (hash_table_t *ht, const char *key, size_t bin, void (*cb)(void*));
426 void          util_htrm  (hash_table_t *ht, const char *key, void (*cb)(void*));
427
428 void         *util_htget (hash_table_t *ht, const char *key);
429 void         *util_htgeth(hash_table_t *ht, const char *key, size_t hash);
430
431 /*
432  * hashset implementation:
433  *      This was designed for pointers:  you manage the life of the object yourself
434  *      if you do use this for non-pointers please be warned that the object may not
435  *      be valid if the duration of it exceeds (i.e on stack).  So you need to allocate
436  *      yourself, or put those in global scope to ensure duration is for the whole
437  *      runtime.
438  *
439  * util_hsnew()                             -- to make a new hashset
440  * util_hsadd(set, key)                     -- to add something in the set
441  * util_hshas(set, key)                     -- to check if something is in the set
442  * util_hsrem(set, key)                     -- to remove something in the set
443  * util_hsdel(set)                          -- to delete the set
444  *
445  * example of use:
446  * 
447  * hs    foo = util_hsnew();
448  * char *bar = "hello blub\n";
449  * char *baz = "hello dale\n";
450  *
451  * util_hsadd(foo, bar);
452  * util_hsadd(foo, baz);
453  * util_hsrem(foo, baz);
454  *
455  * printf("bar %d | baz %d\n",
456  *     util_hshas(foo, bar),
457  *     util_hshad(foo, baz)
458  * );
459  *
460  * util_hsdel(foo);  
461  */
462
463 hash_set_t *util_hsnew(void);
464 int         util_hsadd(hash_set_t *, void *);
465 int         util_hshas(hash_set_t *, void *);
466 int         util_hsrem(hash_set_t *, void *);
467 void        util_hsdel(hash_set_t *);
468  
469 /*===================================================================*/
470 /*============================ file.c ===============================*/
471 /*===================================================================*/
472 /* file handling */
473 void           fs_file_close  (FILE *);
474 int            fs_file_error  (FILE *);
475 int            fs_file_getc   (FILE *);
476 int            fs_file_printf (FILE *, const char *, ...);
477 int            fs_file_puts   (FILE *, const char *);
478 int            fs_file_seek   (FILE *, long int, int);
479 long int       fs_file_tell   (FILE *); 
480
481 size_t         fs_file_read   (void *,        size_t, size_t, FILE *);
482 size_t         fs_file_write  (const void *,  size_t, size_t, FILE *);
483
484 FILE          *fs_file_open   (const char *, const char *);
485 int            fs_file_getline(char  **, size_t *, FILE *);
486
487 /* directory handling */
488 int            fs_dir_make    (const char *);
489 DIR           *fs_dir_open    (const char *);
490 int            fs_dir_close   (DIR *);
491 struct dirent *fs_dir_read    (DIR *);
492
493
494 /*===================================================================*/
495 /*=========================== correct.c =============================*/
496 /*===================================================================*/
497 typedef struct {
498     char   ***edits;
499     size_t  **lens;
500 } correction_t;
501
502 void  correct_del (correct_trie_t*, size_t **);
503 void  correct_add (correct_trie_t*, size_t ***, const char *);
504 char *correct_str (correction_t *, correct_trie_t*, const char *);
505 void  correct_init(correction_t *);
506 void  correct_free(correction_t *);
507
508 /*===================================================================*/
509 /*=========================== code.c ================================*/
510 /*===================================================================*/
511
512 /* TODO: cleanup */
513 /* Note: if you change the order, fix type_sizeof in ir.c */
514 enum {
515     TYPE_VOID     ,
516     TYPE_STRING   ,
517     TYPE_FLOAT    ,
518     TYPE_VECTOR   ,
519     TYPE_ENTITY   ,
520     TYPE_FIELD    ,
521     TYPE_FUNCTION ,
522     TYPE_POINTER  ,
523     TYPE_INTEGER  ,
524     TYPE_VARIANT  ,
525     TYPE_STRUCT   ,
526     TYPE_UNION    ,
527     TYPE_ARRAY    ,
528
529     TYPE_NIL      , /* it's its own type / untyped */
530     TYPE_NOEXPR   , /* simply invalid in expressions */
531
532     TYPE_COUNT
533 };
534
535 /* const/var qualifiers */
536 #define CV_NONE   0
537 #define CV_CONST  1
538 #define CV_VAR   -1
539 #define CV_WRONG  0x8000 /* magic number to help parsing */
540
541 extern const char *type_name        [TYPE_COUNT];
542 extern uint16_t    type_store_instr [TYPE_COUNT];
543 extern uint16_t    field_store_instr[TYPE_COUNT];
544
545 /*
546  * could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
547  * but this breaks when TYPE_INTEGER is added, since with the enhanced
548  * instruction set, the old ones are left untouched, thus the _I instructions
549  * are at a seperate place.
550  */
551 extern uint16_t type_storep_instr[TYPE_COUNT];
552 extern uint16_t type_eq_instr    [TYPE_COUNT];
553 extern uint16_t type_ne_instr    [TYPE_COUNT];
554 extern uint16_t type_not_instr   [TYPE_COUNT];
555
556 typedef struct {
557     uint32_t offset;      /* Offset in file of where data begins  */
558     uint32_t length;      /* Length of section (how many of)      */
559 } prog_section;
560
561 typedef struct {
562     uint32_t     version;      /* Program version (6)     */
563     uint16_t     crc16;
564     uint16_t     skip;
565
566     prog_section statements;   /* prog_section_statement  */
567     prog_section defs;         /* prog_section_def        */
568     prog_section fields;       /* prog_section_field      */
569     prog_section functions;    /* prog_section_function   */
570     prog_section strings;
571     prog_section globals;
572     uint32_t     entfield;     /* Number of entity fields */
573 } prog_header;
574
575 /*
576  * Each paramater incerements by 3 since vector types hold
577  * 3 components (x,y,z).
578  */
579 #define OFS_NULL      0
580 #define OFS_RETURN    1
581 #define OFS_PARM0     (OFS_RETURN+3)
582 #define OFS_PARM1     (OFS_PARM0 +3)
583 #define OFS_PARM2     (OFS_PARM1 +3)
584 #define OFS_PARM3     (OFS_PARM2 +3)
585 #define OFS_PARM4     (OFS_PARM3 +3)
586 #define OFS_PARM5     (OFS_PARM4 +3)
587 #define OFS_PARM6     (OFS_PARM5 +3)
588 #define OFS_PARM7     (OFS_PARM6 +3)
589
590 typedef struct {
591     uint16_t opcode;
592
593     /* operand 1 */
594     union {
595         int16_t  s1; /* signed   */
596         uint16_t u1; /* unsigned */
597     } o1;
598     /* operand 2 */
599     union {
600         int16_t  s1; /* signed   */
601         uint16_t u1; /* unsigned */
602     } o2;
603     /* operand 3 */
604     union {
605         int16_t  s1; /* signed   */
606         uint16_t u1; /* unsigned */
607     } o3;
608
609     /*
610      * This is the same as the structure in darkplaces
611      * {
612      *     unsigned short op;
613      *     short          a,b,c;
614      * }
615      * But this one is more sane to work with, and the
616      * type sizes are guranteed.
617      */
618 } prog_section_statement;
619
620 typedef struct {
621     /*
622      * The types:
623      * 0 = ev_void
624      * 1 = ev_string
625      * 2 = ev_float
626      * 3 = ev_vector
627      * 4 = ev_entity
628      * 5 = ev_field
629      * 6 = ev_function
630      * 7 = ev_pointer -- engine only
631      * 8 = ev_bad     -- engine only
632      */
633     uint16_t type;
634     uint16_t offset;
635     uint32_t name;
636 } prog_section_both;
637
638 typedef prog_section_both prog_section_def;
639 typedef prog_section_both prog_section_field;
640
641 /* this is ORed to the type */
642 #define DEF_SAVEGLOBAL (1<<15)
643 #define DEF_TYPEMASK   ((1<<15)-1)
644
645 typedef struct {
646     int32_t   entry;      /* in statement table for instructions  */
647     uint32_t  firstlocal; /* First local in local table           */
648     uint32_t  locals;     /* Total ints of params + locals        */
649     uint32_t  profile;    /* Always zero (engine uses this)       */
650     uint32_t  name;       /* name of function in string table     */
651     uint32_t  file;       /* file of the source file              */
652     int32_t   nargs;      /* number of arguments                  */
653     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
654 } prog_section_function;
655
656 /*
657  * Instructions
658  * These are the external instructions supported by the interperter
659  * this is what things compile to (from the C code).
660  */
661 enum {
662     INSTR_DONE,
663     INSTR_MUL_F,
664     INSTR_MUL_V,
665     INSTR_MUL_FV, /* NOTE: the float operands must NOT be at the same locations: A != C */
666     INSTR_MUL_VF, /* and here: B != C */
667     INSTR_DIV_F,
668     INSTR_ADD_F,
669     INSTR_ADD_V,
670     INSTR_SUB_F,
671     INSTR_SUB_V,
672     INSTR_EQ_F,
673     INSTR_EQ_V,
674     INSTR_EQ_S,
675     INSTR_EQ_E,
676     INSTR_EQ_FNC,
677     INSTR_NE_F,
678     INSTR_NE_V,
679     INSTR_NE_S,
680     INSTR_NE_E,
681     INSTR_NE_FNC,
682     INSTR_LE,
683     INSTR_GE,
684     INSTR_LT,
685     INSTR_GT,
686     INSTR_LOAD_F,
687     INSTR_LOAD_V,
688     INSTR_LOAD_S,
689     INSTR_LOAD_ENT,
690     INSTR_LOAD_FLD,
691     INSTR_LOAD_FNC,
692     INSTR_ADDRESS,
693     INSTR_STORE_F,
694     INSTR_STORE_V,
695     INSTR_STORE_S,
696     INSTR_STORE_ENT,
697     INSTR_STORE_FLD,
698     INSTR_STORE_FNC,
699     INSTR_STOREP_F,
700     INSTR_STOREP_V,
701     INSTR_STOREP_S,
702     INSTR_STOREP_ENT,
703     INSTR_STOREP_FLD,
704     INSTR_STOREP_FNC,
705     INSTR_RETURN,
706     INSTR_NOT_F,
707     INSTR_NOT_V,
708     INSTR_NOT_S,
709     INSTR_NOT_ENT,
710     INSTR_NOT_FNC,
711     INSTR_IF,
712     INSTR_IFNOT,
713     INSTR_CALL0,
714     INSTR_CALL1,
715     INSTR_CALL2,
716     INSTR_CALL3,
717     INSTR_CALL4,
718     INSTR_CALL5,
719     INSTR_CALL6,
720     INSTR_CALL7,
721     INSTR_CALL8,
722     INSTR_STATE,
723     INSTR_GOTO,
724     INSTR_AND,
725     INSTR_OR,
726     INSTR_BITAND,
727     INSTR_BITOR,
728
729     /*
730      * Virtual instructions used by the IR
731      * Keep at the end!
732      */
733     VINSTR_END,
734     VINSTR_PHI,
735     VINSTR_JUMP,
736     VINSTR_COND,
737     /* A never returning CALL.
738      * Creating this causes IR blocks to be marked as 'final'.
739      * No-Return-Call
740      */
741     VINSTR_NRCALL
742 };
743
744 /* TODO: cleanup this mess */
745 extern prog_section_statement *code_statements;
746 extern int                    *code_linenums;
747 extern prog_section_def       *code_defs;
748 extern prog_section_field     *code_fields;
749 extern prog_section_function  *code_functions;
750 extern int                    *code_globals;
751 extern char                   *code_chars;
752 extern uint16_t code_crc;
753
754 /* uhh? */
755 typedef float   qcfloat;
756 typedef int32_t qcint;
757
758 /*
759  * code_write -- writes out the compiled file
760  * code_init  -- prepares the code file
761  */
762 bool     code_write       (const char *filename, const char *lno);
763 void     code_init        ();
764 uint32_t code_genstring   (const char *string);
765 qcint    code_alloc_field (size_t qcsize);
766
767 /* this function is used to keep statements and linenumbers together */
768 void     code_push_statement(prog_section_statement *stmt, int linenum);
769 void     code_pop_statement();
770
771 /*
772  * A shallow copy of a lex_file to remember where which ast node
773  * came from.
774  */
775 typedef struct {
776     const char *file;
777     size_t      line;
778 } lex_ctx;
779
780 /*===================================================================*/
781 /*============================ con.c ================================*/
782 /*===================================================================*/
783 enum {
784     CON_BLACK   = 30,
785     CON_RED,
786     CON_GREEN,
787     CON_BROWN,
788     CON_BLUE,
789     CON_MAGENTA,
790     CON_CYAN ,
791     CON_WHITE
792 };
793
794 /* message level */
795 enum {
796     LVL_MSG,
797     LVL_WARNING,
798     LVL_ERROR
799 };
800
801 FILE *con_default_out();
802 FILE *con_default_err();
803
804 void con_vprintmsg (int level, const char *name, size_t line, const char *msgtype, const char *msg, va_list ap);
805 void con_printmsg  (int level, const char *name, size_t line, const char *msgtype, const char *msg, ...);
806 void con_cvprintmsg(void *ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
807 void con_cprintmsg (void *ctx, int lvl, const char *msgtype, const char *msg, ...);
808
809 void con_close ();
810 void con_init  ();
811 void con_reset ();
812 void con_color (int);
813 int  con_change(const char *, const char *);
814 int  con_verr  (const char *, va_list);
815 int  con_vout  (const char *, va_list);
816 int  con_err   (const char *, ...);
817 int  con_out   (const char *, ...);
818
819 /* error/warning interface */
820 extern size_t compile_errors;
821 extern size_t compile_Werrors;
822 extern size_t compile_warnings;
823
824 void /********/ compile_error   (lex_ctx ctx, /*LVL_ERROR*/ const char *msg, ...);
825 void /********/ vcompile_error  (lex_ctx ctx, /*LVL_ERROR*/ const char *msg, va_list ap);
826 bool GMQCC_WARN compile_warning (lex_ctx ctx, int warntype, const char *fmt, ...);
827 bool GMQCC_WARN vcompile_warning(lex_ctx ctx, int warntype, const char *fmt, va_list ap);
828 void            compile_show_werrors();
829
830 /*===================================================================*/
831 /*========================= assembler.c =============================*/
832 /*===================================================================*/
833 /* TODO: remove this ... */
834 static const struct {
835     const char  *m; /* menomic     */
836     const size_t o; /* operands    */
837     const size_t l; /* menomic len */
838 } asm_instr[] = {
839     { "DONE"      , 1, 4 },
840     { "MUL_F"     , 3, 5 },
841     { "MUL_V"     , 3, 5 },
842     { "MUL_FV"    , 3, 6 },
843     { "MUL_VF"    , 3, 6 },
844     { "DIV"       , 0, 3 },
845     { "ADD_F"     , 3, 5 },
846     { "ADD_V"     , 3, 5 },
847     { "SUB_F"     , 3, 5 },
848     { "SUB_V"     , 3, 5 },
849     { "EQ_F"      , 0, 4 },
850     { "EQ_V"      , 0, 4 },
851     { "EQ_S"      , 0, 4 },
852     { "EQ_E"      , 0, 4 },
853     { "EQ_FNC"    , 0, 6 },
854     { "NE_F"      , 0, 4 },
855     { "NE_V"      , 0, 4 },
856     { "NE_S"      , 0, 4 },
857     { "NE_E"      , 0, 4 },
858     { "NE_FNC"    , 0, 6 },
859     { "LE"        , 0, 2 },
860     { "GE"        , 0, 2 },
861     { "LT"        , 0, 2 },
862     { "GT"        , 0, 2 },
863     { "FIELD_F"   , 0, 7 },
864     { "FIELD_V"   , 0, 7 },
865     { "FIELD_S"   , 0, 7 },
866     { "FIELD_ENT" , 0, 9 },
867     { "FIELD_FLD" , 0, 9 },
868     { "FIELD_FNC" , 0, 9 },
869     { "ADDRESS"   , 0, 7 },
870     { "STORE_F"   , 0, 7 },
871     { "STORE_V"   , 0, 7 },
872     { "STORE_S"   , 0, 7 },
873     { "STORE_ENT" , 0, 9 },
874     { "STORE_FLD" , 0, 9 },
875     { "STORE_FNC" , 0, 9 },
876     { "STOREP_F"  , 0, 8 },
877     { "STOREP_V"  , 0, 8 },
878     { "STOREP_S"  , 0, 8 },
879     { "STOREP_ENT", 0, 10},
880     { "STOREP_FLD", 0, 10},
881     { "STOREP_FNC", 0, 10},
882     { "RETURN"    , 0, 6 },
883     { "NOT_F"     , 0, 5 },
884     { "NOT_V"     , 0, 5 },
885     { "NOT_S"     , 0, 5 },
886     { "NOT_ENT"   , 0, 7 },
887     { "NOT_FNC"   , 0, 7 },
888     { "IF"        , 0, 2 },
889     { "IFNOT"     , 0, 5 },
890     { "CALL0"     , 1, 5 },
891     { "CALL1"     , 2, 5 },
892     { "CALL2"     , 3, 5 },
893     { "CALL3"     , 4, 5 },
894     { "CALL4"     , 5, 5 },
895     { "CALL5"     , 6, 5 },
896     { "CALL6"     , 7, 5 },
897     { "CALL7"     , 8, 5 },
898     { "CALL8"     , 9, 5 },
899     { "STATE"     , 0, 5 },
900     { "GOTO"      , 0, 4 },
901     { "AND"       , 0, 3 },
902     { "OR"        , 0, 2 },
903     { "BITAND"    , 0, 6 },
904     { "BITOR"     , 0, 5 },
905
906     { "END"       , 0, 3 } /* virtual assembler instruction */
907 };
908 /*===================================================================*/
909 /*============================= ir.c ================================*/
910 /*===================================================================*/
911
912 enum store_types {
913     store_global,
914     store_local,  /* local, assignable for now, should get promoted later */
915     store_param,  /* parameters, they are locals with a fixed position */
916     store_value,  /* unassignable */
917     store_return  /* unassignable, at OFS_RETURN */
918 };
919
920 typedef struct {
921     qcfloat x, y, z;
922 } vector;
923
924 vector  vec3_add  (vector, vector);
925 vector  vec3_sub  (vector, vector);
926 qcfloat vec3_mulvv(vector, vector);
927 vector  vec3_mulvf(vector, float);
928
929 /*===================================================================*/
930 /*============================= exec.c ==============================*/
931 /*===================================================================*/
932
933 /* TODO: cleanup */
934 /*
935  * Darkplaces has (or will have) a 64 bit prog loader
936  * where the 32 bit qc program is autoconverted on load.
937  * Since we may want to support that as well, let's redefine
938  * float and int here.
939  */
940 typedef union {
941     qcint   _int;
942     qcint    string;
943     qcint    function;
944     qcint    edict;
945     qcfloat _float;
946     qcfloat vector[3];
947     qcint   ivector[3];
948 } qcany;
949
950 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
951 typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
952
953 enum {
954     VMERR_OK,
955     VMERR_TEMPSTRING_ALLOC,
956
957     VMERR_END
958 };
959
960 #define VM_JUMPS_DEFAULT 1000000
961
962 /* execute-flags */
963 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
964 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
965 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
966
967 struct qc_program_s;
968
969 typedef int (*prog_builtin)(struct qc_program_s *prog);
970
971 typedef struct {
972     qcint                  stmt;
973     size_t                 localsp;
974     prog_section_function *function;
975 } qc_exec_stack;
976
977 typedef struct qc_program_s {
978     char           *filename;
979
980     prog_section_statement *code;
981     prog_section_def       *defs;
982     prog_section_def       *fields;
983     prog_section_function  *functions;
984     char                   *strings;
985     qcint                  *globals;
986     qcint                  *entitydata;
987     bool                   *entitypool;
988
989     const char*            *function_stack;
990
991     uint16_t crc16;
992
993     size_t tempstring_start;
994     size_t tempstring_at;
995
996     qcint  vmerror;
997
998     size_t *profile;
999
1000     prog_builtin *builtins;
1001     size_t        builtins_count;
1002
1003     /* size_t ip; */
1004     qcint  entities;
1005     size_t entityfields;
1006     bool   allowworldwrites;
1007
1008     qcint         *localstack;
1009     qc_exec_stack *stack;
1010     size_t statement;
1011
1012     size_t xflags;
1013
1014     int    argc; /* current arg count for debugging */
1015 } qc_program;
1016
1017 qc_program* prog_load(const char *filename, bool ignoreversion);
1018 void        prog_delete(qc_program *prog);
1019
1020 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
1021
1022 char*             prog_getstring (qc_program *prog, qcint str);
1023 prog_section_def* prog_entfield  (qc_program *prog, qcint off);
1024 prog_section_def* prog_getdef    (qc_program *prog, qcint off);
1025 qcany*            prog_getedict  (qc_program *prog, qcint e);
1026 qcint             prog_tempstring(qc_program *prog, const char *_str);
1027
1028
1029 /*===================================================================*/
1030 /*===================== parser.c commandline ========================*/
1031 /*===================================================================*/
1032 struct parser_s;
1033
1034 struct parser_s *parser_create        ();
1035 bool             parser_compile_file  (struct parser_s *parser, const char *);
1036 bool             parser_compile_string(struct parser_s *parser, const char *, const char *, size_t);
1037 bool             parser_finish        (struct parser_s *parser, const char *);
1038 void             parser_cleanup       (struct parser_s *parser);
1039
1040 /*===================================================================*/
1041 /*====================== ftepp.c commandline ========================*/
1042 /*===================================================================*/
1043 struct lex_file_s;
1044 struct ftepp_s;
1045
1046 typedef struct {
1047     const char  *name;
1048     char      *(*func)(struct lex_file_s *);
1049 } ftepp_predef_t;
1050
1051 /*
1052  * line, file, counter, counter_last, random, random_last, date, time
1053  * increment when items are added
1054  */
1055 #define FTEPP_PREDEF_COUNT 8
1056
1057 struct ftepp_s *ftepp_create           ();
1058 bool            ftepp_preprocess_file  (struct ftepp_s *ftepp, const char *filename);
1059 bool            ftepp_preprocess_string(struct ftepp_s *ftepp, const char *name, const char *str);
1060 void            ftepp_finish           (struct ftepp_s *ftepp);
1061 const char     *ftepp_get              (struct ftepp_s *ftepp);
1062 void            ftepp_flush            (struct ftepp_s *ftepp);
1063 void            ftepp_add_define       (struct ftepp_s *ftepp, const char *source, const char *name);
1064 void            ftepp_add_macro        (struct ftepp_s *ftepp, const char *name,   const char *value);
1065
1066 extern const ftepp_predef_t ftepp_predefs[FTEPP_PREDEF_COUNT];
1067
1068 /*===================================================================*/
1069 /*======================= main.c commandline ========================*/
1070 /*===================================================================*/
1071
1072 #if 1
1073 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
1074  * to 32 or 64 -f options...
1075  */
1076 typedef struct {
1077     size_t  idx; /* index into an array of 32 bit words */
1078     uint8_t bit; /* bit index for the 8 bit group idx points to */
1079 } longbit;
1080 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
1081 #define LONGBIT_SET(B, I) ((B).idx = (I)/32, (B).bit = ((I)%32))
1082 #else
1083 typedef uint32_t longbit;
1084 #define LONGBIT(bit) (bit)
1085 #define LONGBIT_SET(B, I) ((B) = (I))
1086 #endif
1087
1088 /*===================================================================*/
1089 /*=========================== utf8lib.c =============================*/
1090 /*===================================================================*/
1091 typedef uint32_t uchar_t;
1092
1093 bool    u8_analyze (const char *_s, size_t *_start, size_t *_len, uchar_t *_ch, size_t _maxlen);
1094 size_t  u8_strlen  (const char*);
1095 size_t  u8_strnlen (const char*, size_t);
1096 uchar_t u8_getchar (const char*, const char**);
1097 uchar_t u8_getnchar(const char*, const char**, size_t);
1098 int     u8_fromchar(uchar_t w,   char *to,     size_t maxlen);
1099
1100 /*===================================================================*/
1101 /*============================= opts.c ==============================*/
1102 /*===================================================================*/
1103 typedef struct {
1104     const char *name;
1105     longbit     bit;
1106 } opts_flag_def;
1107
1108 bool opts_setflag  (const char *, bool);
1109 bool opts_setwarn  (const char *, bool);
1110 bool opts_setwerror(const char *, bool);
1111 bool opts_setoptim (const char *, bool);
1112
1113 void opts_init         (const char *, int, size_t);
1114 void opts_set          (uint32_t   *, size_t, bool);
1115 void opts_setoptimlevel(unsigned int);
1116 void opts_ini_init     (const char *);
1117
1118 /* Saner flag handling */
1119 void opts_backup_non_Wall();
1120 void opts_restore_non_Wall();
1121 void opts_backup_non_Werror_all();
1122 void opts_restore_non_Werror_all();
1123
1124 enum {
1125 # define GMQCC_TYPE_FLAGS
1126 # define GMQCC_DEFINE_FLAG(X) X,
1127 #  include "opts.def"
1128     COUNT_FLAGS
1129 };
1130 static const opts_flag_def opts_flag_list[] = {
1131 # define GMQCC_TYPE_FLAGS
1132 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
1133 #  include "opts.def"
1134     { NULL, LONGBIT(0) }
1135 };
1136
1137 enum {
1138 # define GMQCC_TYPE_WARNS
1139 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
1140 #  include "opts.def"
1141     COUNT_WARNINGS
1142 };
1143 static const opts_flag_def opts_warn_list[] = {
1144 # define GMQCC_TYPE_WARNS
1145 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
1146 #  include "opts.def"
1147     { NULL, LONGBIT(0) }
1148 };
1149
1150 enum {
1151 # define GMQCC_TYPE_OPTIMIZATIONS
1152 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) OPTIM_##NAME,
1153 #  include "opts.def"
1154     COUNT_OPTIMIZATIONS
1155 };
1156 static const opts_flag_def opts_opt_list[] = {
1157 # define GMQCC_TYPE_OPTIMIZATIONS
1158 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) { #NAME, LONGBIT(OPTIM_##NAME) },
1159 #  include "opts.def"
1160     { NULL, LONGBIT(0) }
1161 };
1162 static const unsigned int opts_opt_oflag[] = {
1163 # define GMQCC_TYPE_OPTIMIZATIONS
1164 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) MIN_O,
1165 #  include "opts.def"
1166     0
1167 };
1168
1169 enum {
1170 #   define GMQCC_TYPE_OPTIONS
1171 #   define GMQCC_DEFINE_FLAG(X) OPTION_##X,
1172 #   include "opts.def"
1173     OPTION_COUNT
1174 };
1175
1176 extern unsigned int opts_optimizationcount[COUNT_OPTIMIZATIONS];
1177
1178 /* other options: */
1179 typedef enum {
1180     COMPILER_QCC,     /* circa  QuakeC */
1181     COMPILER_FTEQCC,  /* fteqcc QuakeC */
1182     COMPILER_QCCX,    /* qccx   QuakeC */
1183     COMPILER_GMQCC    /* this   QuakeC */
1184 } opts_std_t;
1185
1186 typedef union {
1187     bool     B;
1188     uint16_t U16;
1189     uint32_t U32;
1190     char    *STR;
1191 } opt_value_t;
1192
1193
1194 typedef struct {
1195     opt_value_t  options      [OPTION_COUNT];
1196     uint32_t     flags        [1 + (COUNT_FLAGS         / 32)];
1197     uint32_t     warn         [1 + (COUNT_WARNINGS      / 32)];
1198     uint32_t     werror       [1 + (COUNT_WARNINGS      / 32)];
1199     uint32_t     warn_backup  [1 + (COUNT_WARNINGS      / 32)];
1200     uint32_t     werror_backup[1 + (COUNT_WARNINGS      / 32)];
1201     uint32_t     optimization [1 + (COUNT_OPTIMIZATIONS / 32)];
1202     bool         optimizeoff; /* True when -O0 */
1203 } opts_cmd_t;
1204
1205 extern opts_cmd_t opts;
1206
1207 #define OPTS_GENERIC(f,i)    (!! (((f)[(i)/32]) & (1<< ((i)%32))))
1208 #define OPTS_FLAG(i)         OPTS_GENERIC(opts.flags,        (i))
1209 #define OPTS_WARN(i)         OPTS_GENERIC(opts.warn,         (i))
1210 #define OPTS_WERROR(i)       OPTS_GENERIC(opts.werror,       (i))
1211 #define OPTS_OPTIMIZATION(i) OPTS_GENERIC(opts.optimization, (i))
1212 #define OPTS_OPTION_BOOL(X) (opts.options[X].B)
1213 #define OPTS_OPTION_U16(X)  (opts.options[X].U16)
1214 #define OPTS_OPTION_U32(X)  (opts.options[X].U32)
1215 #define OPTS_OPTION_STR(X)  (opts.options[X].STR)
1216
1217 #endif /*! GMQCC_HDR */