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