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