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