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