]> git.xonotic.org Git - xonotic/gmqcc.git/blob - gmqcc.h
exec.h -> gmqcc.h
[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 <ctype.h>
30
31 #define GMQCC_VERSION_MAJOR 0
32 #define GMQCC_VERSION_MINOR 1
33 #define GMQCC_VERSION_PATCH 0
34 #define GMQCC_VERSION_BUILD(J,N,P) (((J)<<16)|((N)<<8)|(P))
35 #define GMQCC_VERSION \
36     GMQCC_VERSION_BUILD(GMQCC_VERSION_MAJOR, GMQCC_VERSION_MINOR, GMQCC_VERSION_PATCH)
37
38 /*
39  * We cannoy rely on C99 at all, since compilers like MSVC
40  * simply don't support it.  We define our own boolean type
41  * as a result (since we cannot include <stdbool.h>). For
42  * compilers that are in 1999 mode (C99 compliant) we can use
43  * the language keyword _Bool which can allow for better code
44  * on GCC and GCC-like compilers, opposed to `int`.
45  */
46 #ifndef __cplusplus
47 #   ifdef  false
48 #       undef  false
49 #   endif /* !false */
50 #   ifdef  true
51 #       undef true
52 #   endif /* !true  */
53 #   define false (0)
54 #   define true  (1)
55 #   ifdef __STDC_VERSION__
56 #       if __STDC_VERSION__ < 199901L && __GNUC__ < 3
57             typedef int  bool;
58 #       else
59             typedef _Bool bool;
60 #       endif
61 #   else
62         typedef int bool;
63 #   endif /* !__STDC_VERSION__ */
64 #endif    /* !__cplusplus      */
65
66 /*
67  * Of some functions which are generated we want to make sure
68  * that the result isn't ignored. To find such function calls,
69  * we use this macro.
70  */
71 #if defined(__GNUC__) || defined(__CLANG__)
72 #   define GMQCC_WARN __attribute__((warn_unused_result))
73 #else
74 #   define GMQCC_WARN
75 #endif
76 /*
77  * This is a hack to silent clang regarding empty
78  * body if statements.
79  */
80 #define GMQCC_SUPRESS_EMPTY_BODY do { } while (0)
81
82 /*
83  * Inline is not supported in < C90, however some compilers
84  * like gcc and clang might have an inline attribute we can
85  * use if present.
86  */
87 #ifdef __STDC_VERSION__
88 #    if __STDC_VERSION__ < 199901L
89 #       if defined(__GNUC__) || defined (__CLANG__)
90 #           if __GNUC__ < 2
91 #               define GMQCC_INLINE
92 #           else
93 #               define GMQCC_INLINE __attribute__ ((always_inline))
94 #           endif
95 #       else
96 #           define GMQCC_INLINE
97 #       endif
98 #    else
99 #       define GMQCC_INLINE inline
100 #    endif
101 #else
102 #    define GMQCC_INLINE
103 #endif /* !__STDC_VERSION__ */
104
105 /*
106  * noreturn is present in GCC and clang
107  * it's required for _ast_node_destory otherwise -Wmissing-noreturn
108  * in clang complains about there being no return since abort() is
109  * called.
110  */
111 #if (defined(__GNUC__) && __GNUC__ >= 2) || defined(__CLANG__)
112 #    define GMQCC_NORETURN __attribute__ ((noreturn))
113 #else
114 #    define GMQCC_NORETURN
115 #endif
116
117 /*
118  * stdint.h and inttypes.h -less subset
119  * for systems that don't have it, which we must
120  * assume is all systems. (int8_t not required)
121  */
122 #if   CHAR_MIN  == -128
123     typedef unsigned char  uint8_t; /* same as below */
124 #elif SCHAR_MIN == -128
125     typedef unsigned char  uint8_t; /* same as above */
126 #endif
127 #if   SHRT_MAX  == 0x7FFF
128     typedef short          int16_t;
129     typedef unsigned short uint16_t;
130 #elif INT_MAX   == 0x7FFF
131     typedef int            int16_t;
132     typedef unsigned int   uint16_t;
133 #endif
134 #if   INT_MAX   == 0x7FFFFFFF
135     typedef int            int32_t;
136     typedef unsigned int   uint32_t;
137     typedef long           int64_t;
138     typedef unsigned long  uint64_t;
139 #elif LONG_MAX  == 0x7FFFFFFF
140     typedef long           int32_t;
141     typedef unsigned long  uint32_t;
142
143     /*
144      * It's nearly impossible to figure out a 64bit type at
145      * this point without making assumptions about the build
146      * enviroment.  So if clang or gcc is detected use some
147      * compiler builtins to create a 64 signed and unsigned
148      * type.
149      */
150 #   if defined(__GNUC__) || defined (__CLANG__)
151         typedef int          int64_t  __attribute__((__mode__(__DI__)));
152         typedef unsigned int uint64_t __attribute__((__mode__(__DI__)));
153 #   else
154         /*
155          * Incoorectly size the types so static assertions below will
156          * fail.  There is no valid way to get a 64bit type at this point
157          * without making assumptions of too many things.
158          */
159         typedef struct { char _fail : 0; } int64_t;
160         typedef struct { char _fail : 0; } uint64_t;
161 #   endif
162 #endif
163 #ifdef _LP64 /* long pointer == 64 */
164     typedef unsigned long  uintptr_t;
165     typedef long           intptr_t;
166 #else
167     typedef unsigned int   uintptr_t;
168     typedef int            intptr_t;
169 #endif
170 /* Ensure type sizes are correct: */
171 typedef char uint8_size_is_correct  [sizeof(uint8_t)  == 1?1:-1];
172 typedef char uint16_size_is_correct [sizeof(uint16_t) == 2?1:-1];
173 typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
174 typedef char uint64_size_is_correct [sizeof(uint64_t) == 8?1:-1];
175 typedef char int16_size_if_correct  [sizeof(int16_t)  == 2?1:-1];
176 typedef char int32_size_is_correct  [sizeof(int32_t)  == 4?1:-1];
177 typedef char int64_size_is_correct  [sizeof(int64_t)  == 8?1:-1];
178 /* intptr_t / uintptr_t correct size check */
179 typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
180 typedef char intptr_size_is_correct [sizeof(uintptr_t)== sizeof(int*)?1:-1];
181
182 /*===================================================================*/
183 /*============================ lex.c ================================*/
184 /*===================================================================*/
185 typedef struct lex_file_t {
186     FILE *file;        /* file handler */
187     char *name;        /* name of file */
188     char  peek  [5];
189     char  lastok[8192];
190
191     int   last;    /* last token                   */
192     int   current; /* current token                */
193     int   length;  /* bytes left to parse          */
194     int   size;    /* never changes (size of file) */
195     int   line;    /* what line are we on?         */
196 } lex_file;
197
198 /*
199  * It's important that this table never exceed 32 keywords, the ascii
200  * table starts at 33 (and we don't want conflicts)
201  */
202 enum {
203     TOKEN_DO       ,
204     TOKEN_ELSE     ,
205     TOKEN_IF       ,
206     TOKEN_WHILE    ,
207     TOKEN_BREAK    ,
208     TOKEN_CONTINUE ,
209     TOKEN_RETURN   ,
210     TOKEN_GOTO     ,
211     TOKEN_FOR      ,   /* extension */
212     TOKEN_TYPEDEF  ,   /* extension */
213
214     /* ensure the token types are out of the  */
215     /* bounds of anyothers that may conflict. */
216     TOKEN_FLOAT    = 110,
217     TOKEN_VECTOR        ,
218     TOKEN_STRING        ,
219     TOKEN_ENTITY        ,
220     TOKEN_VOID
221 };
222
223 /*
224  * Lexer state constants, these are numbers for where exactly in
225  * the lexing the lexer is at. Or where it decided to stop if a lexer
226  * error occurs.  These numbers must be > where the ascii-table ends
227  * and > the last type token which is TOKEN_VOID
228  */
229 enum {
230     LEX_COMMENT = 1128,
231     LEX_CHRLIT        ,
232     LEX_STRLIT        ,
233     LEX_IDENT
234 };
235
236 int       lex_token  (lex_file *);
237 void      lex_reset  (lex_file *);
238 void      lex_close  (lex_file *);
239 void      lex_parse  (lex_file *);
240 lex_file *lex_include(lex_file *, const char *);
241 void      lex_init   (const char *, lex_file **);
242
243 /*===================================================================*/
244 /*========================== error.c ================================*/
245 /*===================================================================*/
246 #define ERROR_LEX      (SHRT_MAX+0)
247 #define ERROR_PARSE    (SHRT_MAX+1)
248 #define ERROR_INTERNAL (SHRT_MAX+2)
249 #define ERROR_COMPILER (SHRT_MAX+3)
250 #define ERROR_PREPRO   (SHRT_MAX+4)
251 int error(lex_file *, int, const char *, ...);
252
253 /*===================================================================*/
254 /*========================== parse.c ================================*/
255 /*===================================================================*/
256 int parse_gen(lex_file *);
257
258 /*===================================================================*/
259 /*========================== typedef.c ==============================*/
260 /*===================================================================*/
261 typedef struct typedef_node_t {
262     char      *name;
263 } typedef_node;
264
265 void          typedef_init();
266 void          typedef_clear();
267 typedef_node *typedef_find(const char *);
268 int           typedef_add (lex_file *file, const char *, const char *);
269
270
271 /*===================================================================*/
272 /*=========================== util.c ================================*/
273 /*===================================================================*/
274 void *util_memory_a      (unsigned int, unsigned int, const char *);
275 void  util_memory_d      (void       *, unsigned int, const char *);
276 void  util_meminfo       ();
277
278 bool  util_strupper      (const char *);
279 bool  util_strdigit      (const char *);
280 bool  util_strncmpexact  (const char *, const char *, size_t);
281 char *util_strdup        (const char *);
282 char *util_strrq         (const char *);
283 char *util_strrnl        (const char *);
284 char *util_strsws        (const char *);
285 char *util_strchp        (const char *, const char *);
286 void  util_debug         (const char *, const char *, ...);
287 int   util_getline       (char **, size_t *, FILE *);
288 void  util_endianswap    (void *,  int, int);
289
290 uint32_t util_crc32(const char *, int, register const short);
291
292 #ifdef NOTRACK
293 #    define mem_a(x) malloc(x)
294 #    define mem_d(x) free  (x)
295 #else
296 #    define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
297 #    define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
298 #endif
299
300 /*
301  * TODO: make these safer to use.  Currently this only works on
302  * x86 and x86_64, some systems will likely not like this. Such
303  * as BE systems.
304  */
305 #define FLT2INT(Y) *((int32_t*)&(Y))
306 #define INT2FLT(Y) *((float  *)&(Y))
307
308 /* Builds vector type (usefull for inside structures) */
309 #define VECTOR_SNAP(X,Y) X ## Y
310 #define VECTOR_FILL(X,Y) VECTOR_SNAP(X,Y)
311 #define VECTOR_TYPE(T,N)                                        \
312     T*     N##_data      = NULL;                                \
313     long   N##_elements  = 0;                                   \
314     long   N##_allocated = 0
315 /* Builds vector add */
316 #define VECTOR_CORE(T,N)                                        \
317     int    N##_add(T element) {                                 \
318         void *temp = NULL;                                      \
319         if (N##_elements == N##_allocated) {                    \
320             if (N##_allocated == 0) {                           \
321                 N##_allocated = 12;                             \
322             } else {                                            \
323                 N##_allocated *= 2;                             \
324             }                                                   \
325             if  (!(temp = mem_a(N##_allocated * sizeof(T)))) {  \
326                 mem_d(temp);                                    \
327                 return -1;                                      \
328             }                                                   \
329             memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
330             mem_d(N##_data);                                    \
331             N##_data = (T*)temp;                                \
332         }                                                       \
333         N##_data[N##_elements] = element;                       \
334         return   N##_elements++;                                \
335     }                                                           \
336     int N##_put(T* elements, size_t len) {                      \
337         len     --;                                             \
338         elements--;                                             \
339         while (N##_add(*++elements) != -1 && len--);            \
340         return N##_elements;                                    \
341     }                                                           \
342     typedef char VECTOR_FILL(extra_semicolon_,__COUNTER__)
343 #define VECTOR_PROT(T,N)                                        \
344     extern T*     N##_data     ;                                \
345     extern long   N##_elements ;                                \
346     extern long   N##_allocated;                                \
347     int           N##_add(T);                                   \
348     int           N##_put(T *, size_t)
349 #define VECTOR_MAKE(T,N) \
350     VECTOR_TYPE(T,N);    \
351     VECTOR_CORE(T,N)
352
353 /*===================================================================*/
354 /*=========================== code.c ================================*/
355 /*===================================================================*/
356
357 /* Note: if you change the order, fix type_sizeof in ir.c */
358 enum {
359     TYPE_VOID     ,
360     TYPE_STRING   ,
361     TYPE_FLOAT    ,
362     TYPE_VECTOR   ,
363     TYPE_ENTITY   ,
364     TYPE_FIELD    ,
365     TYPE_FUNCTION ,
366     TYPE_POINTER  ,
367     /* TYPE_INTEGER  , */
368     TYPE_VARIANT  ,
369
370     TYPE_COUNT
371 };
372
373 extern size_t type_sizeof[TYPE_COUNT];
374
375 typedef struct {
376     uint32_t offset;      /* Offset in file of where data begins  */
377     uint32_t length;      /* Length of section (how many of)      */
378 } prog_section;
379
380 typedef struct {
381     uint32_t     version;      /* Program version (6)     */
382     uint16_t     crc16;        /* What is this?           */
383     uint16_t     skip;         /* see propsal.txt         */
384
385     prog_section statements;   /* prog_section_statement  */
386     prog_section defs;         /* prog_section_def        */
387     prog_section fields;       /* prog_section_field      */
388     prog_section functions;    /* prog_section_function   */
389     prog_section strings;      /* What is this?           */
390     prog_section globals;      /* What is this?           */
391     uint32_t     entfield;     /* Number of entity fields */
392 } prog_header;
393
394 /*
395  * Each paramater incerements by 3 since vector types hold
396  * 3 components (x,y,z).
397  */
398 #define OFS_NULL      0
399 #define OFS_RETURN    1
400 #define OFS_PARM0     (OFS_RETURN+3)
401 #define OFS_PARM1     (OFS_PARM0 +3)
402 #define OFS_PARM2     (OFS_PARM1 +3)
403 #define OFS_PARM3     (OFS_PARM2 +3)
404 #define OFS_PARM4     (OFS_PARM3 +3)
405 #define OFS_PARM5     (OFS_PARM4 +3)
406 #define OFS_PARM6     (OFS_PARM5 +3)
407 #define OFS_PARM7     (OFS_PARM6 +3)
408
409 typedef struct {
410     uint16_t opcode;
411
412     /* operand 1 */
413     union {
414         int16_t  s1; /* signed   */
415         uint16_t u1; /* unsigned */
416     } o1;
417     /* operand 2 */
418     union {
419         int16_t  s1; /* signed   */
420         uint16_t u1; /* unsigned */
421     } o2;
422     /* operand 3 */
423     union {
424         int16_t  s1; /* signed   */
425         uint16_t u1; /* unsigned */
426     } o3;
427
428     /*
429      * This is the same as the structure in darkplaces
430      * {
431      *     unsigned short op;
432      *     short          a,b,c;
433      * }
434      * But this one is more sane to work with, and the
435      * type sizes are guranteed.
436      */
437 } prog_section_statement;
438
439 typedef struct {
440     /* The types:
441      * 0 = ev_void
442      * 1 = ev_string
443      * 2 = ev_float
444      * 3 = ev_vector
445      * 4 = ev_entity
446      * 5 = ev_field
447      * 6 = ev_function
448      * 7 = ev_pointer -- engine only
449      * 8 = ev_bad     -- engine only
450      */
451     uint16_t type;
452     uint16_t offset;
453     uint32_t name;
454 } prog_section_both;
455 typedef prog_section_both prog_section_def;
456 typedef prog_section_both prog_section_field;
457
458 typedef struct {
459     int32_t   entry;      /* in statement table for instructions  */
460     uint32_t  firstlocal; /* First local in local table           */
461     uint32_t  locals;     /* Total ints of params + locals        */
462     uint32_t  profile;    /* Always zero (engine uses this)       */
463     uint32_t  name;       /* name of function in string table     */
464     uint32_t  file;       /* file of the source file              */
465     uint32_t  nargs;      /* number of arguments                  */
466     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
467 } prog_section_function;
468
469 /*
470  * Instructions
471  * These are the external instructions supported by the interperter
472  * this is what things compile to (from the C code).
473  */
474 enum {
475     INSTR_DONE,
476     INSTR_MUL_F,
477     INSTR_MUL_V,
478     INSTR_MUL_FV,
479     INSTR_MUL_VF,
480     INSTR_DIV_F,
481     INSTR_ADD_F,
482     INSTR_ADD_V,
483     INSTR_SUB_F,
484     INSTR_SUB_V,
485     INSTR_EQ_F,
486     INSTR_EQ_V,
487     INSTR_EQ_S,
488     INSTR_EQ_E,
489     INSTR_EQ_FNC,
490     INSTR_NE_F,
491     INSTR_NE_V,
492     INSTR_NE_S,
493     INSTR_NE_E,
494     INSTR_NE_FNC,
495     INSTR_LE,
496     INSTR_GE,
497     INSTR_LT,
498     INSTR_GT,
499     INSTR_LOAD_F,
500     INSTR_LOAD_V,
501     INSTR_LOAD_S,
502     INSTR_LOAD_ENT,
503     INSTR_LOAD_FLD,
504     INSTR_LOAD_FNC,
505     INSTR_ADDRESS,
506     INSTR_STORE_F,
507     INSTR_STORE_V,
508     INSTR_STORE_S,
509     INSTR_STORE_ENT,
510     INSTR_STORE_FLD,
511     INSTR_STORE_FNC,
512     INSTR_STOREP_F,
513     INSTR_STOREP_V,
514     INSTR_STOREP_S,
515     INSTR_STOREP_ENT,
516     INSTR_STOREP_FLD,
517     INSTR_STOREP_FNC,
518     INSTR_RETURN,
519     INSTR_NOT_F,
520     INSTR_NOT_V,
521     INSTR_NOT_S,
522     INSTR_NOT_ENT,
523     INSTR_NOT_FNC,
524     INSTR_IF,
525     INSTR_IFNOT,
526     INSTR_CALL0,
527     INSTR_CALL1,
528     INSTR_CALL2,
529     INSTR_CALL3,
530     INSTR_CALL4,
531     INSTR_CALL5,
532     INSTR_CALL6,
533     INSTR_CALL7,
534     INSTR_CALL8,
535     INSTR_STATE,
536     INSTR_GOTO,
537     INSTR_AND,
538     INSTR_OR,
539     INSTR_BITAND,
540     INSTR_BITOR,
541
542     /*
543      * Virtual instructions used by the assembler
544      * keep at the end but before virtual instructions
545      * for the IR below.
546      */
547     AINSTR_END,
548
549     /*
550      * Virtual instructions used by the IR
551      * Keep at the end!
552      */
553     VINSTR_PHI,
554     VINSTR_JUMP,
555     VINSTR_COND
556 };
557
558 /*
559  * The symbols below are created by the following
560  * expanded macros:
561  *
562  * VECTOR_MAKE(prog_section_statement, code_statements);
563  * VECTOR_MAKE(prog_section_def,       code_defs      );
564  * VECTOR_MAKE(prog_section_field,     code_fields    );
565  * VECTOR_MAKE(prog_section_function,  code_functions );
566  * VECTOR_MAKE(int,                    code_globals   );
567  * VECTOR_MAKE(char,                   code_chars     );
568  */
569 VECTOR_PROT(prog_section_statement, code_statements);
570 VECTOR_PROT(prog_section_statement, code_statements);
571 VECTOR_PROT(prog_section_def,       code_defs      );
572 VECTOR_PROT(prog_section_field,     code_fields    );
573 VECTOR_PROT(prog_section_function,  code_functions );
574 VECTOR_PROT(int,                    code_globals   );
575 VECTOR_PROT(char,                   code_chars     );
576
577 /*
578  * code_write -- writes out the compiled file
579  * code_init  -- prepares the code file
580  */
581 bool     code_write       (const char *filename);
582 void     code_init        ();
583 uint32_t code_genstring   (const char *string);
584 uint32_t code_cachedstring(const char *string);
585
586 /*===================================================================*/
587 /*========================= assembler.c =============================*/
588 /*===================================================================*/
589 static const struct {
590     const char  *m; /* menomic     */
591     const size_t o; /* operands    */
592     const size_t l; /* menomic len */
593 } asm_instr[] = {
594     { "DONE"      , 1, 4 },
595     { "MUL_F"     , 3, 5 },
596     { "MUL_V"     , 3, 5 },
597     { "MUL_FV"    , 3, 6 },
598     { "MUL_VF"    , 3, 6 },
599     { "DIV"       , 0, 3 },
600     { "ADD_F"     , 3, 5 },
601     { "ADD_V"     , 3, 5 },
602     { "SUB_F"     , 3, 5 },
603     { "DUB_V"     , 3, 5 },
604     { "EQ_F"      , 0, 4 },
605     { "EQ_V"      , 0, 4 },
606     { "EQ_S"      , 0, 4 },
607     { "EQ_E"      , 0, 4 },
608     { "ES_FNC"    , 0, 6 },
609     { "NE_F"      , 0, 4 },
610     { "NE_V"      , 0, 4 },
611     { "NE_S"      , 0, 4 },
612     { "NE_E"      , 0, 4 },
613     { "NE_FNC"    , 0, 6 },
614     { "LE"        , 0, 2 },
615     { "GE"        , 0, 2 },
616     { "LT"        , 0, 2 },
617     { "GT"        , 0, 2 },
618     { "FIELD_F"   , 0, 7 },
619     { "FIELD_V"   , 0, 7 },
620     { "FIELD_S"   , 0, 7 },
621     { "FIELD_ENT" , 0, 9 },
622     { "FIELD_FLD" , 0, 9 },
623     { "FIELD_FNC" , 0, 9 },
624     { "ADDRESS"   , 0, 7 },
625     { "STORE_F"   , 0, 7 },
626     { "STORE_V"   , 0, 7 },
627     { "STORE_S"   , 0, 7 },
628     { "STORE_ENT" , 0, 9 },
629     { "STORE_FLD" , 0, 9 },
630     { "STORE_FNC" , 0, 9 },
631     { "STOREP_F"  , 0, 8 },
632     { "STOREP_V"  , 0, 8 },
633     { "STOREP_S"  , 0, 8 },
634     { "STOREP_ENT", 0, 10},
635     { "STOREP_FLD", 0, 10},
636     { "STOREP_FNC", 0, 10},
637     { "RETURN"    , 0, 6 },
638     { "NOT_F"     , 0, 5 },
639     { "NOT_V"     , 0, 5 },
640     { "NOT_S"     , 0, 5 },
641     { "NOT_ENT"   , 0, 7 },
642     { "NOT_FNC"   , 0, 7 },
643     { "IF"        , 0, 2 },
644     { "IFNOT"     , 0, 5 },
645     { "CALL0"     , 1, 5 },
646     { "CALL1"     , 2, 5 },
647     { "CALL2"     , 3, 5 },
648     { "CALL3"     , 4, 5 },
649     { "CALL4"     , 5, 5 },
650     { "CALL5"     , 6, 5 },
651     { "CALL6"     , 7, 5 },
652     { "CALL7"     , 8, 5 },
653     { "CALL8"     , 9, 5 },
654     { "STATE"     , 0, 5 },
655     { "GOTO"      , 0, 4 },
656     { "AND"       , 0, 3 },
657     { "OR"        , 0, 2 },
658     { "BITAND"    , 0, 6 },
659     { "BITOR"     , 0, 5 },
660     { "END"       , 0, 3 } /* virtual assembler instruction */
661 };
662
663 void asm_init (const char *, FILE **);
664 void asm_close(FILE *);
665 void asm_parse(FILE *);
666 /*===================================================================*/
667 /*============================= main.c ==============================*/
668 /*===================================================================*/
669 enum {
670     COMPILER_QCC,     /* circa  QuakeC */
671     COMPILER_FTEQCC,  /* fteqcc QuakeC */
672     COMPILER_QCCX,    /* qccx   QuakeC */
673     COMPILER_GMQCC    /* this   QuakeC */
674 };
675 extern bool opts_debug;
676 extern bool opts_memchk;
677 extern bool opts_darkplaces_stringtablebug;
678 extern bool opts_omit_nullcode;
679 extern int  opts_compiler;
680 /*===================================================================*/
681 /*============================= ast.c ===============================*/
682 /*===================================================================*/
683 #define MEM_VECTOR_PROTO(Towner, Tmem, mem)                   \
684     bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem);      \
685     bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t)
686
687 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem)                    \
688     MEM_VECTOR_PROTO(Towner, Tmem, mem);                           \
689     bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
690     void Towner##_##mem##_clear(Towner*)
691
692 #define MEM_VECTOR_MAKE(Twhat, name) \
693     Twhat  *name;                    \
694     size_t name##_count;             \
695     size_t name##_alloc
696
697 #define _MEM_VEC_FUN_ADD(Tself, Twhat, mem)                          \
698 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f)            \
699 {                                                                    \
700     Twhat *reall;                                                    \
701     if (self->mem##_count == self->mem##_alloc) {                    \
702         if (!self->mem##_alloc) {                                    \
703             self->mem##_alloc = 16;                                  \
704         } else {                                                     \
705             self->mem##_alloc *= 2;                                  \
706         }                                                            \
707         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc);    \
708         if (!reall) {                                                \
709             return false;                                            \
710         }                                                            \
711         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
712         mem_d(self->mem);                                            \
713         self->mem = reall;                                           \
714     }                                                                \
715     self->mem[self->mem##_count++] = f;                              \
716     return true;                                                     \
717 }
718
719 #define _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)                       \
720 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx)      \
721 {                                                                    \
722     size_t i;                                                        \
723     Twhat *reall;                                                    \
724     if (idx >= self->mem##_count) {                                  \
725         return true; /* huh... */                                    \
726     }                                                                \
727     for (i = idx; i < self->mem##_count-1; ++i) {                    \
728         self->mem[i] = self->mem[i+1];                               \
729     }                                                                \
730     self->mem##_count--;                                             \
731     if (self->mem##_count < self->mem##_count/2) {                   \
732         self->mem##_alloc /= 2;                                      \
733         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count);    \
734         if (!reall) {                                                \
735             return false;                                            \
736         }                                                            \
737         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
738         mem_d(self->mem);                                            \
739         self->mem = reall;                                           \
740     }                                                                \
741     return true;                                                     \
742 }
743
744 #define _MEM_VEC_FUN_FIND(Tself, Twhat, mem)                    \
745 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
746 {                                                               \
747     size_t i;                                                   \
748     for (i = 0; i < self->mem##_count; ++i) {                   \
749         if (self->mem[i] == obj) {                              \
750             if (idx) {                                          \
751                 *idx = i;                                       \
752             }                                                   \
753             return true;                                        \
754         }                                                       \
755     }                                                           \
756     return false;                                               \
757 }
758
759 #define _MEM_VEC_FUN_APPEND(Tself, Twhat, mem)                       \
760 bool GMQCC_WARN Tself##_##mem##_append(Tself *s, Twhat *p, size_t c) \
761 {                                                                    \
762     Twhat *reall;                                                    \
763     if (s->mem##_count+c >= s->mem##_alloc) {                        \
764         if (!s->mem##_alloc) {                                       \
765             s->mem##_alloc = c < 16 ? 16 : c;                        \
766         } else {                                                     \
767             s->mem##_alloc *= 2;                                     \
768             if (s->mem##_count+c >= s->mem##_alloc) {                \
769                 s->mem##_alloc = s->mem##_count+c;                   \
770             }                                                        \
771         }                                                            \
772         reall = (Twhat*)mem_a(sizeof(Twhat) * s->mem##_alloc);       \
773         if (!reall) {                                                \
774             return false;                                            \
775         }                                                            \
776         memcpy(reall, s->mem, sizeof(Twhat) * s->mem##_count);       \
777         mem_d(s->mem);                                               \
778         s->mem = reall;                                              \
779     }                                                                \
780     memcpy(&s->mem[s->mem##_count], p, c*sizeof(*p));                \
781     s->mem##_count += c;                                             \
782     return true;                                                     \
783 }
784
785 #define _MEM_VEC_FUN_RESIZE(Tself, Twhat, mem)                   \
786 bool GMQCC_WARN Tself##_##mem##_resize(Tself *s, size_t c)       \
787 {                                                                \
788     Twhat *reall;                                                \
789     if (c > s->mem##_alloc) {                                    \
790         reall = (Twhat*)mem_a(sizeof(Twhat) * c);                \
791         if (!reall) { return false; }                            \
792         memcpy(reall, s->mem, sizeof(Twhat) * s->mem##_count);   \
793         s->mem##_alloc = c;                                      \
794         mem_d(s->mem);                                           \
795         s->mem = reall;                                          \
796         return true;                                             \
797     }                                                            \
798     s->mem##_count = c;                                          \
799     if (c < (s->mem##_alloc / 2)) {                              \
800         reall = (Twhat*)mem_a(sizeof(Twhat) * c);                \
801         if (!reall) { return false; }                            \
802         memcpy(reall, s->mem, sizeof(Twhat) * c);                \
803         mem_d(s->mem);                                           \
804         s->mem = reall;                                          \
805     }                                                            \
806     return true;                                                 \
807 }
808
809 #define _MEM_VEC_FUN_CLEAR(Tself, mem)  \
810 void Tself##_##mem##_clear(Tself *self) \
811 {                                       \
812     if (!self->mem)                     \
813         return;                         \
814     mem_d((void*) self->mem);           \
815     self->mem = NULL;                   \
816     self->mem##_count = 0;              \
817     self->mem##_alloc = 0;              \
818 }
819
820 #define MEM_VECTOR_CLEAR(owner, mem)  \
821     if ((owner)->mem)                 \
822         mem_d((void*)((owner)->mem)); \
823     (owner)->mem = NULL;              \
824     (owner)->mem##_count = 0;         \
825     (owner)->mem##_alloc = 0
826
827 #define MEM_VECTOR_INIT(owner, mem) \
828 {                                   \
829     (owner)->mem = NULL;            \
830     (owner)->mem##_count = 0;       \
831     (owner)->mem##_alloc = 0;       \
832 }
833
834 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
835 _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)       \
836 _MEM_VEC_FUN_ADD(Tself, Twhat, mem)
837
838 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
839 MEM_VEC_FUNCTIONS(Tself, Twhat, mem)             \
840 _MEM_VEC_FUN_CLEAR(Tself, mem)                   \
841 _MEM_VEC_FUN_FIND(Tself, Twhat, mem)
842
843 enum store_types {
844     store_global,
845     store_local,  /* local, assignable for now, should get promoted later */
846     store_value   /* unassignable */
847 };
848
849 typedef struct {
850     float x, y, z;
851 } vector;
852
853 /*
854  * A shallow copy of a lex_file to remember where which ast node
855  * came from.
856  */
857 typedef struct {
858     const char *file;
859     size_t      line;
860 } lex_ctx;
861
862 /*===================================================================*/
863 /*============================= exec.c ==============================*/
864 /*===================================================================*/
865
866 /* darkplaces has (or will have) a 64 bit prog loader
867  * where the 32 bit qc program is autoconverted on load.
868  * Since we may want to support that as well, let's redefine
869  * float and int here.
870  */
871 typedef float   qcfloat;
872 typedef int32_t qcint;
873
874 typedef union {
875     qcint   _int;
876     qcint    string;
877     qcint    function;
878     qcint    edict;
879     qcfloat _float;
880     qcfloat vector[3];
881     qcint   ivector[3];
882 } qcany;
883
884 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
885 typedef char qcint_size_is_correct   [sizeof(qcint)   == 4 ?1:-1];
886
887 enum {
888     VMERR_OK,
889     VMERR_TEMPSTRING_ALLOC,
890
891     VMERR_END
892 };
893
894 #define VM_JUMPS_DEFAULT 1000000
895
896 /* execute-flags */
897 #define VMXF_DEFAULT 0x0000     /* default flags - nothing */
898 #define VMXF_TRACE   0x0001     /* trace: print statements before executing */
899 #define VMXF_PROFILE 0x0002     /* profile: increment the profile counters */
900
901 struct qc_program_s;
902
903 typedef int (*prog_builtin)(struct qc_program_s *prog);
904
905 typedef struct {
906     qcint                  stmt;
907     size_t                 localsp;
908     prog_section_function *function;
909 } qc_exec_stack;
910
911 typedef struct qc_program_s {
912     char           *filename;
913
914     MEM_VECTOR_MAKE(prog_section_statement, code);
915     MEM_VECTOR_MAKE(prog_section_def,       defs);
916     MEM_VECTOR_MAKE(prog_section_def,       fields);
917     MEM_VECTOR_MAKE(prog_section_function,  functions);
918     MEM_VECTOR_MAKE(char,                   strings);
919     MEM_VECTOR_MAKE(qcint,                  globals);
920     MEM_VECTOR_MAKE(qcint,                  entitydata);
921
922     size_t tempstring_start;
923     size_t tempstring_at;
924
925     qcint  vmerror;
926
927     MEM_VECTOR_MAKE(size_t, profile);
928
929     MEM_VECTOR_MAKE(prog_builtin, builtins);
930
931     /* size_t ip; */
932     qcint  entities;
933     size_t entityfields;
934     bool   allowworldwrites;
935
936     MEM_VECTOR_MAKE(qcint,         localstack);
937     MEM_VECTOR_MAKE(qc_exec_stack, stack);
938     size_t statement;
939
940     int    argc; /* current arg count for debugging */
941 } qc_program;
942
943 qc_program* prog_load(const char *filename);
944 void        prog_delete(qc_program *prog);
945
946 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
947
948 char*             prog_getstring (qc_program *prog, qcint str);
949 prog_section_def* prog_entfield  (qc_program *prog, qcint off);
950 prog_section_def* prog_getdef    (qc_program *prog, qcint off);
951 qcany*            prog_getedict  (qc_program *prog, qcint e);
952 qcint             prog_tempstring(qc_program *prog, const char *_str);
953
954 #endif