]> git.xonotic.org Git - xonotic/gmqcc.git/blob - gmqcc.h
Merging in new-syntax
[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      (unsigned int, unsigned int, const char *);
195 void  util_memory_d      (void       *, unsigned int, const char *);
196 void  util_meminfo       ();
197
198 bool  util_strupper      (const char *);
199 bool  util_strdigit      (const char *);
200 bool  util_strncmpexact  (const char *, const char *, size_t);
201 char *util_strdup        (const char *);
202 char *util_strrq         (const char *);
203 char *util_strrnl        (const char *);
204 char *util_strsws        (const char *);
205 char *util_strchp        (const char *, const char *);
206 void  util_debug         (const char *, const char *, ...);
207 int   util_getline       (char **, size_t *, FILE *);
208 void  util_endianswap    (void *,  int, int);
209
210 size_t util_strtocmd    (const char *, char *, size_t);
211 size_t util_strtononcmd (const char *, char *, size_t);
212
213 uint16_t util_crc16(uint16_t crc, const char *data, size_t len);
214 uint32_t util_crc32(uint32_t crc, const char *data, size_t len);
215
216 #ifdef NOTRACK
217 #    define mem_a(x) malloc(x)
218 #    define mem_d(x) free  (x)
219 #else
220 #    define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
221 #    define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
222 #endif
223
224 /*
225  * TODO: make these safer to use.  Currently this only works on
226  * x86 and x86_64, some systems will likely not like this. Such
227  * as BE systems.
228  */
229 #define FLT2INT(Y) *((int32_t*)&(Y))
230 #define INT2FLT(Y) *((float  *)&(Y))
231
232 /* Builds vector type (usefull for inside structures) */
233 #define VECTOR_SNAP(X,Y) X ## Y
234 #define VECTOR_FILL(X,Y) VECTOR_SNAP(X,Y)
235 #define VECTOR_TYPE(T,N)                                        \
236     T*     N##_data      = NULL;                                \
237     long   N##_elements  = 0;                                   \
238     long   N##_allocated = 0
239 /* Builds vector add */
240 #define VECTOR_CORE(T,N)                                        \
241     int    N##_add(T element) {                                 \
242         void *temp = NULL;                                      \
243         if (N##_elements == N##_allocated) {                    \
244             if (N##_allocated == 0) {                           \
245                 N##_allocated = 12;                             \
246             } else {                                            \
247                 N##_allocated *= 2;                             \
248             }                                                   \
249             if  (!(temp = mem_a(N##_allocated * sizeof(T)))) {  \
250                 mem_d(temp);                                    \
251                 return -1;                                      \
252             }                                                   \
253             memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
254             mem_d(N##_data);                                    \
255             N##_data = (T*)temp;                                \
256         }                                                       \
257         N##_data[N##_elements] = element;                       \
258         return   N##_elements++;                                \
259     }                                                           \
260     int N##_put(T* elements, size_t len) {                      \
261         len     --;                                             \
262         elements--;                                             \
263         while (N##_add(*++elements) != -1 && len--);            \
264         return N##_elements;                                    \
265     }                                                           \
266     typedef char VECTOR_FILL(extra_semicolon_##N,__COUNTER__)
267 #define VECTOR_PROT(T,N)                                        \
268     extern T*     N##_data     ;                                \
269     extern long   N##_elements ;                                \
270     extern long   N##_allocated;                                \
271     int           N##_add(T);                                   \
272     int           N##_put(T *, size_t)
273 #define VECTOR_MAKE(T,N) \
274     VECTOR_TYPE(T,N);    \
275     VECTOR_CORE(T,N)
276
277 /*===================================================================*/
278 /*=========================== code.c ================================*/
279 /*===================================================================*/
280
281 /* Note: if you change the order, fix type_sizeof in ir.c */
282 enum {
283     TYPE_VOID     ,
284     TYPE_STRING   ,
285     TYPE_FLOAT    ,
286     TYPE_VECTOR   ,
287     TYPE_ENTITY   ,
288     TYPE_FIELD    ,
289     TYPE_FUNCTION ,
290     TYPE_POINTER  ,
291     TYPE_INTEGER  ,
292     TYPE_VARIANT  ,
293     TYPE_STRUCT   ,
294     TYPE_UNION    ,
295     TYPE_ARRAY    ,
296
297     TYPE_COUNT
298 };
299
300 extern const char *type_name[TYPE_COUNT];
301
302 extern size_t type_sizeof[TYPE_COUNT];
303 extern uint16_t type_store_instr[TYPE_COUNT];
304 extern uint16_t field_store_instr[TYPE_COUNT];
305 /* could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
306  * but this breaks when TYPE_INTEGER is added, since with the enhanced
307  * instruction set, the old ones are left untouched, thus the _I instructions
308  * are at a seperate place.
309  */
310 extern uint16_t type_storep_instr[TYPE_COUNT];
311 /* other useful lists */
312 extern uint16_t type_eq_instr[TYPE_COUNT];
313 extern uint16_t type_ne_instr[TYPE_COUNT];
314
315 typedef struct {
316     uint32_t offset;      /* Offset in file of where data begins  */
317     uint32_t length;      /* Length of section (how many of)      */
318 } prog_section;
319
320 typedef struct {
321     uint32_t     version;      /* Program version (6)     */
322     uint16_t     crc16;        /* What is this?           */
323     uint16_t     skip;         /* see propsal.txt         */
324
325     prog_section statements;   /* prog_section_statement  */
326     prog_section defs;         /* prog_section_def        */
327     prog_section fields;       /* prog_section_field      */
328     prog_section functions;    /* prog_section_function   */
329     prog_section strings;      /* What is this?           */
330     prog_section globals;      /* What is this?           */
331     uint32_t     entfield;     /* Number of entity fields */
332 } prog_header;
333
334 /*
335  * Each paramater incerements by 3 since vector types hold
336  * 3 components (x,y,z).
337  */
338 #define OFS_NULL      0
339 #define OFS_RETURN    1
340 #define OFS_PARM0     (OFS_RETURN+3)
341 #define OFS_PARM1     (OFS_PARM0 +3)
342 #define OFS_PARM2     (OFS_PARM1 +3)
343 #define OFS_PARM3     (OFS_PARM2 +3)
344 #define OFS_PARM4     (OFS_PARM3 +3)
345 #define OFS_PARM5     (OFS_PARM4 +3)
346 #define OFS_PARM6     (OFS_PARM5 +3)
347 #define OFS_PARM7     (OFS_PARM6 +3)
348
349 typedef struct {
350     uint16_t opcode;
351
352     /* operand 1 */
353     union {
354         int16_t  s1; /* signed   */
355         uint16_t u1; /* unsigned */
356     } o1;
357     /* operand 2 */
358     union {
359         int16_t  s1; /* signed   */
360         uint16_t u1; /* unsigned */
361     } o2;
362     /* operand 3 */
363     union {
364         int16_t  s1; /* signed   */
365         uint16_t u1; /* unsigned */
366     } o3;
367
368     /*
369      * This is the same as the structure in darkplaces
370      * {
371      *     unsigned short op;
372      *     short          a,b,c;
373      * }
374      * But this one is more sane to work with, and the
375      * type sizes are guranteed.
376      */
377 } prog_section_statement;
378
379 typedef struct {
380     /* The types:
381      * 0 = ev_void
382      * 1 = ev_string
383      * 2 = ev_float
384      * 3 = ev_vector
385      * 4 = ev_entity
386      * 5 = ev_field
387      * 6 = ev_function
388      * 7 = ev_pointer -- engine only
389      * 8 = ev_bad     -- engine only
390      */
391     uint16_t type;
392     uint16_t offset;
393     uint32_t name;
394 } prog_section_both;
395 typedef prog_section_both prog_section_def;
396 typedef prog_section_both prog_section_field;
397
398 /* this is ORed to the type */
399 #define DEF_SAVEGLOBAL (1<<15)
400 #define DEF_TYPEMASK   ((1<<15)-1)
401
402 typedef struct {
403     int32_t   entry;      /* in statement table for instructions  */
404     uint32_t  firstlocal; /* First local in local table           */
405     uint32_t  locals;     /* Total ints of params + locals        */
406     uint32_t  profile;    /* Always zero (engine uses this)       */
407     uint32_t  name;       /* name of function in string table     */
408     uint32_t  file;       /* file of the source file              */
409     uint32_t  nargs;      /* number of arguments                  */
410     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
411 } prog_section_function;
412
413 /*
414  * Instructions
415  * These are the external instructions supported by the interperter
416  * this is what things compile to (from the C code).
417  */
418 enum {
419     INSTR_DONE,
420     INSTR_MUL_F,
421     INSTR_MUL_V,
422     INSTR_MUL_FV, /* NOTE: the float operands must NOT be at the same locations: A != C */
423     INSTR_MUL_VF, /* and here: B != C */
424     INSTR_DIV_F,
425     INSTR_ADD_F,
426     INSTR_ADD_V,
427     INSTR_SUB_F,
428     INSTR_SUB_V,
429     INSTR_EQ_F,
430     INSTR_EQ_V,
431     INSTR_EQ_S,
432     INSTR_EQ_E,
433     INSTR_EQ_FNC,
434     INSTR_NE_F,
435     INSTR_NE_V,
436     INSTR_NE_S,
437     INSTR_NE_E,
438     INSTR_NE_FNC,
439     INSTR_LE,
440     INSTR_GE,
441     INSTR_LT,
442     INSTR_GT,
443     INSTR_LOAD_F,
444     INSTR_LOAD_V,
445     INSTR_LOAD_S,
446     INSTR_LOAD_ENT,
447     INSTR_LOAD_FLD,
448     INSTR_LOAD_FNC,
449     INSTR_ADDRESS,
450     INSTR_STORE_F,
451     INSTR_STORE_V,
452     INSTR_STORE_S,
453     INSTR_STORE_ENT,
454     INSTR_STORE_FLD,
455     INSTR_STORE_FNC,
456     INSTR_STOREP_F,
457     INSTR_STOREP_V,
458     INSTR_STOREP_S,
459     INSTR_STOREP_ENT,
460     INSTR_STOREP_FLD,
461     INSTR_STOREP_FNC,
462     INSTR_RETURN,
463     INSTR_NOT_F,
464     INSTR_NOT_V,
465     INSTR_NOT_S,
466     INSTR_NOT_ENT,
467     INSTR_NOT_FNC,
468     INSTR_IF,
469     INSTR_IFNOT,
470     INSTR_CALL0,
471     INSTR_CALL1,
472     INSTR_CALL2,
473     INSTR_CALL3,
474     INSTR_CALL4,
475     INSTR_CALL5,
476     INSTR_CALL6,
477     INSTR_CALL7,
478     INSTR_CALL8,
479     INSTR_STATE,
480     INSTR_GOTO,
481     INSTR_AND,
482     INSTR_OR,
483     INSTR_BITAND,
484     INSTR_BITOR,
485
486     /*
487      * Virtual instructions used by the assembler
488      * keep at the end but before virtual instructions
489      * for the IR below.
490      */
491     AINSTR_END,
492
493     /*
494      * Virtual instructions used by the IR
495      * Keep at the end!
496      */
497     VINSTR_PHI,
498     VINSTR_JUMP,
499     VINSTR_COND
500 };
501
502 /*
503  * The symbols below are created by the following
504  * expanded macros:
505  *
506  * VECTOR_MAKE(prog_section_statement, code_statements);
507  * VECTOR_MAKE(prog_section_def,       code_defs      );
508  * VECTOR_MAKE(prog_section_field,     code_fields    );
509  * VECTOR_MAKE(prog_section_function,  code_functions );
510  * VECTOR_MAKE(int,                    code_globals   );
511  * VECTOR_MAKE(char,                   code_chars     );
512  */
513 VECTOR_PROT(prog_section_statement, code_statements);
514 VECTOR_PROT(prog_section_statement, code_statements);
515 VECTOR_PROT(prog_section_def,       code_defs      );
516 VECTOR_PROT(prog_section_field,     code_fields    );
517 VECTOR_PROT(prog_section_function,  code_functions );
518 VECTOR_PROT(int,                    code_globals   );
519 VECTOR_PROT(char,                   code_chars     );
520 extern uint16_t code_crc;
521
522 typedef float   qcfloat;
523 typedef int32_t qcint;
524
525 /*
526  * code_write -- writes out the compiled file
527  * code_init  -- prepares the code file
528  */
529 bool     code_write       (const char *filename);
530 void     code_init        ();
531 uint32_t code_genstring   (const char *string);
532 uint32_t code_cachedstring(const char *string);
533 qcint    code_alloc_field (size_t qcsize);
534
535 /*===================================================================*/
536 /*============================ con.c ================================*/
537 /*===================================================================*/
538 void con_close();
539 void con_color(int state);
540 void con_init ();
541 void con_reset();
542 int  con_change(const char *out, const char *err);
543 int  con_verr  (const char *fmt, va_list va);
544 int  con_vout  (const char *fmt, va_list va);
545 int  con_err   (const char *fmt, ...);
546 int  con_out   (const char *fmt, ...);
547
548 /*===================================================================*/
549 /*========================= assembler.c =============================*/
550 /*===================================================================*/
551 static const struct {
552     const char  *m; /* menomic     */
553     const size_t o; /* operands    */
554     const size_t l; /* menomic len */
555 } asm_instr[] = {
556     { "DONE"      , 1, 4 },
557     { "MUL_F"     , 3, 5 },
558     { "MUL_V"     , 3, 5 },
559     { "MUL_FV"    , 3, 6 },
560     { "MUL_VF"    , 3, 6 },
561     { "DIV"       , 0, 3 },
562     { "ADD_F"     , 3, 5 },
563     { "ADD_V"     , 3, 5 },
564     { "SUB_F"     , 3, 5 },
565     { "SUB_V"     , 3, 5 },
566     { "EQ_F"      , 0, 4 },
567     { "EQ_V"      , 0, 4 },
568     { "EQ_S"      , 0, 4 },
569     { "EQ_E"      , 0, 4 },
570     { "EQ_FNC"    , 0, 6 },
571     { "NE_F"      , 0, 4 },
572     { "NE_V"      , 0, 4 },
573     { "NE_S"      , 0, 4 },
574     { "NE_E"      , 0, 4 },
575     { "NE_FNC"    , 0, 6 },
576     { "LE"        , 0, 2 },
577     { "GE"        , 0, 2 },
578     { "LT"        , 0, 2 },
579     { "GT"        , 0, 2 },
580     { "FIELD_F"   , 0, 7 },
581     { "FIELD_V"   , 0, 7 },
582     { "FIELD_S"   , 0, 7 },
583     { "FIELD_ENT" , 0, 9 },
584     { "FIELD_FLD" , 0, 9 },
585     { "FIELD_FNC" , 0, 9 },
586     { "ADDRESS"   , 0, 7 },
587     { "STORE_F"   , 0, 7 },
588     { "STORE_V"   , 0, 7 },
589     { "STORE_S"   , 0, 7 },
590     { "STORE_ENT" , 0, 9 },
591     { "STORE_FLD" , 0, 9 },
592     { "STORE_FNC" , 0, 9 },
593     { "STOREP_F"  , 0, 8 },
594     { "STOREP_V"  , 0, 8 },
595     { "STOREP_S"  , 0, 8 },
596     { "STOREP_ENT", 0, 10},
597     { "STOREP_FLD", 0, 10},
598     { "STOREP_FNC", 0, 10},
599     { "RETURN"    , 0, 6 },
600     { "NOT_F"     , 0, 5 },
601     { "NOT_V"     , 0, 5 },
602     { "NOT_S"     , 0, 5 },
603     { "NOT_ENT"   , 0, 7 },
604     { "NOT_FNC"   , 0, 7 },
605     { "IF"        , 0, 2 },
606     { "IFNOT"     , 0, 5 },
607     { "CALL0"     , 1, 5 },
608     { "CALL1"     , 2, 5 },
609     { "CALL2"     , 3, 5 },
610     { "CALL3"     , 4, 5 },
611     { "CALL4"     , 5, 5 },
612     { "CALL5"     , 6, 5 },
613     { "CALL6"     , 7, 5 },
614     { "CALL7"     , 8, 5 },
615     { "CALL8"     , 9, 5 },
616     { "STATE"     , 0, 5 },
617     { "GOTO"      , 0, 4 },
618     { "AND"       , 0, 3 },
619     { "OR"        , 0, 2 },
620     { "BITAND"    , 0, 6 },
621     { "BITOR"     , 0, 5 },
622
623     { "END"       , 0, 3 } /* virtual assembler instruction */
624 };
625 /*===================================================================*/
626 /*============================= ast.c ===============================*/
627 /*===================================================================*/
628 #define MEM_VECTOR_PROTO(Towner, Tmem, mem)                   \
629     bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem);      \
630     bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t)
631
632 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem)                    \
633     MEM_VECTOR_PROTO(Towner, Tmem, mem);                           \
634     bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
635     void Towner##_##mem##_clear(Towner*)
636
637 #define MEM_VECTOR_MAKE(Twhat, name) \
638     Twhat  *name;                    \
639     size_t name##_count;             \
640     size_t name##_alloc
641
642 #define MEM_VEC_FUN_ADD(Tself, Twhat, mem)                           \
643 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f)            \
644 {                                                                    \
645     Twhat *reall;                                                    \
646     if (self->mem##_count == self->mem##_alloc) {                    \
647         if (!self->mem##_alloc) {                                    \
648             self->mem##_alloc = 16;                                  \
649         } else {                                                     \
650             self->mem##_alloc *= 2;                                  \
651         }                                                            \
652         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc);    \
653         if (!reall) {                                                \
654             return false;                                            \
655         }                                                            \
656         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
657         mem_d(self->mem);                                            \
658         self->mem = reall;                                           \
659     }                                                                \
660     self->mem[self->mem##_count++] = f;                              \
661     return true;                                                     \
662 }
663
664 #define MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)                        \
665 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx)      \
666 {                                                                    \
667     size_t i;                                                        \
668     Twhat *reall;                                                    \
669     if (idx >= self->mem##_count) {                                  \
670         return true; /* huh... */                                    \
671     }                                                                \
672     for (i = idx; i < self->mem##_count-1; ++i) {                    \
673         self->mem[i] = self->mem[i+1];                               \
674     }                                                                \
675     self->mem##_count--;                                             \
676     if (self->mem##_count < self->mem##_count/2) {                   \
677         self->mem##_alloc /= 2;                                      \
678         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count);    \
679         if (!reall) {                                                \
680             return false;                                            \
681         }                                                            \
682         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
683         mem_d(self->mem);                                            \
684         self->mem = reall;                                           \
685     }                                                                \
686     return true;                                                     \
687 }
688
689 #define MEM_VEC_FUN_FIND(Tself, Twhat, mem)                     \
690 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
691 {                                                               \
692     size_t i;                                                   \
693     for (i = 0; i < self->mem##_count; ++i) {                   \
694         if (self->mem[i] == obj) {                              \
695             if (idx) {                                          \
696                 *idx = i;                                       \
697             }                                                   \
698             return true;                                        \
699         }                                                       \
700     }                                                           \
701     return false;                                               \
702 }
703
704 #define MEM_VEC_FUN_APPEND(Tself, Twhat, mem)                        \
705 bool GMQCC_WARN Tself##_##mem##_append(Tself *s, Twhat *p, size_t c) \
706 {                                                                    \
707     Twhat *reall;                                                    \
708     size_t oldalloc;                                                 \
709     if (s->mem##_count+c > s->mem##_alloc) {                         \
710         if (!s->mem##_alloc) {                                       \
711             s->mem##_alloc = c < 16 ? 16 : c;                        \
712             s->mem = (Twhat*)mem_a(sizeof(Twhat) * s->mem##_alloc);  \
713         } else {                                                     \
714             oldalloc = s->mem##_alloc;                               \
715             s->mem##_alloc *= 2;                                     \
716             if (s->mem##_count+c >= s->mem##_alloc) {                \
717                 s->mem##_alloc = s->mem##_count+c;                   \
718             }                                                        \
719             reall = (Twhat*)mem_a(sizeof(Twhat) * s->mem##_alloc);   \
720             if (!reall) {                                            \
721                 s->mem##_alloc = oldalloc;                           \
722                 return false;                                        \
723             }                                                        \
724             memcpy(reall, s->mem, sizeof(Twhat) * s->mem##_count);   \
725             mem_d(s->mem);                                           \
726             s->mem = reall;                                          \
727         }                                                            \
728     }                                                                \
729     memcpy(&s->mem[s->mem##_count], p, c*sizeof(*p));                \
730     s->mem##_count += c;                                             \
731     return true;                                                     \
732 }
733
734 #define MEM_VEC_FUN_RESIZE(Tself, Twhat, mem)                    \
735 bool GMQCC_WARN Tself##_##mem##_resize(Tself *s, size_t c)       \
736 {                                                                \
737     Twhat *reall;                                                \
738     if (c > s->mem##_alloc) {                                    \
739         reall = (Twhat*)mem_a(sizeof(Twhat) * c);                \
740         if (!reall) { return false; }                            \
741         memcpy(reall, s->mem, sizeof(Twhat) * s->mem##_count);   \
742         s->mem##_alloc = c;                                      \
743         s->mem##_count = c;                                      \
744         mem_d(s->mem);                                           \
745         s->mem = reall;                                          \
746         return true;                                             \
747     }                                                            \
748     s->mem##_count = c;                                          \
749     if (c < (s->mem##_alloc / 2)) {                              \
750         reall = (Twhat*)mem_a(sizeof(Twhat) * c);                \
751         if (!reall) { return false; }                            \
752         memcpy(reall, s->mem, sizeof(Twhat) * c);                \
753         mem_d(s->mem);                                           \
754         s->mem = reall;                                          \
755         s->mem##_alloc = c;                                      \
756     }                                                            \
757     return true;                                                 \
758 }
759
760 #define MEM_VEC_FUN_CLEAR(Tself, mem)   \
761 void Tself##_##mem##_clear(Tself *self) \
762 {                                       \
763     if (!self->mem)                     \
764         return;                         \
765     mem_d((void*) self->mem);           \
766     self->mem = NULL;                   \
767     self->mem##_count = 0;              \
768     self->mem##_alloc = 0;              \
769 }
770
771 #define MEM_VECTOR_CLEAR(owner, mem)  \
772     if ((owner)->mem)                 \
773         mem_d((void*)((owner)->mem)); \
774     (owner)->mem = NULL;              \
775     (owner)->mem##_count = 0;         \
776     (owner)->mem##_alloc = 0
777
778 #define MEM_VECTOR_INIT(owner, mem) \
779 {                                   \
780     (owner)->mem = NULL;            \
781     (owner)->mem##_count = 0;       \
782     (owner)->mem##_alloc = 0;       \
783 }
784
785 #define MEM_VECTOR_MOVE(from, mem, to, tm)   \
786 {                                            \
787     (to)->tm = (from)->mem;                  \
788     (to)->tm##_count = (from)->mem##_count;  \
789     (to)->tm##_alloc = (from)->mem##_alloc;  \
790     (from)->mem = NULL;                      \
791     (from)->mem##_count = 0;                 \
792     (from)->mem##_alloc = 0;                 \
793 }
794
795 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
796 MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)        \
797 MEM_VEC_FUN_ADD(Tself, Twhat, mem)
798
799 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
800 MEM_VEC_FUNCTIONS(Tself, Twhat, mem)             \
801 MEM_VEC_FUN_CLEAR(Tself, mem)                    \
802 MEM_VEC_FUN_FIND(Tself, Twhat, mem)
803
804 enum store_types {
805     store_global,
806     store_local,  /* local, assignable for now, should get promoted later */
807     store_param,  /* parameters, they are locals with a fixed position */
808     store_value,  /* unassignable */
809     store_return  /* unassignable, at OFS_RETURN */
810 };
811
812 typedef struct {
813     qcfloat x, y, z;
814 } vector;
815
816 vector  vec3_add  (vector, vector);
817 vector  vec3_sub  (vector, vector);
818 qcfloat vec3_mulvv(vector, vector);
819 vector  vec3_mulvf(vector, float);
820
821 /*
822  * A shallow copy of a lex_file to remember where which ast node
823  * came from.
824  */
825 typedef struct {
826     const char *file;
827     size_t      line;
828 } lex_ctx;
829
830 /*===================================================================*/
831 /*============================= exec.c ==============================*/
832 /*===================================================================*/
833
834 /* darkplaces has (or will have) a 64 bit prog loader
835  * where the 32 bit qc program is autoconverted on load.
836  * Since we may want to support that as well, let's redefine
837  * float and int here.
838  */
839 typedef union {
840     qcint   _int;
841     qcint    string;
842     qcint    function;
843     qcint    edict;
844     qcfloat _float;
845     qcfloat vector[3];
846     qcint   ivector[3];
847 } qcany;
848
849 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
850 typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
851
852 enum {
853     VMERR_OK,
854     VMERR_TEMPSTRING_ALLOC,
855
856     VMERR_END
857 };
858
859 #define VM_JUMPS_DEFAULT 1000000
860
861 /* execute-flags */
862 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
863 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
864 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
865
866 struct qc_program_s;
867
868 typedef int (*prog_builtin)(struct qc_program_s *prog);
869
870 typedef struct {
871     qcint                  stmt;
872     size_t                 localsp;
873     prog_section_function *function;
874 } qc_exec_stack;
875
876 typedef struct qc_program_s {
877     char           *filename;
878
879     MEM_VECTOR_MAKE(prog_section_statement, code);
880     MEM_VECTOR_MAKE(prog_section_def,       defs);
881     MEM_VECTOR_MAKE(prog_section_def,       fields);
882     MEM_VECTOR_MAKE(prog_section_function,  functions);
883     MEM_VECTOR_MAKE(char,                   strings);
884     MEM_VECTOR_MAKE(qcint,                  globals);
885     MEM_VECTOR_MAKE(qcint,                  entitydata);
886     MEM_VECTOR_MAKE(bool,                   entitypool);
887
888     MEM_VECTOR_MAKE(const char*,            function_stack);
889
890     uint16_t crc16;
891
892     size_t tempstring_start;
893     size_t tempstring_at;
894
895     qcint  vmerror;
896
897     MEM_VECTOR_MAKE(size_t, profile);
898
899     MEM_VECTOR_MAKE(prog_builtin, builtins);
900
901     /* size_t ip; */
902     qcint  entities;
903     size_t entityfields;
904     bool   allowworldwrites;
905
906     MEM_VECTOR_MAKE(qcint,         localstack);
907     MEM_VECTOR_MAKE(qc_exec_stack, stack);
908     size_t statement;
909
910     size_t xflags;
911
912     int    argc; /* current arg count for debugging */
913 } qc_program;
914
915 qc_program* prog_load(const char *filename);
916 void        prog_delete(qc_program *prog);
917
918 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
919
920 char*             prog_getstring (qc_program *prog, qcint str);
921 prog_section_def* prog_entfield  (qc_program *prog, qcint off);
922 prog_section_def* prog_getdef    (qc_program *prog, qcint off);
923 qcany*            prog_getedict  (qc_program *prog, qcint e);
924 qcint             prog_tempstring(qc_program *prog, const char *_str);
925
926 /*===================================================================*/
927 /*===================== error.c message printer =====================*/
928 /*===================================================================*/
929
930 #ifndef WIN32
931 enum {
932     CON_BLACK   = 30,
933     CON_RED,
934     CON_GREEN,
935     CON_BROWN,
936     CON_BLUE,
937     CON_MAGENTA,
938     CON_CYAN ,
939     CON_WHITE
940 };
941 #endif
942 enum {
943     LVL_MSG,
944     LVL_WARNING,
945     LVL_ERROR
946 };
947
948 void vprintmsg (int level, const char *name, size_t line, const char *msgtype, const char *msg, va_list ap);
949 void printmsg  (int level, const char *name, size_t line, const char *msgtype, const char *msg, ...);
950 void cvprintmsg(lex_ctx ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
951 void cprintmsg (lex_ctx ctx, int lvl, const char *msgtype, const char *msg, ...);
952
953 /*===================================================================*/
954 /*===================== parser.c commandline ========================*/
955 /*===================================================================*/
956
957 bool parser_init          ();
958 bool parser_compile_file  (const char *filename);
959 bool parser_compile_string(const char *name, const char *str);
960 bool parser_finish        (const char *output);
961 void parser_cleanup       ();
962
963 /*===================================================================*/
964 /*======================= main.c commandline ========================*/
965 /*===================================================================*/
966
967 #if 0
968 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
969  * to 32 or 64 -f options...
970  */
971 typedef struct {
972     size_t  idx; /* index into an array of 32 bit words */
973     uint8_t bit; /* index _into_ the 32 bit word, thus just uint8 */
974 } longbit;
975 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
976 #else
977 typedef uint32_t longbit;
978 #define LONGBIT(bit) (bit)
979 #endif
980
981 /* Used to store the list of flags with names */
982 typedef struct {
983     const char *name;
984     longbit    bit;
985 } opts_flag_def;
986
987 /*===================================================================*/
988 /* list of -f flags, like -fdarkplaces-string-table-bug */
989 enum {
990 # define GMQCC_TYPE_FLAGS
991 # define GMQCC_DEFINE_FLAG(X) X,
992 #  include "opts.def"
993     COUNT_FLAGS
994 };
995 static const opts_flag_def opts_flag_list[] = {
996 # define GMQCC_TYPE_FLAGS
997 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
998 #  include "opts.def"
999     { NULL, LONGBIT(0) }
1000 };
1001
1002 enum {
1003 # define GMQCC_TYPE_WARNS
1004 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
1005 #  include "opts.def"
1006     COUNT_WARNINGS
1007 };
1008 static const opts_flag_def opts_warn_list[] = {
1009 # define GMQCC_TYPE_WARNS
1010 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
1011 #  include "opts.def"
1012     { NULL, LONGBIT(0) }
1013 };
1014
1015 /* other options: */
1016 enum {
1017     COMPILER_QCC,     /* circa  QuakeC */
1018     COMPILER_FTEQCC,  /* fteqcc QuakeC */
1019     COMPILER_QCCX,    /* qccx   QuakeC */
1020     COMPILER_GMQCC    /* this   QuakeC */
1021 };
1022 extern uint32_t    opts_O;      /* -Ox */
1023 extern const char *opts_output; /* -o file */
1024 extern int         opts_standard;
1025 extern bool        opts_debug;
1026 extern bool        opts_memchk;
1027 extern bool        opts_dump;
1028 extern bool        opts_werror;
1029 extern bool        opts_forcecrc;
1030 extern uint16_t    opts_forced_crc;
1031 extern bool        opts_pp_only;
1032 extern size_t      opts_max_array_size;
1033
1034 /*===================================================================*/
1035 #define OPTS_FLAG(i) (!! (opts_flags[(i)/32] & (1<< ((i)%32))))
1036 extern uint32_t opts_flags[1 + (COUNT_FLAGS / 32)];
1037 #define OPTS_WARN(i) (!! (opts_warn[(i)/32] & (1<< ((i)%32))))
1038 extern uint32_t opts_warn[1 + (COUNT_WARNINGS / 32)];
1039
1040 #endif