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