]> git.xonotic.org Git - xonotic/gmqcc.git/blob - gmqcc.h
adding another storage type: store_return; when generating a CALL, the generator...
[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_SUPPRESS_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 /*
376  * Each paramater incerements by 3 since vector types hold
377  * 3 components (x,y,z).
378  */
379 #define OFS_NULL      0
380 #define OFS_RETURN    1
381 #define OFS_PARM0     (OFS_RETURN+3)
382 #define OFS_PARM1     (OFS_PARM0 +3)
383 #define OFS_PARM2     (OFS_PARM1 +3)
384 #define OFS_PARM3     (OFS_PARM2 +3)
385 #define OFS_PARM4     (OFS_PARM3 +3)
386 #define OFS_PARM5     (OFS_PARM4 +3)
387 #define OFS_PARM6     (OFS_PARM5 +3)
388 #define OFS_PARM7     (OFS_PARM6 +3)
389
390 typedef struct {
391     uint16_t opcode;
392
393     /* operand 1 */
394     union {
395         int16_t  s1; /* signed   */
396         uint16_t u1; /* unsigned */
397     } o1;
398     /* operand 2 */
399     union {
400         int16_t  s1; /* signed   */
401         uint16_t u1; /* unsigned */
402     } o2;
403     /* operand 3 */
404     union {
405         int16_t  s1; /* signed   */
406         uint16_t u1; /* unsigned */
407     } o3;
408
409     /*
410      * This is the same as the structure in darkplaces
411      * {
412      *     unsigned short op;
413      *     short          a,b,c;
414      * }
415      * But this one is more sane to work with, and the
416      * type sizes are guranteed.
417      */
418 } prog_section_statement;
419
420 typedef struct {
421     /* The types:
422      * 0 = ev_void
423      * 1 = ev_string
424      * 2 = ev_float
425      * 3 = ev_vector
426      * 4 = ev_entity
427      * 5 = ev_field
428      * 6 = ev_function
429      * 7 = ev_pointer -- engine only
430      * 8 = ev_bad     -- engine only
431      */
432     uint16_t type;
433     uint16_t offset;
434     uint32_t name;
435 } prog_section_both;
436 typedef prog_section_both prog_section_def;
437 typedef prog_section_both prog_section_field;
438
439 typedef struct {
440     int32_t   entry;      /* in statement table for instructions  */
441     uint32_t  firstlocal; /* First local in local table           */
442     uint32_t  locals;     /* Total ints of params + locals        */
443     uint32_t  profile;    /* Always zero (engine uses this)       */
444     uint32_t  name;       /* name of function in string table     */
445     uint32_t  file;       /* file of the source file              */
446     uint32_t  nargs;      /* number of arguments                  */
447     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
448 } prog_section_function;
449
450 /*
451  * Instructions
452  * These are the external instructions supported by the interperter
453  * this is what things compile to (from the C code).
454  */
455 enum {
456     INSTR_DONE,
457     INSTR_MUL_F,
458     INSTR_MUL_V,
459     INSTR_MUL_FV,
460     INSTR_MUL_VF,
461     INSTR_DIV_F,
462     INSTR_ADD_F,
463     INSTR_ADD_V,
464     INSTR_SUB_F,
465     INSTR_SUB_V,
466     INSTR_EQ_F,
467     INSTR_EQ_V,
468     INSTR_EQ_S,
469     INSTR_EQ_E,
470     INSTR_EQ_FNC,
471     INSTR_NE_F,
472     INSTR_NE_V,
473     INSTR_NE_S,
474     INSTR_NE_E,
475     INSTR_NE_FNC,
476     INSTR_LE,
477     INSTR_GE,
478     INSTR_LT,
479     INSTR_GT,
480     INSTR_LOAD_F,
481     INSTR_LOAD_V,
482     INSTR_LOAD_S,
483     INSTR_LOAD_ENT,
484     INSTR_LOAD_FLD,
485     INSTR_LOAD_FNC,
486     INSTR_ADDRESS,
487     INSTR_STORE_F,
488     INSTR_STORE_V,
489     INSTR_STORE_S,
490     INSTR_STORE_ENT,
491     INSTR_STORE_FLD,
492     INSTR_STORE_FNC,
493     INSTR_STOREP_F,
494     INSTR_STOREP_V,
495     INSTR_STOREP_S,
496     INSTR_STOREP_ENT,
497     INSTR_STOREP_FLD,
498     INSTR_STOREP_FNC,
499     INSTR_RETURN,
500     INSTR_NOT_F,
501     INSTR_NOT_V,
502     INSTR_NOT_S,
503     INSTR_NOT_ENT,
504     INSTR_NOT_FNC,
505     INSTR_IF,
506     INSTR_IFNOT,
507     INSTR_CALL0,
508     INSTR_CALL1,
509     INSTR_CALL2,
510     INSTR_CALL3,
511     INSTR_CALL4,
512     INSTR_CALL5,
513     INSTR_CALL6,
514     INSTR_CALL7,
515     INSTR_CALL8,
516     INSTR_STATE,
517     INSTR_GOTO,
518     INSTR_AND,
519     INSTR_OR,
520     INSTR_BITAND,
521     INSTR_BITOR,
522
523     /*
524      * Virtual instructions used by the assembler
525      * keep at the end but before virtual instructions
526      * for the IR below.
527      */
528     AINSTR_END,
529
530     /*
531      * Virtual instructions used by the IR
532      * Keep at the end!
533      */
534     VINSTR_PHI,
535     VINSTR_JUMP,
536     VINSTR_COND
537 };
538
539 /*
540  * The symbols below are created by the following
541  * expanded macros:
542  *
543  * VECTOR_MAKE(prog_section_statement, code_statements);
544  * VECTOR_MAKE(prog_section_def,       code_defs      );
545  * VECTOR_MAKE(prog_section_field,     code_fields    );
546  * VECTOR_MAKE(prog_section_function,  code_functions );
547  * VECTOR_MAKE(int,                    code_globals   );
548  * VECTOR_MAKE(char,                   code_chars     );
549  */
550 VECTOR_PROT(prog_section_statement, code_statements);
551 VECTOR_PROT(prog_section_statement, code_statements);
552 VECTOR_PROT(prog_section_def,       code_defs      );
553 VECTOR_PROT(prog_section_field,     code_fields    );
554 VECTOR_PROT(prog_section_function,  code_functions );
555 VECTOR_PROT(int,                    code_globals   );
556 VECTOR_PROT(char,                   code_chars     );
557
558 /*
559  * code_write -- writes out the compiled file
560  * code_init  -- prepares the code file
561  */
562 bool     code_write       (const char *filename);
563 void     code_init        ();
564 uint32_t code_genstring   (const char *string);
565 uint32_t code_cachedstring(const char *string);
566
567 /*===================================================================*/
568 /*========================= assembler.c =============================*/
569 /*===================================================================*/
570 static const struct {
571     const char  *m; /* menomic     */
572     const size_t o; /* operands    */
573     const size_t l; /* menomic len */
574 } asm_instr[] = {
575     { "DONE"      , 1, 4 },
576     { "MUL_F"     , 3, 5 },
577     { "MUL_V"     , 3, 5 },
578     { "MUL_FV"    , 3, 6 },
579     { "MUL_VF"    , 3, 6 },
580     { "DIV"       , 0, 3 },
581     { "ADD_F"     , 3, 5 },
582     { "ADD_V"     , 3, 5 },
583     { "SUB_F"     , 3, 5 },
584     { "DUB_V"     , 3, 5 },
585     { "EQ_F"      , 0, 4 },
586     { "EQ_V"      , 0, 4 },
587     { "EQ_S"      , 0, 4 },
588     { "EQ_E"      , 0, 4 },
589     { "ES_FNC"    , 0, 6 },
590     { "NE_F"      , 0, 4 },
591     { "NE_V"      , 0, 4 },
592     { "NE_S"      , 0, 4 },
593     { "NE_E"      , 0, 4 },
594     { "NE_FNC"    , 0, 6 },
595     { "LE"        , 0, 2 },
596     { "GE"        , 0, 2 },
597     { "LT"        , 0, 2 },
598     { "GT"        , 0, 2 },
599     { "FIELD_F"   , 0, 7 },
600     { "FIELD_V"   , 0, 7 },
601     { "FIELD_S"   , 0, 7 },
602     { "FIELD_ENT" , 0, 9 },
603     { "FIELD_FLD" , 0, 9 },
604     { "FIELD_FNC" , 0, 9 },
605     { "ADDRESS"   , 0, 7 },
606     { "STORE_F"   , 0, 7 },
607     { "STORE_V"   , 0, 7 },
608     { "STORE_S"   , 0, 7 },
609     { "STORE_ENT" , 0, 9 },
610     { "STORE_FLD" , 0, 9 },
611     { "STORE_FNC" , 0, 9 },
612     { "STOREP_F"  , 0, 8 },
613     { "STOREP_V"  , 0, 8 },
614     { "STOREP_S"  , 0, 8 },
615     { "STOREP_ENT", 0, 10},
616     { "STOREP_FLD", 0, 10},
617     { "STOREP_FNC", 0, 10},
618     { "RETURN"    , 0, 6 },
619     { "NOT_F"     , 0, 5 },
620     { "NOT_V"     , 0, 5 },
621     { "NOT_S"     , 0, 5 },
622     { "NOT_ENT"   , 0, 7 },
623     { "NOT_FNC"   , 0, 7 },
624     { "IF"        , 0, 2 },
625     { "IFNOT"     , 0, 5 },
626     { "CALL0"     , 1, 5 },
627     { "CALL1"     , 2, 5 },
628     { "CALL2"     , 3, 5 },
629     { "CALL3"     , 4, 5 },
630     { "CALL4"     , 5, 5 },
631     { "CALL5"     , 6, 5 },
632     { "CALL6"     , 7, 5 },
633     { "CALL7"     , 8, 5 },
634     { "CALL8"     , 9, 5 },
635     { "STATE"     , 0, 5 },
636     { "GOTO"      , 0, 4 },
637     { "AND"       , 0, 3 },
638     { "OR"        , 0, 2 },
639     { "BITAND"    , 0, 6 },
640     { "BITOR"     , 0, 5 },
641     { "END"       , 0, 3 } /* virtual assembler instruction */
642 };
643
644 void asm_init (const char *, FILE **);
645 void asm_close(FILE *);
646 void asm_parse(FILE *);
647 /*===================================================================*/
648 /*============================= main.c ==============================*/
649 /*===================================================================*/
650 enum {
651     COMPILER_QCC,     /* circa  QuakeC */
652     COMPILER_FTEQCC,  /* fteqcc QuakeC */
653     COMPILER_QCCX,    /* qccx   QuakeC */
654     COMPILER_GMQCC    /* this   QuakeC */
655 };
656 extern bool opts_debug;
657 extern bool opts_memchk;
658 extern bool opts_darkplaces_stringtablebug;
659 extern bool opts_omit_nullcode;
660 extern int  opts_compiler;
661 /*===================================================================*/
662 /*============================= ast.c ===============================*/
663 /*===================================================================*/
664 #define MEM_VECTOR_PROTO(Towner, Tmem, mem)                   \
665     bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem);      \
666     bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t)
667
668 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem)                    \
669     MEM_VECTOR_PROTO(Towner, Tmem, mem);                           \
670     bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
671     void Towner##_##mem##_clear(Towner*)
672
673 #define MEM_VECTOR_MAKE(Twhat, name) \
674     Twhat  *name;                    \
675     size_t name##_count;             \
676     size_t name##_alloc
677
678 #define _MEM_VEC_FUN_ADD(Tself, Twhat, mem)                          \
679 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f)            \
680 {                                                                    \
681     Twhat *reall;                                                    \
682     if (self->mem##_count == self->mem##_alloc) {                    \
683         if (!self->mem##_alloc) {                                    \
684             self->mem##_alloc = 16;                                  \
685         } else {                                                     \
686             self->mem##_alloc *= 2;                                  \
687         }                                                            \
688         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc);    \
689         if (!reall) {                                                \
690             return false;                                            \
691         }                                                            \
692         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
693         mem_d(self->mem);                                            \
694         self->mem = reall;                                           \
695     }                                                                \
696     self->mem[self->mem##_count++] = f;                              \
697     return true;                                                     \
698 }
699
700 #define _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)                       \
701 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx)      \
702 {                                                                    \
703     size_t i;                                                        \
704     Twhat *reall;                                                    \
705     if (idx >= self->mem##_count) {                                  \
706         return true; /* huh... */                                    \
707     }                                                                \
708     for (i = idx; i < self->mem##_count-1; ++i) {                    \
709         self->mem[i] = self->mem[i+1];                               \
710     }                                                                \
711     self->mem##_count--;                                             \
712     if (self->mem##_count < self->mem##_count/2) {                   \
713         self->mem##_alloc /= 2;                                      \
714         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count);    \
715         if (!reall) {                                                \
716             return false;                                            \
717         }                                                            \
718         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
719         mem_d(self->mem);                                            \
720         self->mem = reall;                                           \
721     }                                                                \
722     return true;                                                     \
723 }
724
725 #define _MEM_VEC_FUN_FIND(Tself, Twhat, mem)                    \
726 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
727 {                                                               \
728     size_t i;                                                   \
729     for (i = 0; i < self->mem##_count; ++i) {                   \
730         if (self->mem[i] == obj) {                              \
731             if (idx) {                                          \
732                 *idx = i;                                       \
733             }                                                   \
734             return true;                                        \
735         }                                                       \
736     }                                                           \
737     return false;                                               \
738 }
739
740 #define _MEM_VEC_FUN_CLEAR(Tself, mem)  \
741 void Tself##_##mem##_clear(Tself *self) \
742 {                                       \
743     if (!self->mem)                     \
744         return;                         \
745     mem_d((void*) self->mem);           \
746     self->mem = NULL;                   \
747     self->mem##_count = 0;              \
748     self->mem##_alloc = 0;              \
749 }
750
751 #define MEM_VECTOR_CLEAR(owner, mem)  \
752     if ((owner)->mem)                 \
753         mem_d((void*)((owner)->mem)); \
754     (owner)->mem = NULL;              \
755     (owner)->mem##_count = 0;         \
756     (owner)->mem##_alloc = 0
757
758 #define MEM_VECTOR_INIT(owner, mem) \
759 {                                   \
760     (owner)->mem = NULL;            \
761     (owner)->mem##_count = 0;       \
762     (owner)->mem##_alloc = 0;       \
763 }
764
765 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
766 _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)       \
767 _MEM_VEC_FUN_ADD(Tself, Twhat, mem)
768
769 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
770 MEM_VEC_FUNCTIONS(Tself, Twhat, mem)             \
771 _MEM_VEC_FUN_CLEAR(Tself, mem)                   \
772 _MEM_VEC_FUN_FIND(Tself, Twhat, mem)
773
774 enum store_types {
775     store_global,
776     store_local,  /* local, assignable for now, should get promoted later */
777     store_value,  /* unassignable */
778     store_return  /* unassignable, at OFS_RETURN */
779 };
780
781 typedef struct {
782     float x, y, z;
783 } vector;
784
785 /*
786  * A shallow copy of a lex_file to remember where which ast node
787  * came from.
788  */
789 typedef struct {
790     const char *file;
791     size_t      line;
792 } lex_ctx;
793 #endif