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