61429f34577bf630975e369e478a431c7d291a9c
[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 <stddef.h>
28 #include <time.h>   /* TODO: remove?*/
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 /* stat.c */
257 void  stat_info          (void);
258 char *stat_mem_strdup    (const char *, size_t,         const char *, bool);
259 void *stat_mem_reallocate(void *,       size_t, size_t, const char *);
260 void  stat_mem_deallocate(void *);
261 void *stat_mem_allocate  (size_t, size_t, const char *);
262
263 #define mem_a(SIZE)              stat_mem_allocate  ((SIZE), __LINE__, __FILE__)
264 #define mem_d(PTRN)              stat_mem_deallocate((void*)(PTRN))
265 #define mem_r(PTRN, SIZE)        stat_mem_reallocate((void*)(PTRN), (SIZE), __LINE__, __FILE__)
266 #define mem_af(SIZE, FILE, LINE) stat_mem_allocate  ((SIZE), (LINE), (FILE))
267
268 /* TODO: rename to mem variations */
269 #define util_strdup(SRC)         stat_mem_strdup((char*)(SRC), __LINE__, __FILE__, false)
270 #define util_strdupe(SRC)        stat_mem_strdup((char*)(SRC), __LINE__, __FILE__, true)
271
272 /* util.c */
273
274 /*
275  * Microsoft implements against the spec versions of ctype.h. Which
276  * means what ever the current set locale is will render the actual
277  * results of say isalpha('A') wrong for what ever retarded locale
278  * is used. Simalerly these are also implemented inefficently on
279  * some toolchains and end up becoming actual library calls. Perhaps
280  * this is why tools like yacc provide their own? Regardless implementing
281  * these as functions is equally as silly, the call overhead is not
282  * justified when this could happen on every character from an input
283  * stream. We provide our own as macros for absolute inlinability.
284  */
285 #define util_isalpha(a) ((((unsigned)(a)|32)-'a') < 26)
286 #define util_isdigit(a) (((unsigned)(a)-'0') < 10)
287 #define util_islower(a) (((unsigned)(a)-'a') < 26)
288 #define util_isupper(a) (((unsigned)(a)-'A') < 26)
289 #define util_isprint(a) (((unsigned)(a)-0x20) < 0x5F)
290 #define util_isspace(a) (((a) >= 9 && (a) <= 13) || (a) == ' ')
291
292 bool  util_strupper      (const char *);
293 bool  util_strdigit      (const char *);
294 void  util_endianswap    (void *, size_t, unsigned int);
295
296 size_t util_strtocmd         (const char *, char *, size_t);
297 size_t util_strtononcmd      (const char *, char *, size_t);
298 size_t util_optimizationtostr(const char *, char *, size_t);
299
300 uint16_t util_crc16(uint16_t crc, const char *data, size_t len);
301
302 void     util_seed(uint32_t);
303 uint32_t util_rand(void);
304
305 int      util_asprintf (char **ret, const char *fmt, ...);
306 int      util_sscanf   (const char *str, const char *format, ...);
307 char    *util_strncpy  (char *dest, const char *src, size_t n);
308 char    *util_strncat  (char *dest, const char *src, size_t n);
309 char    *util_strcat   (char *dest, const char *src);
310 const char *util_strerror(int err);
311
312 const struct tm *util_localtime(const time_t *timer);
313 const char      *util_ctime    (const time_t *timer);
314
315 typedef struct fs_file_s fs_file_t;
316 bool            util_isatty   (fs_file_t *);
317
318 /*
319  * A flexible vector implementation: all vector pointers contain some
320  * data about themselfs exactly - sizeof(vector_t) behind the pointer
321  * this data is represented in the structure below.  Doing this allows
322  * us to use the array [] to access individual elements from the vector
323  * opposed to using set/get methods.
324  */
325 typedef struct {
326     size_t  allocated;
327     size_t  used;
328
329     /* can be extended now! whoot */
330 } vector_t;
331
332 /* hidden interface */
333 void _util_vec_grow(void **a, size_t i, size_t s);
334 #define GMQCC_VEC_WILLGROW(X,Y) ( \
335     ((!(X) || vec_meta(X)->used + Y >= vec_meta(X)->allocated)) ? \
336         (void)_util_vec_grow(((void**)&(X)), (Y), sizeof(*(X))) : \
337         (void)0                                                   \
338 )
339
340 /* exposed interface */
341 #define vec_meta(A)       (((vector_t*)((void*)A)) - 1)
342 #define vec_free(A)       ((void)((A) ? (mem_d((void*)vec_meta(A)), (A) = NULL) : 0))
343 #define vec_push(A,V)     (GMQCC_VEC_WILLGROW((A),1), (A)[vec_meta(A)->used++] = (V))
344 #define vec_size(A)       ((A) ? vec_meta(A)->used : 0)
345 #define vec_add(A,N)      (GMQCC_VEC_WILLGROW((A),(N)), vec_meta(A)->used += (N), &(A)[vec_meta(A)->used-(N)])
346 #define vec_last(A)       ((A)[vec_meta(A)->used - 1])
347 #define vec_pop(A)        ((void)(vec_meta(A)->used -= 1))
348 #define vec_shrinkto(A,N) ((void)(vec_meta(A)->used  = (N)))
349 #define vec_shrinkby(A,N) ((void)(vec_meta(A)->used -= (N)))
350 #define vec_append(A,N,S) ((void)(memcpy(vec_add((A), (N)), (S), (N) * sizeof(*(S)))))
351 #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)))
352
353 typedef struct hash_table_s {
354     size_t                size;
355     struct hash_node_t **table;
356 } hash_table_t, *ht;
357
358 /*
359  * hashtable implementation:
360  *
361  * Note:
362  *      This was designed for pointers:  you manage the life of the object yourself
363  *      if you do use this for non-pointers please be warned that the object may not
364  *      be valid if the duration of it exceeds (i.e on stack).  So you need to allocate
365  *      yourself, or put those in global scope to ensure duration is for the whole
366  *      runtime.
367  *
368  * util_htnew(size)                             -- to make a new hashtable
369  * util_htset(table, key, value, sizeof(value)) -- to set something in the table
370  * util_htget(table, key)                       -- to get something from the table
371  * util_htdel(table)                            -- to delete the table
372  *
373  * example of use:
374  *
375  * ht    foo  = util_htnew(1024);
376  * int   data = 100;
377  * char *test = "hello world\n";
378  * util_htset(foo, "foo", (void*)&data);
379  * util_gtset(foo, "bar", (void*)test);
380  *
381  * printf("foo: %d, bar %s",
382  *     *((int *)util_htget(foo, "foo")),
383  *      ((char*)util_htget(foo, "bar"))
384  * );
385  *
386  * util_htdel(foo);
387  */
388 hash_table_t *util_htnew (size_t size);
389 void          util_htrem (hash_table_t *ht, void (*callback)(void *data));
390 void          util_htset (hash_table_t *ht, const char *key, void *value);
391 void          util_htdel (hash_table_t *ht);
392 size_t        util_hthash(hash_table_t *ht, const char *key);
393 void          util_htseth(hash_table_t *ht, const char *key, size_t hash, void *value);
394 void          util_htrmh (hash_table_t *ht, const char *key, size_t bin, void (*cb)(void*));
395 void          util_htrm  (hash_table_t *ht, const char *key, void (*cb)(void*));
396
397 void         *util_htget (hash_table_t *ht, const char *key);
398 void         *util_htgeth(hash_table_t *ht, const char *key, size_t hash);
399
400 int           util_snprintf(char *str, size_t, const char *fmt, ...);
401
402
403 /* fs.c */
404 #define FS_FILE_SEEK_SET  0
405 #define FS_FILE_SEEK_CUR  1
406 #define FS_FILE_SEEK_END  2
407 #define FS_FILE_EOF      -1
408
409 typedef struct fs_dir_s  fs_dir_t;
410 /*typedef struct fs_file_s fs_file_t;*/
411 typedef struct dirent    fs_dirent_t;
412
413 void           fs_file_close  (fs_file_t *);
414 int            fs_file_error  (fs_file_t *);
415 int            fs_file_getc   (fs_file_t *);
416 int            fs_file_printf (fs_file_t *, const char *, ...);
417 int            fs_file_puts   (fs_file_t *, const char *);
418 int            fs_file_seek   (fs_file_t *, long int, int);
419 long           fs_file_tell   (fs_file_t *);
420 int            fs_file_flush  (fs_file_t *);
421
422 size_t         fs_file_read   (void *,        size_t, size_t, fs_file_t *);
423 size_t         fs_file_write  (const void *,  size_t, size_t, fs_file_t *);
424
425 fs_file_t     *fs_file_open   (const char *, const char *);
426 int            fs_file_getline(char  **, size_t *, fs_file_t *);
427
428 int            fs_dir_make    (const char *);
429 fs_dir_t      *fs_dir_open    (const char *);
430 int            fs_dir_close   (fs_dir_t *);
431 fs_dirent_t   *fs_dir_read    (fs_dir_t *);
432
433
434 /* correct.c */
435 typedef struct correct_trie_s {
436     void                  *value;
437     struct correct_trie_s *entries;
438 } correct_trie_t;
439
440 correct_trie_t* correct_trie_new(void);
441
442 typedef struct {
443     char   ***edits;
444     size_t  **lens;
445 } correction_t;
446
447 void  correct_del (correct_trie_t*, size_t **);
448 void  correct_add (correct_trie_t*, size_t ***, const char *);
449 char *correct_str (correction_t *, correct_trie_t*, const char *);
450 void  correct_init(correction_t *);
451 void  correct_free(correction_t *);
452
453
454 /* code.c */
455
456 /* Note: if you change the order, fix type_sizeof in ir.c */
457 enum {
458     TYPE_VOID     ,
459     TYPE_STRING   ,
460     TYPE_FLOAT    ,
461     TYPE_VECTOR   ,
462     TYPE_ENTITY   ,
463     TYPE_FIELD    ,
464     TYPE_FUNCTION ,
465     TYPE_POINTER  ,
466     TYPE_INTEGER  ,
467     TYPE_VARIANT  ,
468     TYPE_STRUCT   ,
469     TYPE_UNION    ,
470     TYPE_ARRAY    ,
471
472     TYPE_NIL      , /* it's its own type / untyped */
473     TYPE_NOEXPR   , /* simply invalid in expressions */
474
475     TYPE_COUNT
476 };
477
478 /* const/var qualifiers */
479 #define CV_NONE   0
480 #define CV_CONST  1
481 #define CV_VAR   -1
482 #define CV_WRONG  0x8000 /* magic number to help parsing */
483
484 extern const char    *type_name        [TYPE_COUNT];
485 extern const uint16_t type_store_instr [TYPE_COUNT];
486 extern const uint16_t field_store_instr[TYPE_COUNT];
487
488 /*
489  * could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
490  * but this breaks when TYPE_INTEGER is added, since with the enhanced
491  * instruction set, the old ones are left untouched, thus the _I instructions
492  * are at a seperate place.
493  */
494 extern const uint16_t type_storep_instr[TYPE_COUNT];
495 extern const uint16_t type_eq_instr    [TYPE_COUNT];
496 extern const uint16_t type_ne_instr    [TYPE_COUNT];
497 extern const uint16_t type_not_instr   [TYPE_COUNT];
498
499 typedef struct {
500     uint32_t offset;      /* Offset in file of where data begins  */
501     uint32_t length;      /* Length of section (how many of)      */
502 } prog_section_t;
503
504 typedef struct {
505     uint32_t       version;      /* Program version (6)     */
506     uint16_t       crc16;
507     uint16_t       skip;
508
509     prog_section_t statements;   /* prog_section_statement  */
510     prog_section_t defs;         /* prog_section_def        */
511     prog_section_t fields;       /* prog_section_field      */
512     prog_section_t functions;    /* prog_section_function   */
513     prog_section_t strings;
514     prog_section_t globals;
515     uint32_t       entfield;     /* Number of entity fields */
516 } prog_header_t;
517
518 /*
519  * Each paramater incerements by 3 since vector types hold
520  * 3 components (x,y,z).
521  */
522 #define OFS_NULL      0
523 #define OFS_RETURN    1
524 #define OFS_PARM0     (OFS_RETURN+3)
525 #define OFS_PARM1     (OFS_PARM0 +3)
526 #define OFS_PARM2     (OFS_PARM1 +3)
527 #define OFS_PARM3     (OFS_PARM2 +3)
528 #define OFS_PARM4     (OFS_PARM3 +3)
529 #define OFS_PARM5     (OFS_PARM4 +3)
530 #define OFS_PARM6     (OFS_PARM5 +3)
531 #define OFS_PARM7     (OFS_PARM6 +3)
532
533 typedef struct {
534     uint16_t opcode;
535
536     /* operand 1 */
537     union {
538         int16_t  s1; /* signed   */
539         uint16_t u1; /* unsigned */
540     } o1;
541     /* operand 2 */
542     union {
543         int16_t  s1; /* signed   */
544         uint16_t u1; /* unsigned */
545     } o2;
546     /* operand 3 */
547     union {
548         int16_t  s1; /* signed   */
549         uint16_t u1; /* unsigned */
550     } o3;
551
552     /*
553      * This is the same as the structure in darkplaces
554      * {
555      *     unsigned short op;
556      *     short          a,b,c;
557      * }
558      * But this one is more sane to work with, and the
559      * type sizes are guranteed.
560      */
561 } prog_section_statement_t;
562
563 typedef struct {
564     /*
565      * The types:
566      * 0 = ev_void
567      * 1 = ev_string
568      * 2 = ev_float
569      * 3 = ev_vector
570      * 4 = ev_entity
571      * 5 = ev_field
572      * 6 = ev_function
573      * 7 = ev_pointer -- engine only
574      * 8 = ev_bad     -- engine only
575      */
576     uint16_t type;
577     uint16_t offset;
578     uint32_t name;
579 } prog_section_both_t;
580
581 typedef prog_section_both_t prog_section_def_t;
582 typedef prog_section_both_t prog_section_field_t;
583
584 /* this is ORed to the type */
585 #define DEF_SAVEGLOBAL (1<<15)
586 #define DEF_TYPEMASK   ((1<<15)-1)
587
588 typedef struct {
589     int32_t   entry;      /* in statement table for instructions  */
590     uint32_t  firstlocal; /* First local in local table           */
591     uint32_t  locals;     /* Total ints of params + locals        */
592     uint32_t  profile;    /* Always zero (engine uses this)       */
593     uint32_t  name;       /* name of function in string table     */
594     uint32_t  file;       /* file of the source file              */
595     int32_t   nargs;      /* number of arguments                  */
596     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
597 } prog_section_function_t;
598
599 /*
600  * Instructions
601  * These are the external instructions supported by the interperter
602  * this is what things compile to (from the C code).
603  */
604 enum {
605     INSTR_DONE,
606     INSTR_MUL_F,
607     INSTR_MUL_V,
608     INSTR_MUL_FV, /* NOTE: the float operands must NOT be at the same locations: A != C */
609     INSTR_MUL_VF, /* and here: B != C */
610     INSTR_DIV_F,
611     INSTR_ADD_F,
612     INSTR_ADD_V,
613     INSTR_SUB_F,
614     INSTR_SUB_V,
615     INSTR_EQ_F,
616     INSTR_EQ_V,
617     INSTR_EQ_S,
618     INSTR_EQ_E,
619     INSTR_EQ_FNC,
620     INSTR_NE_F,
621     INSTR_NE_V,
622     INSTR_NE_S,
623     INSTR_NE_E,
624     INSTR_NE_FNC,
625     INSTR_LE,
626     INSTR_GE,
627     INSTR_LT,
628     INSTR_GT,
629     INSTR_LOAD_F,
630     INSTR_LOAD_V,
631     INSTR_LOAD_S,
632     INSTR_LOAD_ENT,
633     INSTR_LOAD_FLD,
634     INSTR_LOAD_FNC,
635     INSTR_ADDRESS,
636     INSTR_STORE_F,
637     INSTR_STORE_V,
638     INSTR_STORE_S,
639     INSTR_STORE_ENT,
640     INSTR_STORE_FLD,
641     INSTR_STORE_FNC,
642     INSTR_STOREP_F,
643     INSTR_STOREP_V,
644     INSTR_STOREP_S,
645     INSTR_STOREP_ENT,
646     INSTR_STOREP_FLD,
647     INSTR_STOREP_FNC,
648     INSTR_RETURN,
649     INSTR_NOT_F,
650     INSTR_NOT_V,
651     INSTR_NOT_S,
652     INSTR_NOT_ENT,
653     INSTR_NOT_FNC,
654     INSTR_IF,
655     INSTR_IFNOT,
656     INSTR_CALL0,
657     INSTR_CALL1,
658     INSTR_CALL2,
659     INSTR_CALL3,
660     INSTR_CALL4,
661     INSTR_CALL5,
662     INSTR_CALL6,
663     INSTR_CALL7,
664     INSTR_CALL8,
665     INSTR_STATE,
666     INSTR_GOTO,
667     INSTR_AND,
668     INSTR_OR,
669     INSTR_BITAND,
670     INSTR_BITOR,
671
672     /*
673      * Virtual instructions used by the IR
674      * Keep at the end!
675      */
676     VINSTR_END,
677     VINSTR_PHI,
678     VINSTR_JUMP,
679     VINSTR_COND,
680
681     /* A never returning CALL.
682      * Creating this causes IR blocks to be marked as 'final'.
683      * No-Return-Call
684      */
685     VINSTR_NRCALL,
686
687     /* Emulated instructions. */
688     VINSTR_BITAND_V, /* BITAND_V must be the first emulated bitop */
689     VINSTR_BITAND_VF,
690     VINSTR_BITOR_V,
691     VINSTR_BITOR_VF,
692     VINSTR_BITXOR,
693     VINSTR_BITXOR_V,
694     VINSTR_BITXOR_VF,
695     VINSTR_CROSS,
696     VINSTR_NEG_F,
697     VINSTR_NEG_V
698 };
699
700 /* TODO: elide */
701 extern const char *util_instr_str[VINSTR_END];
702
703
704 typedef float    qcfloat_t;
705 typedef int32_t  qcint_t;
706 typedef uint32_t qcuint_t;
707
708 typedef struct {
709     prog_section_statement_t *statements;
710     int                      *linenums;
711     int                      *columnnums;
712     prog_section_def_t       *defs;
713     prog_section_field_t     *fields;
714     prog_section_function_t  *functions;
715     int                      *globals;
716     char                     *chars;
717     uint16_t                  crc;
718     uint32_t                  entfields;
719     ht                        string_cache;
720     qcint_t                   string_cached_empty;
721 } code_t;
722
723 /*
724  * A shallow copy of a lex_file to remember where which ast node
725  * came from.
726  */
727 typedef struct {
728     const char *file;
729     size_t      line;
730     size_t      column;
731 } lex_ctx_t;
732
733 /*
734  * code_write          -- writes out the compiled file
735  * code_init           -- prepares the code file
736  * code_genstrin       -- generates string for code
737  * code_alloc_field    -- allocated a field
738  * code_push_statement -- keeps statements and linenumbers together
739  * code_pop_statement  -- keeps statements and linenumbers together
740  */
741 bool      code_write         (code_t *, const char *filename, const char *lno);
742 GMQCC_WARN
743 code_t   *code_init          (void);
744 void      code_cleanup       (code_t *);
745 uint32_t  code_genstring     (code_t *, const char *string);
746 qcint_t   code_alloc_field   (code_t *, size_t qcsize);
747 void      code_push_statement(code_t *, prog_section_statement_t *stmt, lex_ctx_t ctx);
748 void      code_pop_statement (code_t *);
749
750
751 /* conout.c */
752 enum {
753     CON_BLACK   = 30,
754     CON_RED,
755     CON_GREEN,
756     CON_BROWN,
757     CON_BLUE,
758     CON_MAGENTA,
759     CON_CYAN ,
760     CON_WHITE
761 };
762
763 /* message level */
764 enum {
765     LVL_MSG,
766     LVL_WARNING,
767     LVL_ERROR
768 };
769
770 fs_file_t *con_default_out(void);
771 fs_file_t *con_default_err(void);
772
773 void con_vprintmsg (int level, const char *name, size_t line, size_t column, const char *msgtype, const char *msg, va_list ap);
774 void con_printmsg  (int level, const char *name, size_t line, size_t column, const char *msgtype, const char *msg, ...);
775 void con_cvprintmsg(lex_ctx_t ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
776 void con_cprintmsg (lex_ctx_t ctx, int lvl, const char *msgtype, const char *msg, ...);
777
778 void con_close (void);
779 void con_init  (void);
780 void con_reset (void);
781 void con_color (int);
782 int  con_change(const char *, const char *);
783 int  con_verr  (const char *, va_list);
784 int  con_vout  (const char *, va_list);
785 int  con_err   (const char *, ...);
786 int  con_out   (const char *, ...);
787
788 /* error/warning interface */
789 extern size_t compile_errors;
790 extern size_t compile_Werrors;
791 extern size_t compile_warnings;
792
793 void /********/ compile_error   (lex_ctx_t ctx, /*LVL_ERROR*/ const char *msg, ...);
794 void /********/ vcompile_error  (lex_ctx_t ctx, /*LVL_ERROR*/ const char *msg, va_list ap);
795 bool GMQCC_WARN compile_warning (lex_ctx_t ctx, int warntype, const char *fmt, ...);
796 bool GMQCC_WARN vcompile_warning(lex_ctx_t ctx, int warntype, const char *fmt, va_list ap);
797 void            compile_show_werrors(void);
798
799 /* ir.c */
800 /* TODO: cleanup */
801 enum store_types {
802     store_global,
803     store_local,  /* local, assignable for now, should get promoted later */
804     store_param,  /* parameters, they are locals with a fixed position */
805     store_value,  /* unassignable */
806     store_return  /* unassignable, at OFS_RETURN */
807 };
808
809 typedef struct {
810     qcfloat_t x, y, z;
811 } vec3_t;
812
813 /* exec.c */
814
815 /* TODO: cleanup */
816 /*
817  * Darkplaces has (or will have) a 64 bit prog loader
818  * where the 32 bit qc program is autoconverted on load.
819  * Since we may want to support that as well, let's redefine
820  * float and int here.
821  */
822 typedef union {
823     qcint_t   _int;
824     qcint_t    string;
825     qcint_t    function;
826     qcint_t    edict;
827     qcfloat_t _float;
828     qcfloat_t vector[3];
829     qcint_t   ivector[3];
830 } qcany_t;
831
832 typedef char qcfloat_t_size_is_correct [sizeof(qcfloat_t) == 4 ?1:-1];
833 typedef char qcint_t_size_is_correct   [sizeof(qcint_t)   == 4 ?1:-1];
834
835 enum {
836     VMERR_OK,
837     VMERR_TEMPSTRING_ALLOC,
838     VMERR_END
839 };
840
841 #define VM_JUMPS_DEFAULT 1000000
842
843 /* execute-flags */
844 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
845 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
846 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
847
848 struct qc_program_s;
849 typedef int (*prog_builtin_t)(struct qc_program_s *prog);
850
851 typedef struct {
852     qcint_t                    stmt;
853     size_t                   localsp;
854     prog_section_function_t *function;
855 } qc_exec_stack_t;
856
857 typedef struct qc_program_s {
858     char                    *filename;
859     prog_section_statement_t *code;
860     prog_section_def_t       *defs;
861     prog_section_def_t       *fields;
862     prog_section_function_t  *functions;
863     char                    *strings;
864     qcint_t                   *globals;
865     qcint_t                   *entitydata;
866     bool                    *entitypool;
867
868     const char*             *function_stack;
869
870     uint16_t crc16;
871
872     size_t tempstring_start;
873     size_t tempstring_at;
874
875     qcint_t  vmerror;
876
877     size_t *profile;
878
879     prog_builtin_t *builtins;
880     size_t          builtins_count;
881
882     /* size_t ip; */
883     qcint_t  entities;
884     size_t entityfields;
885     bool   allowworldwrites;
886
887     qcint_t         *localstack;
888     qc_exec_stack_t *stack;
889     size_t statement;
890
891     size_t xflags;
892
893     int    argc; /* current arg count for debugging */
894 } qc_program_t;
895
896 qc_program_t*       prog_load      (const char *filename, bool ignoreversion);
897 void                prog_delete    (qc_program_t *prog);
898 bool                prog_exec      (qc_program_t *prog, prog_section_function_t *func, size_t flags, long maxjumps);
899 const char*         prog_getstring (qc_program_t *prog, qcint_t str);
900 prog_section_def_t* prog_entfield  (qc_program_t *prog, qcint_t off);
901 prog_section_def_t* prog_getdef    (qc_program_t *prog, qcint_t off);
902 qcany_t*            prog_getedict  (qc_program_t *prog, qcint_t e);
903 qcint_t               prog_tempstring(qc_program_t *prog, const char *_str);
904
905
906 /* parser.c */
907 struct parser_s;
908 struct parser_s *parser_create        (void);
909 bool             parser_compile_file  (struct parser_s *parser, const char *);
910 bool             parser_compile_string(struct parser_s *parser, const char *, const char *, size_t);
911 bool             parser_finish        (struct parser_s *parser, const char *);
912 void             parser_cleanup       (struct parser_s *parser);
913
914 /* ftepp.c */
915 struct ftepp_s;
916 struct ftepp_s *ftepp_create           (void);
917 bool            ftepp_preprocess_file  (struct ftepp_s *ftepp, const char *filename);
918 bool            ftepp_preprocess_string(struct ftepp_s *ftepp, const char *name, const char *str);
919 void            ftepp_finish           (struct ftepp_s *ftepp);
920 const char     *ftepp_get              (struct ftepp_s *ftepp);
921 void            ftepp_flush            (struct ftepp_s *ftepp);
922 void            ftepp_add_define       (struct ftepp_s *ftepp, const char *source, const char *name);
923 void            ftepp_add_macro        (struct ftepp_s *ftepp, const char *name,   const char *value);
924
925 /* main.c */
926
927 #if 1
928 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
929  * to 32 or 64 -f options...
930  */
931 typedef struct {
932     size_t  idx; /* index into an array of 32 bit words */
933     uint8_t bit; /* bit index for the 8 bit group idx points to */
934 } longbit;
935 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
936 #define LONGBIT_SET(B, I) ((B).idx = (I)/32, (B).bit = ((I)%32))
937 #else
938 typedef uint32_t longbit;
939 #define LONGBIT(bit) (bit)
940 #define LONGBIT_SET(B, I) ((B) = (I))
941 #endif
942
943 /* utf.8 */
944 typedef long utf8ch_t;
945 int utf8_from(char *, utf8ch_t);
946 int utf8_to(utf8ch_t *, const unsigned char *, size_t);
947
948 /* opts.c */
949 typedef struct {
950     const char *name;
951     longbit     bit;
952 } opts_flag_def_t;
953
954 bool opts_setflag  (const char *, bool);
955 bool opts_setwarn  (const char *, bool);
956 bool opts_setwerror(const char *, bool);
957 bool opts_setoptim (const char *, bool);
958
959 void opts_init         (const char *, int, size_t);
960 void opts_set          (uint32_t   *, size_t, bool);
961 void opts_setoptimlevel(unsigned int);
962 void opts_ini_init     (const char *);
963
964 /* Saner flag handling */
965 void opts_backup_non_Wall(void);
966 void opts_restore_non_Wall(void);
967 void opts_backup_non_Werror_all(void);
968 void opts_restore_non_Werror_all(void);
969
970
971 enum {
972 # define GMQCC_TYPE_FLAGS
973 # define GMQCC_DEFINE_FLAG(X) X,
974 #  include "opts.def"
975     COUNT_FLAGS
976 };
977
978 enum {
979 # define GMQCC_TYPE_WARNS
980 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
981 #  include "opts.def"
982     COUNT_WARNINGS
983 };
984
985 enum {
986 # define GMQCC_TYPE_OPTIMIZATIONS
987 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) OPTIM_##NAME,
988 #  include "opts.def"
989     COUNT_OPTIMIZATIONS
990 };
991
992 enum {
993 #   define GMQCC_TYPE_OPTIONS
994 #   define GMQCC_DEFINE_FLAG(X) OPTION_##X,
995 #   include "opts.def"
996     OPTION_COUNT
997 };
998
999 extern const opts_flag_def_t opts_flag_list[COUNT_FLAGS+1];
1000 extern const opts_flag_def_t opts_warn_list[COUNT_WARNINGS+1];
1001 extern const opts_flag_def_t opts_opt_list[COUNT_OPTIMIZATIONS+1];
1002 extern const unsigned int    opts_opt_oflag[COUNT_OPTIMIZATIONS+1];
1003 extern unsigned int          opts_optimizationcount[COUNT_OPTIMIZATIONS];
1004
1005 /* other options: */
1006 typedef enum {
1007     COMPILER_QCC,     /* circa  QuakeC */
1008     COMPILER_FTEQCC,  /* fteqcc QuakeC */
1009     COMPILER_QCCX,    /* qccx   QuakeC */
1010     COMPILER_GMQCC    /* this   QuakeC */
1011 } opts_std_t;
1012
1013 typedef union {
1014     bool     B;
1015     uint16_t U16;
1016     uint32_t U32;
1017     char    *STR;
1018 } opt_value_t;
1019
1020
1021 typedef struct {
1022     opt_value_t  options      [OPTION_COUNT];
1023     uint32_t     flags        [1 + (COUNT_FLAGS         / 32)];
1024     uint32_t     warn         [1 + (COUNT_WARNINGS      / 32)];
1025     uint32_t     werror       [1 + (COUNT_WARNINGS      / 32)];
1026     uint32_t     warn_backup  [1 + (COUNT_WARNINGS      / 32)];
1027     uint32_t     werror_backup[1 + (COUNT_WARNINGS      / 32)];
1028     uint32_t     optimization [1 + (COUNT_OPTIMIZATIONS / 32)];
1029     bool         optimizeoff; /* True when -O0 */
1030 } opts_cmd_t;
1031
1032 extern opts_cmd_t opts;
1033
1034 #define OPTS_GENERIC(f,i)    (!! (((f)[(i)/32]) & (1<< (unsigned)((i)%32))))
1035 #define OPTS_FLAG(i)         OPTS_GENERIC(opts.flags,        (i))
1036 #define OPTS_WARN(i)         OPTS_GENERIC(opts.warn,         (i))
1037 #define OPTS_WERROR(i)       OPTS_GENERIC(opts.werror,       (i))
1038 #define OPTS_OPTIMIZATION(i) OPTS_GENERIC(opts.optimization, (i))
1039 #define OPTS_OPTION_BOOL(X) (opts.options[X].B)
1040 #define OPTS_OPTION_U16(X)  (opts.options[X].U16)
1041 #define OPTS_OPTION_U32(X)  (opts.options[X].U32)
1042 #define OPTS_OPTION_STR(X)  (opts.options[X].STR)
1043
1044 #endif /*! GMQCC_HDR */