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