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