Make compiler and virtual-machine compile as C++ code, also removed gmqcc_voidptr...
[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 #ifdef NOTRACK
264 #    define mem_a(x)    malloc (x)
265 #    define mem_d(x)    free   ((void*)x)
266 #    define mem_r(x, n) realloc((void*)x, n)
267 #else
268 #    define mem_a(x)    util_memory_a((x), __LINE__, __FILE__)
269 #    define mem_d(x)    util_memory_d((void*)(x),      __LINE__, __FILE__)
270 #    define mem_r(x, n) util_memory_r((void*)(x), (n), __LINE__, __FILE__)
271 #endif
272
273 /*
274  * A flexible vector implementation: all vector pointers contain some
275  * data about themselfs exactly - sizeof(vector_t) behind the pointer
276  * this data is represented in the structure below.  Doing this allows
277  * us to use the array [] to access individual elements from the vector
278  * opposed to using set/get methods.
279  */     
280 typedef struct {
281     size_t  allocated;
282     size_t  used;
283
284     /* can be extended now! whoot */
285 } vector_t;
286
287 /* hidden interface */
288 void _util_vec_grow(void **a, size_t i, size_t s);
289 #define GMQCC_VEC_WILLGROW(X,Y) ( \
290     ((!(X) || vec_meta(X)->used + Y >= vec_meta(X)->allocated)) ? \
291         (void)_util_vec_grow(((void**)&(X)), (Y), sizeof(*(X))) : \
292         (void)0                                                   \
293 )
294
295 /* exposed interface */
296 #define vec_meta(A)       (((vector_t*)(A)) - 1)
297 #define vec_free(A)       ((A) ? (mem_d((void*)vec_meta(A)), (A) = NULL) : 0)
298 #define vec_push(A,V)     (GMQCC_VEC_WILLGROW(A,1), (A)[vec_meta(A)->used++] = V)
299 #define vec_size(A)       ((A) ? vec_meta(A)->used : 0)
300 #define vec_add(A,N)      (GMQCC_VEC_WILLGROW(A,N), vec_meta(A)->used += (N), &(A)[vec_meta(A)->used-(N)])
301 #define vec_last(A)       ((A)[vec_meta(A)->used - 1])
302 #define vec_pop(A)        (vec_meta(A)->used -= 1)
303 #define vec_shrinkto(A,N) (vec_meta(A)->used  = (N))
304 #define vec_shrinkby(A,N) (vec_meta(A)->used -= (N))
305 #define vec_append(A,N,S) memcpy(vec_add(A, N), S, N * sizeof(*S))
306 #define vec_upload(X,Y,S) memcpy(vec_add(X, S * sizeof(*Y)), Y, S * sizeof(*Y))
307 #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)
308
309 typedef struct hash_table_t {
310     size_t                size;
311     struct hash_node_t **table;
312 } hash_table_t, *ht;
313
314 /*
315  * hashtable implementation:
316  *
317  * Note:
318  *      This was designed for pointers:  you manage the life of the object yourself
319  *      if you do use this for non-pointers please be warned that the object may not
320  *      be valid if the duration of it exceeds (i.e on stack).  So you need to allocate
321  *      yourself, or put those in global scope to ensure duration is for the whole
322  *      runtime.
323  *
324  * util_htnew(size)                             -- to make a new hashtable
325  * util_htset(table, key, value, sizeof(value)) -- to set something in the table
326  * util_htget(table, key)                       -- to get something from the table
327  * util_htdel(table)                            -- to delete the table
328  *
329  * example of use:
330  *
331  * ht    foo  = util_htnew(1024);
332  * int   data = 100;
333  * char *test = "hello world\n";
334  * util_htset(foo, "foo", (void*)&data);
335  * util_gtset(foo, "bar", (void*)test);
336  *
337  * printf("foo: %d, bar %s",
338  *     *((int *)util_htget(foo, "foo")),
339  *      ((char*)util_htget(foo, "bar"))
340  * );
341  *
342  * util_htdel(foo);
343  */
344 hash_table_t *util_htnew (size_t size);
345 void          util_htset (hash_table_t *ht, const char *key, void *value);
346 void          util_htdel (hash_table_t *ht);
347 size_t        util_hthash(hash_table_t *ht, const char *key);
348 void          util_htseth(hash_table_t *ht, const char *key, size_t hash, void *value);
349
350 void         *util_htget (hash_table_t *ht, const char *key);
351 void         *util_htgeth(hash_table_t *ht, const char *key, size_t hash);
352 /*===================================================================*/
353 /*============================ file.c ===============================*/
354 /*===================================================================*/
355 GMQCC_INLINE void    file_close  (FILE *);
356 GMQCC_INLINE int     file_error  (FILE *);
357 GMQCC_INLINE int     file_getc   (FILE *);
358 GMQCC_INLINE int     file_printf (FILE *, const char *, ...);
359 GMQCC_INLINE int     file_puts   (FILE *, const char *);
360 GMQCC_INLINE int     file_seek   (FILE *, long int, int);
361
362 GMQCC_INLINE size_t  file_read   (void *,        size_t, size_t, FILE *);
363 GMQCC_INLINE size_t  file_write  (const void *,  size_t, size_t, FILE *);
364
365 GMQCC_INLINE FILE   *file_open   (const char *, const char *);
366 /*NOINLINE*/ int     file_getline(char  **, size_t *, FILE *);
367
368
369 /*===================================================================*/
370 /*=========================== code.c ================================*/
371 /*===================================================================*/
372
373 /* TODO: cleanup */
374 /* Note: if you change the order, fix type_sizeof in ir.c */
375 enum {
376     TYPE_VOID     ,
377     TYPE_STRING   ,
378     TYPE_FLOAT    ,
379     TYPE_VECTOR   ,
380     TYPE_ENTITY   ,
381     TYPE_FIELD    ,
382     TYPE_FUNCTION ,
383     TYPE_POINTER  ,
384     TYPE_INTEGER  ,
385     TYPE_VARIANT  ,
386     TYPE_STRUCT   ,
387     TYPE_UNION    ,
388     TYPE_ARRAY    ,
389
390     TYPE_COUNT
391 };
392
393 /* const/var qualifiers */
394 #define CV_NONE   0
395 #define CV_CONST  1
396 #define CV_VAR   -1
397 #define CV_WRONG  0x8000 /* magic number to help parsing */
398
399 extern const char *type_name        [TYPE_COUNT];
400 extern uint16_t    type_store_instr [TYPE_COUNT];
401 extern uint16_t    field_store_instr[TYPE_COUNT];
402
403 /*
404  * could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
405  * but this breaks when TYPE_INTEGER is added, since with the enhanced
406  * instruction set, the old ones are left untouched, thus the _I instructions
407  * are at a seperate place.
408  */
409 extern uint16_t type_storep_instr[TYPE_COUNT];
410 extern uint16_t type_eq_instr    [TYPE_COUNT];
411 extern uint16_t type_ne_instr    [TYPE_COUNT];
412 extern uint16_t type_not_instr   [TYPE_COUNT];
413
414 typedef struct {
415     uint32_t offset;      /* Offset in file of where data begins  */
416     uint32_t length;      /* Length of section (how many of)      */
417 } prog_section;
418
419 typedef struct {
420     uint32_t     version;      /* Program version (6)     */
421     uint16_t     crc16;
422     uint16_t     skip;
423
424     prog_section statements;   /* prog_section_statement  */
425     prog_section defs;         /* prog_section_def        */
426     prog_section fields;       /* prog_section_field      */
427     prog_section functions;    /* prog_section_function   */
428     prog_section strings;
429     prog_section globals;
430     uint32_t     entfield;     /* Number of entity fields */
431 } prog_header;
432
433 /*
434  * Each paramater incerements by 3 since vector types hold
435  * 3 components (x,y,z).
436  */
437 #define OFS_NULL      0
438 #define OFS_RETURN    1
439 #define OFS_PARM0     (OFS_RETURN+3)
440 #define OFS_PARM1     (OFS_PARM0 +3)
441 #define OFS_PARM2     (OFS_PARM1 +3)
442 #define OFS_PARM3     (OFS_PARM2 +3)
443 #define OFS_PARM4     (OFS_PARM3 +3)
444 #define OFS_PARM5     (OFS_PARM4 +3)
445 #define OFS_PARM6     (OFS_PARM5 +3)
446 #define OFS_PARM7     (OFS_PARM6 +3)
447
448 typedef struct {
449     uint16_t opcode;
450
451     /* operand 1 */
452     union {
453         int16_t  s1; /* signed   */
454         uint16_t u1; /* unsigned */
455     } o1;
456     /* operand 2 */
457     union {
458         int16_t  s1; /* signed   */
459         uint16_t u1; /* unsigned */
460     } o2;
461     /* operand 3 */
462     union {
463         int16_t  s1; /* signed   */
464         uint16_t u1; /* unsigned */
465     } o3;
466
467     /*
468      * This is the same as the structure in darkplaces
469      * {
470      *     unsigned short op;
471      *     short          a,b,c;
472      * }
473      * But this one is more sane to work with, and the
474      * type sizes are guranteed.
475      */
476 } prog_section_statement;
477
478 typedef struct {
479     /*
480      * The types:
481      * 0 = ev_void
482      * 1 = ev_string
483      * 2 = ev_float
484      * 3 = ev_vector
485      * 4 = ev_entity
486      * 5 = ev_field
487      * 6 = ev_function
488      * 7 = ev_pointer -- engine only
489      * 8 = ev_bad     -- engine only
490      */
491     uint16_t type;
492     uint16_t offset;
493     uint32_t name;
494 } prog_section_both;
495
496 typedef prog_section_both prog_section_def;
497 typedef prog_section_both prog_section_field;
498
499 /* this is ORed to the type */
500 #define DEF_SAVEGLOBAL (1<<15)
501 #define DEF_TYPEMASK   ((1<<15)-1)
502
503 typedef struct {
504     int32_t   entry;      /* in statement table for instructions  */
505     uint32_t  firstlocal; /* First local in local table           */
506     uint32_t  locals;     /* Total ints of params + locals        */
507     uint32_t  profile;    /* Always zero (engine uses this)       */
508     uint32_t  name;       /* name of function in string table     */
509     uint32_t  file;       /* file of the source file              */
510     int32_t   nargs;      /* number of arguments                  */
511     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
512 } prog_section_function;
513
514 /*
515  * Instructions
516  * These are the external instructions supported by the interperter
517  * this is what things compile to (from the C code).
518  */
519 enum {
520     INSTR_DONE,
521     INSTR_MUL_F,
522     INSTR_MUL_V,
523     INSTR_MUL_FV, /* NOTE: the float operands must NOT be at the same locations: A != C */
524     INSTR_MUL_VF, /* and here: B != C */
525     INSTR_DIV_F,
526     INSTR_ADD_F,
527     INSTR_ADD_V,
528     INSTR_SUB_F,
529     INSTR_SUB_V,
530     INSTR_EQ_F,
531     INSTR_EQ_V,
532     INSTR_EQ_S,
533     INSTR_EQ_E,
534     INSTR_EQ_FNC,
535     INSTR_NE_F,
536     INSTR_NE_V,
537     INSTR_NE_S,
538     INSTR_NE_E,
539     INSTR_NE_FNC,
540     INSTR_LE,
541     INSTR_GE,
542     INSTR_LT,
543     INSTR_GT,
544     INSTR_LOAD_F,
545     INSTR_LOAD_V,
546     INSTR_LOAD_S,
547     INSTR_LOAD_ENT,
548     INSTR_LOAD_FLD,
549     INSTR_LOAD_FNC,
550     INSTR_ADDRESS,
551     INSTR_STORE_F,
552     INSTR_STORE_V,
553     INSTR_STORE_S,
554     INSTR_STORE_ENT,
555     INSTR_STORE_FLD,
556     INSTR_STORE_FNC,
557     INSTR_STOREP_F,
558     INSTR_STOREP_V,
559     INSTR_STOREP_S,
560     INSTR_STOREP_ENT,
561     INSTR_STOREP_FLD,
562     INSTR_STOREP_FNC,
563     INSTR_RETURN,
564     INSTR_NOT_F,
565     INSTR_NOT_V,
566     INSTR_NOT_S,
567     INSTR_NOT_ENT,
568     INSTR_NOT_FNC,
569     INSTR_IF,
570     INSTR_IFNOT,
571     INSTR_CALL0,
572     INSTR_CALL1,
573     INSTR_CALL2,
574     INSTR_CALL3,
575     INSTR_CALL4,
576     INSTR_CALL5,
577     INSTR_CALL6,
578     INSTR_CALL7,
579     INSTR_CALL8,
580     INSTR_STATE,
581     INSTR_GOTO,
582     INSTR_AND,
583     INSTR_OR,
584     INSTR_BITAND,
585     INSTR_BITOR,
586
587     /*
588      * Virtual instructions used by the assembler
589      * keep at the end but before virtual instructions
590      * for the IR below.
591      */
592     AINSTR_END,
593
594     /*
595      * Virtual instructions used by the IR
596      * Keep at the end!
597      */
598     VINSTR_PHI,
599     VINSTR_JUMP,
600     VINSTR_COND,
601     /* A never returning CALL.
602      * Creating this causes IR blocks to be marked as 'final'.
603      * No-Return-Call
604      */
605     VINSTR_NRCALL
606 };
607
608 /* TODO: cleanup this mess */
609 extern prog_section_statement *code_statements;
610 extern int                    *code_linenums;
611 extern prog_section_def       *code_defs;
612 extern prog_section_field     *code_fields;
613 extern prog_section_function  *code_functions;
614 extern int                    *code_globals;
615 extern char                   *code_chars;
616 extern uint16_t code_crc;
617
618 /* uhh? */
619 typedef float   qcfloat;
620 typedef int32_t qcint;
621
622 /*
623  * code_write -- writes out the compiled file
624  * code_init  -- prepares the code file
625  */
626 bool     code_write       (const char *filename, const char *lno);
627 void     code_init        ();
628 uint32_t code_genstring   (const char *string);
629 uint32_t code_cachedstring(const char *string);
630 qcint    code_alloc_field (size_t qcsize);
631
632 /* this function is used to keep statements and linenumbers together */
633 void     code_push_statement(prog_section_statement *stmt, int linenum);
634 void     code_pop_statement();
635
636 /*
637  * A shallow copy of a lex_file to remember where which ast node
638  * came from.
639  */
640 typedef struct {
641     const char *file;
642     size_t      line;
643 } lex_ctx;
644
645 /*===================================================================*/
646 /*============================ con.c ================================*/
647 /*===================================================================*/
648 enum {
649     CON_BLACK   = 30,
650     CON_RED,
651     CON_GREEN,
652     CON_BROWN,
653     CON_BLUE,
654     CON_MAGENTA,
655     CON_CYAN ,
656     CON_WHITE
657 };
658
659 /* message level */
660 enum {
661     LVL_MSG,
662     LVL_WARNING,
663     LVL_ERROR
664 };
665
666 void con_vprintmsg (int level, const char *name, size_t line, const char *msgtype, const char *msg, va_list ap);
667 void con_printmsg  (int level, const char *name, size_t line, const char *msgtype, const char *msg, ...);
668 void con_cvprintmsg(void *ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
669 void con_cprintmsg (void *ctx, int lvl, const char *msgtype, const char *msg, ...);
670
671 void con_close ();
672 void con_init  ();
673 void con_reset ();
674 void con_color (int);
675 int  con_change(const char *, const char *);
676 int  con_verr  (const char *, va_list);
677 int  con_vout  (const char *, va_list);
678 int  con_err   (const char *, ...);
679 int  con_out   (const char *, ...);
680
681 /* error/warning interface */
682 extern size_t compile_errors;
683 extern size_t compile_warnings;
684
685 void /********/ compile_error   (lex_ctx ctx, /*LVL_ERROR*/ const char *msg, ...);
686 void /********/ vcompile_error  (lex_ctx ctx, /*LVL_ERROR*/ const char *msg, va_list ap);
687 bool GMQCC_WARN compile_warning (lex_ctx ctx, int warntype, const char *fmt, ...);
688 bool GMQCC_WARN vcompile_warning(lex_ctx ctx, int warntype, const char *fmt, va_list ap);
689
690 /*===================================================================*/
691 /*========================= assembler.c =============================*/
692 /*===================================================================*/
693 /* TODO: remove this ... */
694 static const struct {
695     const char  *m; /* menomic     */
696     const size_t o; /* operands    */
697     const size_t l; /* menomic len */
698 } asm_instr[] = {
699     { "DONE"      , 1, 4 },
700     { "MUL_F"     , 3, 5 },
701     { "MUL_V"     , 3, 5 },
702     { "MUL_FV"    , 3, 6 },
703     { "MUL_VF"    , 3, 6 },
704     { "DIV"       , 0, 3 },
705     { "ADD_F"     , 3, 5 },
706     { "ADD_V"     , 3, 5 },
707     { "SUB_F"     , 3, 5 },
708     { "SUB_V"     , 3, 5 },
709     { "EQ_F"      , 0, 4 },
710     { "EQ_V"      , 0, 4 },
711     { "EQ_S"      , 0, 4 },
712     { "EQ_E"      , 0, 4 },
713     { "EQ_FNC"    , 0, 6 },
714     { "NE_F"      , 0, 4 },
715     { "NE_V"      , 0, 4 },
716     { "NE_S"      , 0, 4 },
717     { "NE_E"      , 0, 4 },
718     { "NE_FNC"    , 0, 6 },
719     { "LE"        , 0, 2 },
720     { "GE"        , 0, 2 },
721     { "LT"        , 0, 2 },
722     { "GT"        , 0, 2 },
723     { "FIELD_F"   , 0, 7 },
724     { "FIELD_V"   , 0, 7 },
725     { "FIELD_S"   , 0, 7 },
726     { "FIELD_ENT" , 0, 9 },
727     { "FIELD_FLD" , 0, 9 },
728     { "FIELD_FNC" , 0, 9 },
729     { "ADDRESS"   , 0, 7 },
730     { "STORE_F"   , 0, 7 },
731     { "STORE_V"   , 0, 7 },
732     { "STORE_S"   , 0, 7 },
733     { "STORE_ENT" , 0, 9 },
734     { "STORE_FLD" , 0, 9 },
735     { "STORE_FNC" , 0, 9 },
736     { "STOREP_F"  , 0, 8 },
737     { "STOREP_V"  , 0, 8 },
738     { "STOREP_S"  , 0, 8 },
739     { "STOREP_ENT", 0, 10},
740     { "STOREP_FLD", 0, 10},
741     { "STOREP_FNC", 0, 10},
742     { "RETURN"    , 0, 6 },
743     { "NOT_F"     , 0, 5 },
744     { "NOT_V"     , 0, 5 },
745     { "NOT_S"     , 0, 5 },
746     { "NOT_ENT"   , 0, 7 },
747     { "NOT_FNC"   , 0, 7 },
748     { "IF"        , 0, 2 },
749     { "IFNOT"     , 0, 5 },
750     { "CALL0"     , 1, 5 },
751     { "CALL1"     , 2, 5 },
752     { "CALL2"     , 3, 5 },
753     { "CALL3"     , 4, 5 },
754     { "CALL4"     , 5, 5 },
755     { "CALL5"     , 6, 5 },
756     { "CALL6"     , 7, 5 },
757     { "CALL7"     , 8, 5 },
758     { "CALL8"     , 9, 5 },
759     { "STATE"     , 0, 5 },
760     { "GOTO"      , 0, 4 },
761     { "AND"       , 0, 3 },
762     { "OR"        , 0, 2 },
763     { "BITAND"    , 0, 6 },
764     { "BITOR"     , 0, 5 },
765
766     { "END"       , 0, 3 } /* virtual assembler instruction */
767 };
768 /*===================================================================*/
769 /*============================= ir.c ================================*/
770 /*===================================================================*/
771
772 enum store_types {
773     store_global,
774     store_local,  /* local, assignable for now, should get promoted later */
775     store_param,  /* parameters, they are locals with a fixed position */
776     store_value,  /* unassignable */
777     store_return  /* unassignable, at OFS_RETURN */
778 };
779
780 typedef struct {
781     qcfloat x, y, z;
782 } vector;
783
784 vector  vec3_add  (vector, vector);
785 vector  vec3_sub  (vector, vector);
786 qcfloat vec3_mulvv(vector, vector);
787 vector  vec3_mulvf(vector, float);
788
789 /*===================================================================*/
790 /*============================= exec.c ==============================*/
791 /*===================================================================*/
792
793 /* TODO: cleanup */
794 /*
795  * Darkplaces has (or will have) a 64 bit prog loader
796  * where the 32 bit qc program is autoconverted on load.
797  * Since we may want to support that as well, let's redefine
798  * float and int here.
799  */
800 typedef union {
801     qcint   _int;
802     qcint    string;
803     qcint    function;
804     qcint    edict;
805     qcfloat _float;
806     qcfloat vector[3];
807     qcint   ivector[3];
808 } qcany;
809
810 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
811 typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
812
813 enum {
814     VMERR_OK,
815     VMERR_TEMPSTRING_ALLOC,
816
817     VMERR_END
818 };
819
820 #define VM_JUMPS_DEFAULT 1000000
821
822 /* execute-flags */
823 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
824 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
825 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
826
827 struct qc_program_s;
828
829 typedef int (*prog_builtin)(struct qc_program_s *prog);
830
831 typedef struct {
832     qcint                  stmt;
833     size_t                 localsp;
834     prog_section_function *function;
835 } qc_exec_stack;
836
837 typedef struct qc_program_s {
838     char           *filename;
839
840     prog_section_statement *code;
841     prog_section_def       *defs;
842     prog_section_def       *fields;
843     prog_section_function  *functions;
844     char                   *strings;
845     qcint                  *globals;
846     qcint                  *entitydata;
847     bool                   *entitypool;
848
849     const char*            *function_stack;
850
851     uint16_t crc16;
852
853     size_t tempstring_start;
854     size_t tempstring_at;
855
856     qcint  vmerror;
857
858     size_t *profile;
859
860     prog_builtin *builtins;
861     size_t        builtins_count;
862
863     /* size_t ip; */
864     qcint  entities;
865     size_t entityfields;
866     bool   allowworldwrites;
867
868     qcint         *localstack;
869     qc_exec_stack *stack;
870     size_t statement;
871
872     size_t xflags;
873
874     int    argc; /* current arg count for debugging */
875 } qc_program;
876
877 qc_program* prog_load(const char *filename);
878 void        prog_delete(qc_program *prog);
879
880 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
881
882 char*             prog_getstring (qc_program *prog, qcint str);
883 prog_section_def* prog_entfield  (qc_program *prog, qcint off);
884 prog_section_def* prog_getdef    (qc_program *prog, qcint off);
885 qcany*            prog_getedict  (qc_program *prog, qcint e);
886 qcint             prog_tempstring(qc_program *prog, const char *_str);
887
888
889 /*===================================================================*/
890 /*===================== parser.c commandline ========================*/
891 /*===================================================================*/
892
893 bool parser_init          ();
894 bool parser_compile_file  (const char *);
895 bool parser_compile_string(const char *, const char *, size_t);
896 bool parser_finish        (const char *);
897 void parser_cleanup       ();
898
899 /*===================================================================*/
900 /*====================== ftepp.c commandline ========================*/
901 /*===================================================================*/
902 bool        ftepp_init             ();
903 bool        ftepp_preprocess_file  (const char *filename);
904 bool        ftepp_preprocess_string(const char *name, const char *str);
905 void        ftepp_finish           ();
906 const char *ftepp_get              ();
907 void        ftepp_flush            ();
908 void        ftepp_add_define       (const char *source, const char *name);
909 void        ftepp_add_macro        (const char *name,   const char *value);
910
911 /*===================================================================*/
912 /*======================= main.c commandline ========================*/
913 /*===================================================================*/
914
915 #if 0
916 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
917  * to 32 or 64 -f options...
918  */
919 typedef struct {
920     size_t  idx; /* index into an array of 32 bit words */
921     uint8_t bit; /* index _into_ the 32 bit word, thus just uint8 */
922 } longbit;
923 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
924 #else
925 typedef uint32_t longbit;
926 #define LONGBIT(bit) (bit)
927 #endif
928
929 /*===================================================================*/
930 /*============================= opts.c ==============================*/
931 /*===================================================================*/
932 typedef struct {
933     const char *name;
934     longbit     bit;
935 } opts_flag_def;
936
937 bool opts_setflag  (const char *, bool);
938 bool opts_setwarn  (const char *, bool);
939 bool opts_setwerror(const char *, bool);
940 bool opts_setoptim (const char *, bool);
941
942 void opts_init         (const char *, int, size_t);
943 void opts_set          (uint32_t   *, size_t, bool);
944 void opts_setoptimlevel(unsigned int);
945 void opts_ini_init     (const char *);
946
947 enum {
948 # define GMQCC_TYPE_FLAGS
949 # define GMQCC_DEFINE_FLAG(X) X,
950 #  include "opts.def"
951     COUNT_FLAGS
952 };
953 static const opts_flag_def opts_flag_list[] = {
954 # define GMQCC_TYPE_FLAGS
955 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
956 #  include "opts.def"
957     { NULL, LONGBIT(0) }
958 };
959
960 enum {
961 # define GMQCC_TYPE_WARNS
962 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
963 #  include "opts.def"
964     COUNT_WARNINGS
965 };
966 static const opts_flag_def opts_warn_list[] = {
967 # define GMQCC_TYPE_WARNS
968 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
969 #  include "opts.def"
970     { NULL, LONGBIT(0) }
971 };
972
973 enum {
974 # define GMQCC_TYPE_OPTIMIZATIONS
975 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) OPTIM_##NAME,
976 #  include "opts.def"
977     COUNT_OPTIMIZATIONS
978 };
979 static const opts_flag_def opts_opt_list[] = {
980 # define GMQCC_TYPE_OPTIMIZATIONS
981 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) { #NAME, LONGBIT(OPTIM_##NAME) },
982 #  include "opts.def"
983     { NULL, LONGBIT(0) }
984 };
985 static const unsigned int opts_opt_oflag[] = {
986 # define GMQCC_TYPE_OPTIMIZATIONS
987 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) MIN_O,
988 #  include "opts.def"
989     0
990 };
991 extern unsigned int opts_optimizationcount[COUNT_OPTIMIZATIONS];
992
993 /* other options: */
994 typedef enum {
995     COMPILER_QCC,     /* circa  QuakeC */
996     COMPILER_FTEQCC,  /* fteqcc QuakeC */
997     COMPILER_QCCX,    /* qccx   QuakeC */
998     COMPILER_GMQCC    /* this   QuakeC */
999 } opts_std_t;
1000
1001 /* TODO: cleanup this */
1002 typedef struct {
1003     uint32_t    O;              /* -Ox           */
1004     const char *output;         /* -o file       */
1005     bool        g;              /* -g            */
1006     opts_std_t  standard;       /* -std=         */
1007     bool        debug;          /* -debug        */
1008     bool        memchk;         /* -memchk       */
1009     bool        dumpfin;        /* -dumpfin      */
1010     bool        dump;           /* -dump         */
1011     bool        forcecrc;       /* --force-crc=  */
1012     uint16_t    forced_crc;     /* --force-crc=  */
1013     bool        pp_only;        /* -E            */
1014     size_t      max_array_size; /* --max-array=  */
1015
1016     uint32_t flags       [1 + (COUNT_FLAGS         / 32)];
1017     uint32_t warn        [1 + (COUNT_WARNINGS      / 32)];
1018     uint32_t werror      [1 + (COUNT_WARNINGS      / 32)];
1019     uint32_t optimization[1 + (COUNT_OPTIMIZATIONS / 32)];
1020 } opts_cmd_t;
1021
1022 extern opts_cmd_t opts;
1023
1024 #define OPTS_FLAG(i)         (!! (opts.flags       [(i)/32] & (1<< ((i)%32))))
1025 #define OPTS_WARN(i)         (!! (opts.warn        [(i)/32] & (1<< ((i)%32))))
1026 #define OPTS_WERROR(i)       (!! (opts.werror      [(i)/32] & (1<< ((i)%32))))
1027 #define OPTS_OPTIMIZATION(i) (!! (opts.optimization[(i)/32] & (1<< ((i)%32))))
1028
1029 #endif