Merge branch 'master' into test-suite
[xonotic/gmqcc.git] / gmqcc.h
1 /*
2  * Copyright (C) 2012
3  *     Dale Weiler, Wolfgang Bumiller
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9  * of the Software, and to permit persons to whom the Software is furnished to do
10  * so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23 #ifndef GMQCC_HDR
24 #define GMQCC_HDR
25 #include <limits.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <stdio.h>
29 #include <stdarg.h>
30 #include <ctype.h>
31
32 /*
33  * Disable some over protective warnings in visual studio because fixing them is a waste
34  * of my time.
35  */
36 #ifdef _MSC_VER
37 #       pragma warning(disable : 4244 ) /* conversion from 'int' to 'float', possible loss of data */
38 #       pragma warning(disable : 4018 ) /* signed/unsigned mismatch                                */
39 #       pragma warning(disable : 4996 ) /* This function or variable may be unsafe                 */
40 #       pragma warning(disable : 4700 ) /* uninitialized local variable used                       */
41 #endif
42
43 #define GMQCC_VERSION_MAJOR 0
44 #define GMQCC_VERSION_MINOR 1
45 #define GMQCC_VERSION_PATCH 0
46 #define GMQCC_VERSION_BUILD(J,N,P) (((J)<<16)|((N)<<8)|(P))
47 #define GMQCC_VERSION \
48     GMQCC_VERSION_BUILD(GMQCC_VERSION_MAJOR, GMQCC_VERSION_MINOR, GMQCC_VERSION_PATCH)
49
50 /*
51  * We cannoy rely on C99 at all, since compilers like MSVC
52  * simply don't support it.  We define our own boolean type
53  * as a result (since we cannot include <stdbool.h>). For
54  * compilers that are in 1999 mode (C99 compliant) we can use
55  * the language keyword _Bool which can allow for better code
56  * on GCC and GCC-like compilers, opposed to `int`.
57  */
58 #ifndef __cplusplus
59 #   ifdef  false
60 #       undef  false
61 #   endif /* !false */
62 #   ifdef  true
63 #       undef true
64 #   endif /* !true  */
65 #   define false (0)
66 #   define true  (1)
67 #   ifdef __STDC_VERSION__
68 #       if __STDC_VERSION__ < 199901L && __GNUC__ < 3
69             typedef int  bool;
70 #       else
71             typedef _Bool bool;
72 #       endif
73 #   else
74         typedef int bool;
75 #   endif /* !__STDC_VERSION__ */
76 #endif    /* !__cplusplus      */
77
78 /*
79  * Of some functions which are generated we want to make sure
80  * that the result isn't ignored. To find such function calls,
81  * we use this macro.
82  */
83 #if defined(__GNUC__) || defined(__CLANG__)
84 #   define GMQCC_WARN __attribute__((warn_unused_result))
85 #else
86 #   define GMQCC_WARN
87 #endif
88 /*
89  * This is a hack to silent clang regarding empty
90  * body if statements.
91  */
92 #define GMQCC_SUPPRESS_EMPTY_BODY do { } while (0)
93
94 /*
95  * Inline is not supported in < C90, however some compilers
96  * like gcc and clang might have an inline attribute we can
97  * use if present.
98  */
99 #ifdef __STDC_VERSION__
100 #    if __STDC_VERSION__ < 199901L
101 #       if defined(__GNUC__) || defined (__CLANG__)
102 #           if __GNUC__ < 2
103 #               define GMQCC_INLINE
104 #           else
105 #               define GMQCC_INLINE __attribute__ ((always_inline))
106 #           endif
107 #       else
108 #           define GMQCC_INLINE
109 #       endif
110 #    else
111 #       define GMQCC_INLINE inline
112 #    endif
113 #else
114 #    define GMQCC_INLINE
115 #endif /* !__STDC_VERSION__ */
116
117 /*
118  * noreturn is present in GCC and clang
119  * it's required for _ast_node_destory otherwise -Wmissing-noreturn
120  * in clang complains about there being no return since abort() is
121  * called.
122  */
123 #if (defined(__GNUC__) && __GNUC__ >= 2) || defined(__CLANG__)
124 #    define GMQCC_NORETURN __attribute__ ((noreturn))
125 #else
126 #    define GMQCC_NORETURN
127 #endif
128
129 /*
130  * stdint.h and inttypes.h -less subset
131  * for systems that don't have it, which we must
132  * assume is all systems. (int8_t not required)
133  */
134 #if   CHAR_MIN  == -128
135     typedef unsigned char  uint8_t; /* same as below */
136 #elif SCHAR_MIN == -128
137     typedef unsigned char  uint8_t; /* same as above */
138 #endif
139 #if   SHRT_MAX  == 0x7FFF
140     typedef short          int16_t;
141     typedef unsigned short uint16_t;
142 #elif INT_MAX   == 0x7FFF
143     typedef int            int16_t;
144     typedef unsigned int   uint16_t;
145 #endif
146 #if   INT_MAX   == 0x7FFFFFFF
147     typedef int            int32_t;
148     typedef unsigned int   uint32_t;
149 #elif LONG_MAX  == 0x7FFFFFFF
150     typedef long           int32_t;
151     typedef unsigned long  uint32_t;
152 #endif
153
154
155 #if defined(__GNUC__) || defined (__CLANG__)
156         typedef int          int64_t  __attribute__((__mode__(__DI__)));
157         typedef unsigned int uint64_t __attribute__((__mode__(__DI__)));
158 #elif defined(_MSC_VER)
159         typedef __int64          int64_t;
160         typedef unsigned __int64 uint64_t;
161 #else
162     /*
163     * Incoorectly size the types so static assertions below will
164     * fail.  There is no valid way to get a 64bit type at this point
165     * without making assumptions of too many things.
166     */
167     typedef struct { char _fail : 0; } int64_t;
168     typedef struct { char _fail : 0; } uint64_t;
169 #endif
170 #ifdef _LP64 /* long pointer == 64 */
171     typedef unsigned long  uintptr_t;
172     typedef long           intptr_t;
173 #else
174     typedef unsigned int   uintptr_t;
175     typedef int            intptr_t;
176 #endif
177 /* Ensure type sizes are correct: */
178 typedef char uint8_size_is_correct  [sizeof(uint8_t)  == 1?1:-1];
179 typedef char uint16_size_is_correct [sizeof(uint16_t) == 2?1:-1];
180 typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
181 typedef char uint64_size_is_correct [sizeof(uint64_t) == 8?1:-1];
182 typedef char int16_size_if_correct  [sizeof(int16_t)  == 2?1:-1];
183 typedef char int32_size_is_correct  [sizeof(int32_t)  == 4?1:-1];
184 typedef char int64_size_is_correct  [sizeof(int64_t)  >= 8?1:-1];
185 /* intptr_t / uintptr_t correct size check */
186 typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
187 typedef char intptr_size_is_correct [sizeof(uintptr_t)== sizeof(int*)?1:-1];
188
189 /*===================================================================*/
190 /*=========================== util.c ================================*/
191 /*===================================================================*/
192 FILE *util_fopen(const char *filename, const char *mode);
193
194 void *util_memory_a      (size_t,       unsigned int, const char *);
195 void  util_memory_d      (void       *, unsigned int, const char *);
196 void *util_memory_r      (void       *, size_t,       unsigned int, const char *);
197 void  util_meminfo       ();
198
199 bool  util_filexists     (const char *);
200 bool  util_strupper      (const char *);
201 bool  util_strdigit      (const char *);
202 bool  util_strncmpexact  (const char *, const char *, size_t);
203 char *util_strdup        (const char *);
204 char *util_strrq         (const char *);
205 char *util_strrnl        (const char *);
206 char *util_strsws        (const char *);
207 char *util_strchp        (const char *, const char *);
208 void  util_debug         (const char *, const char *, ...);
209 int   util_getline       (char **, size_t *, FILE *);
210 void  util_endianswap    (void *,  int, int);
211
212 size_t util_strtocmd    (const char *, char *, size_t);
213 size_t util_strtononcmd (const char *, char *, size_t);
214
215 uint16_t util_crc16(uint16_t crc, const char *data, size_t len);
216 uint32_t util_crc32(uint32_t crc, const char *data, size_t len);
217
218 #ifdef NOTRACK
219 #    define mem_a(x)    malloc (x)
220 #    define mem_d(x)    free   (x)
221 #    define mem_r(x, n) realloc(x, n)
222 #else
223 #    define mem_a(x)    util_memory_a((x), __LINE__, __FILE__)
224 #    define mem_d(x)    util_memory_d((x), __LINE__, __FILE__)
225 #    define mem_r(x, n) util_memory_r((x), (n), __LINE__, __FILE__)
226 #endif
227
228 /*
229  * TODO: make these safer to use.  Currently this only works on
230  * x86 and x86_64, some systems will likely not like this. Such
231  * as BE systems.
232  */
233 #define FLT2INT(Y) *((int32_t*)&(Y))
234 #define INT2FLT(Y) *((float  *)&(Y))
235
236 /* New flexible vector implementation from Dale */
237 #define _vec_raw(A) (((size_t*)(A)) - 2)
238 #define _vec_beg(A) (_vec_raw(A)[0])
239 #define _vec_end(A) (_vec_raw(A)[1])
240 #define _vec_needsgrow(A,N) ((!(A)) || (_vec_end(A) + (N) >= _vec_beg(A)))
241 #define _vec_mightgrow(A,N) (_vec_needsgrow((A), (N)) ? _vec_forcegrow((A),(N)) : 0)
242 #define _vec_forcegrow(A,N) _util_vec_grow((void**)&(A), (N), sizeof(*(A)))
243 #define _vec_remove(A,S,I,N) (memmove((char*)(A)+(I)*(S),(char*)(A)+((I)+(N))*(S),(S)*(vec_size(A)-(I)-(N))), _vec_end(A)-=(N))
244 void _util_vec_grow(void **a, size_t i, size_t s);
245 /* exposed interface */
246 #define vec_free(A)          ((A) ? (mem_d(_vec_raw(A)), (A) = NULL) : 0)
247 #define vec_push(A,V)        (_vec_mightgrow((A),1), (A)[_vec_end(A)++] = (V))
248 #define vec_size(A)          ((A) ? _vec_end(A) : 0)
249 #define vec_add(A,N)         (_vec_mightgrow((A),(N)), _vec_end(A)+=(N), &(A)[_vec_end(A)-(N)])
250 #define vec_last(A)          ((A)[_vec_end(A)-1])
251 #define vec_append(A,N,S)    memcpy(vec_add((A), (N)), (S), N * sizeof(*(S)))
252 #define vec_remove(A,I,N)    _vec_remove((A), sizeof(*(A)), (I), (N))
253 #define vec_pop(A)           vec_remove((A), _vec_end(A)-1, 1)
254 /* these are supposed to NOT reallocate */
255 #define vec_shrinkto(A,N)    (_vec_end(A) = (N))
256 #define vec_shrinkby(A,N)    (_vec_end(A) -= (N))
257
258 /*===================================================================*/
259 /*=========================== code.c ================================*/
260 /*===================================================================*/
261
262 /* Note: if you change the order, fix type_sizeof in ir.c */
263 enum {
264     TYPE_VOID     ,
265     TYPE_STRING   ,
266     TYPE_FLOAT    ,
267     TYPE_VECTOR   ,
268     TYPE_ENTITY   ,
269     TYPE_FIELD    ,
270     TYPE_FUNCTION ,
271     TYPE_POINTER  ,
272     TYPE_INTEGER  ,
273     TYPE_VARIANT  ,
274     TYPE_STRUCT   ,
275     TYPE_UNION    ,
276     TYPE_ARRAY    ,
277
278     TYPE_COUNT
279 };
280
281 extern const char *type_name[TYPE_COUNT];
282
283 extern size_t type_sizeof[TYPE_COUNT];
284 extern uint16_t type_store_instr[TYPE_COUNT];
285 extern uint16_t field_store_instr[TYPE_COUNT];
286 /* could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
287  * but this breaks when TYPE_INTEGER is added, since with the enhanced
288  * instruction set, the old ones are left untouched, thus the _I instructions
289  * are at a seperate place.
290  */
291 extern uint16_t type_storep_instr[TYPE_COUNT];
292 /* other useful lists */
293 extern uint16_t type_eq_instr[TYPE_COUNT];
294 extern uint16_t type_ne_instr[TYPE_COUNT];
295
296 typedef struct {
297     uint32_t offset;      /* Offset in file of where data begins  */
298     uint32_t length;      /* Length of section (how many of)      */
299 } prog_section;
300
301 typedef struct {
302     uint32_t     version;      /* Program version (6)     */
303     uint16_t     crc16;        /* What is this?           */
304     uint16_t     skip;         /* see propsal.txt         */
305
306     prog_section statements;   /* prog_section_statement  */
307     prog_section defs;         /* prog_section_def        */
308     prog_section fields;       /* prog_section_field      */
309     prog_section functions;    /* prog_section_function   */
310     prog_section strings;      /* What is this?           */
311     prog_section globals;      /* What is this?           */
312     uint32_t     entfield;     /* Number of entity fields */
313 } prog_header;
314
315 /*
316  * Each paramater incerements by 3 since vector types hold
317  * 3 components (x,y,z).
318  */
319 #define OFS_NULL      0
320 #define OFS_RETURN    1
321 #define OFS_PARM0     (OFS_RETURN+3)
322 #define OFS_PARM1     (OFS_PARM0 +3)
323 #define OFS_PARM2     (OFS_PARM1 +3)
324 #define OFS_PARM3     (OFS_PARM2 +3)
325 #define OFS_PARM4     (OFS_PARM3 +3)
326 #define OFS_PARM5     (OFS_PARM4 +3)
327 #define OFS_PARM6     (OFS_PARM5 +3)
328 #define OFS_PARM7     (OFS_PARM6 +3)
329
330 typedef struct {
331     uint16_t opcode;
332
333     /* operand 1 */
334     union {
335         int16_t  s1; /* signed   */
336         uint16_t u1; /* unsigned */
337     } o1;
338     /* operand 2 */
339     union {
340         int16_t  s1; /* signed   */
341         uint16_t u1; /* unsigned */
342     } o2;
343     /* operand 3 */
344     union {
345         int16_t  s1; /* signed   */
346         uint16_t u1; /* unsigned */
347     } o3;
348
349     /*
350      * This is the same as the structure in darkplaces
351      * {
352      *     unsigned short op;
353      *     short          a,b,c;
354      * }
355      * But this one is more sane to work with, and the
356      * type sizes are guranteed.
357      */
358 } prog_section_statement;
359
360 typedef struct {
361     /* The types:
362      * 0 = ev_void
363      * 1 = ev_string
364      * 2 = ev_float
365      * 3 = ev_vector
366      * 4 = ev_entity
367      * 5 = ev_field
368      * 6 = ev_function
369      * 7 = ev_pointer -- engine only
370      * 8 = ev_bad     -- engine only
371      */
372     uint16_t type;
373     uint16_t offset;
374     uint32_t name;
375 } prog_section_both;
376 typedef prog_section_both prog_section_def;
377 typedef prog_section_both prog_section_field;
378
379 /* this is ORed to the type */
380 #define DEF_SAVEGLOBAL (1<<15)
381 #define DEF_TYPEMASK   ((1<<15)-1)
382
383 typedef struct {
384     int32_t   entry;      /* in statement table for instructions  */
385     uint32_t  firstlocal; /* First local in local table           */
386     uint32_t  locals;     /* Total ints of params + locals        */
387     uint32_t  profile;    /* Always zero (engine uses this)       */
388     uint32_t  name;       /* name of function in string table     */
389     uint32_t  file;       /* file of the source file              */
390     uint32_t  nargs;      /* number of arguments                  */
391     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
392 } prog_section_function;
393
394 /*
395  * Instructions
396  * These are the external instructions supported by the interperter
397  * this is what things compile to (from the C code).
398  */
399 enum {
400     INSTR_DONE,
401     INSTR_MUL_F,
402     INSTR_MUL_V,
403     INSTR_MUL_FV, /* NOTE: the float operands must NOT be at the same locations: A != C */
404     INSTR_MUL_VF, /* and here: B != C */
405     INSTR_DIV_F,
406     INSTR_ADD_F,
407     INSTR_ADD_V,
408     INSTR_SUB_F,
409     INSTR_SUB_V,
410     INSTR_EQ_F,
411     INSTR_EQ_V,
412     INSTR_EQ_S,
413     INSTR_EQ_E,
414     INSTR_EQ_FNC,
415     INSTR_NE_F,
416     INSTR_NE_V,
417     INSTR_NE_S,
418     INSTR_NE_E,
419     INSTR_NE_FNC,
420     INSTR_LE,
421     INSTR_GE,
422     INSTR_LT,
423     INSTR_GT,
424     INSTR_LOAD_F,
425     INSTR_LOAD_V,
426     INSTR_LOAD_S,
427     INSTR_LOAD_ENT,
428     INSTR_LOAD_FLD,
429     INSTR_LOAD_FNC,
430     INSTR_ADDRESS,
431     INSTR_STORE_F,
432     INSTR_STORE_V,
433     INSTR_STORE_S,
434     INSTR_STORE_ENT,
435     INSTR_STORE_FLD,
436     INSTR_STORE_FNC,
437     INSTR_STOREP_F,
438     INSTR_STOREP_V,
439     INSTR_STOREP_S,
440     INSTR_STOREP_ENT,
441     INSTR_STOREP_FLD,
442     INSTR_STOREP_FNC,
443     INSTR_RETURN,
444     INSTR_NOT_F,
445     INSTR_NOT_V,
446     INSTR_NOT_S,
447     INSTR_NOT_ENT,
448     INSTR_NOT_FNC,
449     INSTR_IF,
450     INSTR_IFNOT,
451     INSTR_CALL0,
452     INSTR_CALL1,
453     INSTR_CALL2,
454     INSTR_CALL3,
455     INSTR_CALL4,
456     INSTR_CALL5,
457     INSTR_CALL6,
458     INSTR_CALL7,
459     INSTR_CALL8,
460     INSTR_STATE,
461     INSTR_GOTO,
462     INSTR_AND,
463     INSTR_OR,
464     INSTR_BITAND,
465     INSTR_BITOR,
466
467     /*
468      * Virtual instructions used by the assembler
469      * keep at the end but before virtual instructions
470      * for the IR below.
471      */
472     AINSTR_END,
473
474     /*
475      * Virtual instructions used by the IR
476      * Keep at the end!
477      */
478     VINSTR_PHI,
479     VINSTR_JUMP,
480     VINSTR_COND
481 };
482
483 extern prog_section_statement *code_statements;
484 extern prog_section_def       *code_defs;
485 extern prog_section_field     *code_fields;
486 extern prog_section_function  *code_functions;
487 extern int                    *code_globals;
488 extern char                   *code_chars;
489 extern uint16_t code_crc;
490
491 typedef float   qcfloat;
492 typedef int32_t qcint;
493
494 /*
495  * code_write -- writes out the compiled file
496  * code_init  -- prepares the code file
497  */
498 bool     code_write       (const char *filename);
499 void     code_init        ();
500 uint32_t code_genstring   (const char *string);
501 uint32_t code_cachedstring(const char *string);
502 qcint    code_alloc_field (size_t qcsize);
503
504 /*===================================================================*/
505 /*============================ con.c ================================*/
506 /*===================================================================*/
507 enum {
508     CON_BLACK   = 30,
509     CON_RED,
510     CON_GREEN,
511     CON_BROWN,
512     CON_BLUE,
513     CON_MAGENTA,
514     CON_CYAN ,
515     CON_WHITE
516 };
517
518 /* message level */
519 enum {
520     LVL_MSG,
521     LVL_WARNING,
522     LVL_ERROR
523 };
524
525
526 void con_vprintmsg (int level, const char *name, size_t line, const char *msgtype, const char *msg, va_list ap);
527 void con_printmsg  (int level, const char *name, size_t line, const char *msgtype, const char *msg, ...);
528 void con_cvprintmsg(void *ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
529 void con_cprintmsg (void *ctx, int lvl, const char *msgtype, const char *msg, ...);
530
531 void con_close();
532 void con_color(int state);
533 void con_init ();
534 void con_reset();
535 int  con_change(const char *out, const char *err);
536 int  con_verr  (const char *fmt, va_list va);
537 int  con_vout  (const char *fmt, va_list va);
538 int  con_err   (const char *fmt, ...);
539 int  con_out   (const char *fmt, ...);
540
541 /*===================================================================*/
542 /*========================= assembler.c =============================*/
543 /*===================================================================*/
544 static const struct {
545     const char  *m; /* menomic     */
546     const size_t o; /* operands    */
547     const size_t l; /* menomic len */
548 } asm_instr[] = {
549     { "DONE"      , 1, 4 },
550     { "MUL_F"     , 3, 5 },
551     { "MUL_V"     , 3, 5 },
552     { "MUL_FV"    , 3, 6 },
553     { "MUL_VF"    , 3, 6 },
554     { "DIV"       , 0, 3 },
555     { "ADD_F"     , 3, 5 },
556     { "ADD_V"     , 3, 5 },
557     { "SUB_F"     , 3, 5 },
558     { "SUB_V"     , 3, 5 },
559     { "EQ_F"      , 0, 4 },
560     { "EQ_V"      , 0, 4 },
561     { "EQ_S"      , 0, 4 },
562     { "EQ_E"      , 0, 4 },
563     { "EQ_FNC"    , 0, 6 },
564     { "NE_F"      , 0, 4 },
565     { "NE_V"      , 0, 4 },
566     { "NE_S"      , 0, 4 },
567     { "NE_E"      , 0, 4 },
568     { "NE_FNC"    , 0, 6 },
569     { "LE"        , 0, 2 },
570     { "GE"        , 0, 2 },
571     { "LT"        , 0, 2 },
572     { "GT"        , 0, 2 },
573     { "FIELD_F"   , 0, 7 },
574     { "FIELD_V"   , 0, 7 },
575     { "FIELD_S"   , 0, 7 },
576     { "FIELD_ENT" , 0, 9 },
577     { "FIELD_FLD" , 0, 9 },
578     { "FIELD_FNC" , 0, 9 },
579     { "ADDRESS"   , 0, 7 },
580     { "STORE_F"   , 0, 7 },
581     { "STORE_V"   , 0, 7 },
582     { "STORE_S"   , 0, 7 },
583     { "STORE_ENT" , 0, 9 },
584     { "STORE_FLD" , 0, 9 },
585     { "STORE_FNC" , 0, 9 },
586     { "STOREP_F"  , 0, 8 },
587     { "STOREP_V"  , 0, 8 },
588     { "STOREP_S"  , 0, 8 },
589     { "STOREP_ENT", 0, 10},
590     { "STOREP_FLD", 0, 10},
591     { "STOREP_FNC", 0, 10},
592     { "RETURN"    , 0, 6 },
593     { "NOT_F"     , 0, 5 },
594     { "NOT_V"     , 0, 5 },
595     { "NOT_S"     , 0, 5 },
596     { "NOT_ENT"   , 0, 7 },
597     { "NOT_FNC"   , 0, 7 },
598     { "IF"        , 0, 2 },
599     { "IFNOT"     , 0, 5 },
600     { "CALL0"     , 1, 5 },
601     { "CALL1"     , 2, 5 },
602     { "CALL2"     , 3, 5 },
603     { "CALL3"     , 4, 5 },
604     { "CALL4"     , 5, 5 },
605     { "CALL5"     , 6, 5 },
606     { "CALL6"     , 7, 5 },
607     { "CALL7"     , 8, 5 },
608     { "CALL8"     , 9, 5 },
609     { "STATE"     , 0, 5 },
610     { "GOTO"      , 0, 4 },
611     { "AND"       , 0, 3 },
612     { "OR"        , 0, 2 },
613     { "BITAND"    , 0, 6 },
614     { "BITOR"     , 0, 5 },
615
616     { "END"       , 0, 3 } /* virtual assembler instruction */
617 };
618 /*===================================================================*/
619 /*============================= ir.c ================================*/
620 /*===================================================================*/
621
622 enum store_types {
623     store_global,
624     store_local,  /* local, assignable for now, should get promoted later */
625     store_param,  /* parameters, they are locals with a fixed position */
626     store_value,  /* unassignable */
627     store_return  /* unassignable, at OFS_RETURN */
628 };
629
630 typedef struct {
631     qcfloat x, y, z;
632 } vector;
633
634 vector  vec3_add  (vector, vector);
635 vector  vec3_sub  (vector, vector);
636 qcfloat vec3_mulvv(vector, vector);
637 vector  vec3_mulvf(vector, float);
638
639 /*
640  * A shallow copy of a lex_file to remember where which ast node
641  * came from.
642  */
643 typedef struct {
644     const char *file;
645     size_t      line;
646 } lex_ctx;
647
648 /*===================================================================*/
649 /*============================= exec.c ==============================*/
650 /*===================================================================*/
651
652 /* darkplaces has (or will have) a 64 bit prog loader
653  * where the 32 bit qc program is autoconverted on load.
654  * Since we may want to support that as well, let's redefine
655  * float and int here.
656  */
657 typedef union {
658     qcint   _int;
659     qcint    string;
660     qcint    function;
661     qcint    edict;
662     qcfloat _float;
663     qcfloat vector[3];
664     qcint   ivector[3];
665 } qcany;
666
667 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
668 typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
669
670 enum {
671     VMERR_OK,
672     VMERR_TEMPSTRING_ALLOC,
673
674     VMERR_END
675 };
676
677 #define VM_JUMPS_DEFAULT 1000000
678
679 /* execute-flags */
680 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
681 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
682 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
683
684 struct qc_program_s;
685
686 typedef int (*prog_builtin)(struct qc_program_s *prog);
687
688 typedef struct {
689     qcint                  stmt;
690     size_t                 localsp;
691     prog_section_function *function;
692 } qc_exec_stack;
693
694 typedef struct qc_program_s {
695     char           *filename;
696
697     prog_section_statement *code;
698     prog_section_def       *defs;
699     prog_section_def       *fields;
700     prog_section_function  *functions;
701     char                   *strings;
702     qcint                  *globals;
703     qcint                  *entitydata;
704     bool                   *entitypool;
705
706     const char*            *function_stack;
707
708     uint16_t crc16;
709
710     size_t tempstring_start;
711     size_t tempstring_at;
712
713     qcint  vmerror;
714
715     size_t *profile;
716
717     prog_builtin *builtins;
718     size_t        builtins_count;
719
720     /* size_t ip; */
721     qcint  entities;
722     size_t entityfields;
723     bool   allowworldwrites;
724
725     qcint         *localstack;
726     qc_exec_stack *stack;
727     size_t statement;
728
729     size_t xflags;
730
731     int    argc; /* current arg count for debugging */
732 } qc_program;
733
734 qc_program* prog_load(const char *filename);
735 void        prog_delete(qc_program *prog);
736
737 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
738
739 char*             prog_getstring (qc_program *prog, qcint str);
740 prog_section_def* prog_entfield  (qc_program *prog, qcint off);
741 prog_section_def* prog_getdef    (qc_program *prog, qcint off);
742 qcany*            prog_getedict  (qc_program *prog, qcint e);
743 qcint             prog_tempstring(qc_program *prog, const char *_str);
744
745
746 /*===================================================================*/
747 /*===================== parser.c commandline ========================*/
748 /*===================================================================*/
749
750 bool parser_init          ();
751 bool parser_compile_file  (const char *filename);
752 bool parser_compile_string(const char *name, const char *str);
753 bool parser_finish        (const char *output);
754 void parser_cleanup       ();
755 /* There's really no need to strlen() preprocessed files */
756 bool parser_compile_string_len(const char *name, const char *str, size_t len);
757
758 /*===================================================================*/
759 /*====================== ftepp.c commandline ========================*/
760 /*===================================================================*/
761 bool ftepp_init             ();
762 bool ftepp_preprocess_file  (const char *filename);
763 bool ftepp_preprocess_string(const char *name, const char *str);
764 void ftepp_finish           ();
765 const char *ftepp_get       ();
766 void ftepp_flush            ();
767
768 /*===================================================================*/
769 /*======================= main.c commandline ========================*/
770 /*===================================================================*/
771
772 #if 0
773 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
774  * to 32 or 64 -f options...
775  */
776 typedef struct {
777     size_t  idx; /* index into an array of 32 bit words */
778     uint8_t bit; /* index _into_ the 32 bit word, thus just uint8 */
779 } longbit;
780 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
781 #else
782 typedef uint32_t longbit;
783 #define LONGBIT(bit) (bit)
784 #endif
785
786 /* Used to store the list of flags with names */
787 typedef struct {
788     const char *name;
789     longbit    bit;
790 } opts_flag_def;
791
792 /*===================================================================*/
793 /* list of -f flags, like -fdarkplaces-string-table-bug */
794 enum {
795 # define GMQCC_TYPE_FLAGS
796 # define GMQCC_DEFINE_FLAG(X) X,
797 #  include "opts.def"
798     COUNT_FLAGS
799 };
800 static const opts_flag_def opts_flag_list[] = {
801 # define GMQCC_TYPE_FLAGS
802 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
803 #  include "opts.def"
804     { NULL, LONGBIT(0) }
805 };
806
807 enum {
808 # define GMQCC_TYPE_WARNS
809 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
810 #  include "opts.def"
811     COUNT_WARNINGS
812 };
813 static const opts_flag_def opts_warn_list[] = {
814 # define GMQCC_TYPE_WARNS
815 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
816 #  include "opts.def"
817     { NULL, LONGBIT(0) }
818 };
819
820 /* other options: */
821 enum {
822     COMPILER_QCC,     /* circa  QuakeC */
823     COMPILER_FTEQCC,  /* fteqcc QuakeC */
824     COMPILER_QCCX,    /* qccx   QuakeC */
825     COMPILER_GMQCC    /* this   QuakeC */
826 };
827 extern uint32_t    opts_O;      /* -Ox */
828 extern const char *opts_output; /* -o file */
829 extern int         opts_standard;
830 extern bool        opts_debug;
831 extern bool        opts_memchk;
832 extern bool        opts_dump;
833 extern bool        opts_werror;
834 extern bool        opts_forcecrc;
835 extern uint16_t    opts_forced_crc;
836 extern bool        opts_pp_only;
837 extern size_t      opts_max_array_size;
838
839 /*===================================================================*/
840 #define OPTS_FLAG(i) (!! (opts_flags[(i)/32] & (1<< ((i)%32))))
841 extern uint32_t opts_flags[1 + (COUNT_FLAGS / 32)];
842 #define OPTS_WARN(i) (!! (opts_warn[(i)/32] & (1<< ((i)%32))))
843 extern uint32_t opts_warn[1 + (COUNT_WARNINGS / 32)];
844
845 #endif