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