]> git.xonotic.org Git - xonotic/gmqcc.git/blob - gmqcc.h
Handling output file, writing output file
[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 /*=========================== util.c ================================*/
184 /*===================================================================*/
185 void *util_memory_a      (unsigned int, unsigned int, const char *);
186 void  util_memory_d      (void       *, unsigned int, const char *);
187 void  util_meminfo       ();
188
189 bool  util_strupper      (const char *);
190 bool  util_strdigit      (const char *);
191 bool  util_strncmpexact  (const char *, const char *, size_t);
192 char *util_strdup        (const char *);
193 char *util_strrq         (const char *);
194 char *util_strrnl        (const char *);
195 char *util_strsws        (const char *);
196 char *util_strchp        (const char *, const char *);
197 void  util_debug         (const char *, const char *, ...);
198 int   util_getline       (char **, size_t *, FILE *);
199 void  util_endianswap    (void *,  int, int);
200
201 uint32_t util_crc32(const char *, int, register const short);
202
203 #ifdef NOTRACK
204 #    define mem_a(x) malloc(x)
205 #    define mem_d(x) free  (x)
206 #else
207 #    define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
208 #    define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
209 #endif
210
211 /*
212  * TODO: make these safer to use.  Currently this only works on
213  * x86 and x86_64, some systems will likely not like this. Such
214  * as BE systems.
215  */
216 #define FLT2INT(Y) *((int32_t*)&(Y))
217 #define INT2FLT(Y) *((float  *)&(Y))
218
219 /* Builds vector type (usefull for inside structures) */
220 #define VECTOR_SNAP(X,Y) X ## Y
221 #define VECTOR_FILL(X,Y) VECTOR_SNAP(X,Y)
222 #define VECTOR_TYPE(T,N)                                        \
223     T*     N##_data      = NULL;                                \
224     long   N##_elements  = 0;                                   \
225     long   N##_allocated = 0
226 /* Builds vector add */
227 #define VECTOR_CORE(T,N)                                        \
228     int    N##_add(T element) {                                 \
229         void *temp = NULL;                                      \
230         if (N##_elements == N##_allocated) {                    \
231             if (N##_allocated == 0) {                           \
232                 N##_allocated = 12;                             \
233             } else {                                            \
234                 N##_allocated *= 2;                             \
235             }                                                   \
236             if  (!(temp = mem_a(N##_allocated * sizeof(T)))) {  \
237                 mem_d(temp);                                    \
238                 return -1;                                      \
239             }                                                   \
240             memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
241             mem_d(N##_data);                                    \
242             N##_data = (T*)temp;                                \
243         }                                                       \
244         N##_data[N##_elements] = element;                       \
245         return   N##_elements++;                                \
246     }                                                           \
247     int N##_put(T* elements, size_t len) {                      \
248         len     --;                                             \
249         elements--;                                             \
250         while (N##_add(*++elements) != -1 && len--);            \
251         return N##_elements;                                    \
252     }                                                           \
253     typedef char VECTOR_FILL(extra_semicolon_,__COUNTER__)
254 #define VECTOR_PROT(T,N)                                        \
255     extern T*     N##_data     ;                                \
256     extern long   N##_elements ;                                \
257     extern long   N##_allocated;                                \
258     int           N##_add(T);                                   \
259     int           N##_put(T *, size_t)
260 #define VECTOR_MAKE(T,N) \
261     VECTOR_TYPE(T,N);    \
262     VECTOR_CORE(T,N)
263
264 /*===================================================================*/
265 /*=========================== code.c ================================*/
266 /*===================================================================*/
267
268 /* Note: if you change the order, fix type_sizeof in ir.c */
269 enum {
270     TYPE_VOID     ,
271     TYPE_STRING   ,
272     TYPE_FLOAT    ,
273     TYPE_VECTOR   ,
274     TYPE_ENTITY   ,
275     TYPE_FIELD    ,
276     TYPE_FUNCTION ,
277     TYPE_POINTER  ,
278     TYPE_INTEGER  ,
279     TYPE_QUATERNION  ,
280     TYPE_MATRIX  ,
281     TYPE_VARIANT  ,
282
283     TYPE_COUNT
284 };
285
286 extern const char *type_name[TYPE_COUNT];
287
288 extern size_t type_sizeof[TYPE_COUNT];
289 extern uint16_t type_store_instr[TYPE_COUNT];
290 /* could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
291  * but this breaks when TYPE_INTEGER is added, since with the enhanced
292  * instruction set, the old ones are left untouched, thus the _I instructions
293  * are at a seperate place.
294  */
295 extern uint16_t type_storep_instr[TYPE_COUNT];
296
297 /*
298  * Each paramater incerements by 3 since vector types hold
299  * 3 components (x,y,z).
300  */
301 #define OFS_NULL      0
302 #define OFS_RETURN    1
303 #define OFS_PARM0     (OFS_RETURN+3)
304 #define OFS_PARM1     (OFS_PARM0 +3)
305 #define OFS_PARM2     (OFS_PARM1 +3)
306 #define OFS_PARM3     (OFS_PARM2 +3)
307 #define OFS_PARM4     (OFS_PARM3 +3)
308 #define OFS_PARM5     (OFS_PARM4 +3)
309 #define OFS_PARM6     (OFS_PARM5 +3)
310 #define OFS_PARM7     (OFS_PARM6 +3)
311
312 typedef struct {
313     uint16_t opcode;
314
315     /* operand 1 */
316     union {
317         int16_t  s1; /* signed   */
318         uint16_t u1; /* unsigned */
319     } o1;
320     /* operand 2 */
321     union {
322         int16_t  s1; /* signed   */
323         uint16_t u1; /* unsigned */
324     } o2;
325     /* operand 3 */
326     union {
327         int16_t  s1; /* signed   */
328         uint16_t u1; /* unsigned */
329     } o3;
330
331     /*
332      * This is the same as the structure in darkplaces
333      * {
334      *     unsigned short op;
335      *     short          a,b,c;
336      * }
337      * But this one is more sane to work with, and the
338      * type sizes are guranteed.
339      */
340 } prog_section_statement;
341
342 typedef struct {
343     /* The types:
344      * 0 = ev_void
345      * 1 = ev_string
346      * 2 = ev_float
347      * 3 = ev_vector
348      * 4 = ev_entity
349      * 5 = ev_field
350      * 6 = ev_function
351      * 7 = ev_pointer -- engine only
352      * 8 = ev_bad     -- engine only
353      */
354     uint16_t type;
355     uint16_t offset;
356     uint32_t name;
357 } prog_section_both;
358 typedef prog_section_both prog_section_def;
359 typedef prog_section_both prog_section_field;
360
361 typedef struct {
362     int32_t   entry;      /* in statement table for instructions  */
363     uint32_t  firstlocal; /* First local in local table           */
364     uint32_t  locals;     /* Total ints of params + locals        */
365     uint32_t  profile;    /* Always zero (engine uses this)       */
366     uint32_t  name;       /* name of function in string table     */
367     uint32_t  file;       /* file of the source file              */
368     uint32_t  nargs;      /* number of arguments                  */
369     uint8_t   argsize[8]; /* size of arguments (keep 8 always?)   */
370 } prog_section_function;
371
372 /*
373  * Instructions
374  * These are the external instructions supported by the interperter
375  * this is what things compile to (from the C code).
376  */
377 enum {
378     INSTR_DONE,
379     INSTR_MUL_F,
380     INSTR_MUL_V,
381     INSTR_MUL_VF,
382     INSTR_MUL_FV,
383     INSTR_DIV_F,
384     INSTR_ADD_F,
385     INSTR_ADD_V,
386     INSTR_SUB_F,
387     INSTR_SUB_V,
388     INSTR_EQ_F,
389     INSTR_EQ_V,
390     INSTR_EQ_S,
391     INSTR_EQ_E,
392     INSTR_EQ_FNC,
393     INSTR_NE_F,
394     INSTR_NE_V,
395     INSTR_NE_S,
396     INSTR_NE_E,
397     INSTR_NE_FNC,
398     INSTR_LE,
399     INSTR_GE,
400     INSTR_LT,
401     INSTR_GT,
402     INSTR_LOAD_F,
403     INSTR_LOAD_V,
404     INSTR_LOAD_S,
405     INSTR_LOAD_ENT,
406     INSTR_LOAD_FLD,
407     INSTR_LOAD_FNC,
408     INSTR_ADDRESS,
409     INSTR_STORE_F,
410     INSTR_STORE_V,
411     INSTR_STORE_S,
412     INSTR_STORE_ENT,
413     INSTR_STORE_FLD,
414     INSTR_STORE_FNC,
415     INSTR_STOREP_F,
416     INSTR_STOREP_V,
417     INSTR_STOREP_S,
418     INSTR_STOREP_ENT,
419     INSTR_STOREP_FLD,
420     INSTR_STOREP_FNC,
421     INSTR_RETURN,
422     INSTR_NOT_F,
423     INSTR_NOT_V,
424     INSTR_NOT_S,
425     INSTR_NOT_ENT,
426     INSTR_NOT_FNC,
427     INSTR_IF,
428     INSTR_IFNOT,
429     INSTR_CALL0,
430     INSTR_CALL1,
431     INSTR_CALL2,
432     INSTR_CALL3,
433     INSTR_CALL4,
434     INSTR_CALL5,
435     INSTR_CALL6,
436     INSTR_CALL7,
437     INSTR_CALL8,
438     INSTR_STATE,
439     INSTR_GOTO,
440     INSTR_AND,
441     INSTR_OR,
442     INSTR_BITAND,
443     INSTR_BITOR,
444
445 /* warning: will be reordered */
446     INSTR_MUL_Q,
447     INSTR_MUL_QF,
448     INSTR_MUL_M,
449     INSTR_MUL_MF,
450     INSTR_EQ_Q,
451     INSTR_EQ_M,
452     INSTR_NE_Q,
453     INSTR_NE_M,
454     INSTR_LOAD_Q,
455     INSTR_LOAD_M,
456     INSTR_STORE_Q,
457     INSTR_STORE_M,
458     INSTR_STOREP_Q,
459     INSTR_STOREP_M,
460     INSTR_INV_Q,
461     INSTR_INV_M,
462     /*
463      * Virtual instructions used by the assembler
464      * keep at the end but before virtual instructions
465      * for the IR below.
466      */
467     AINSTR_END,
468
469     /*
470      * Virtual instructions used by the IR
471      * Keep at the end!
472      */
473     VINSTR_PHI,
474     VINSTR_JUMP,
475     VINSTR_COND
476 };
477
478 /*
479  * The symbols below are created by the following
480  * expanded macros:
481  *
482  * VECTOR_MAKE(prog_section_statement, code_statements);
483  * VECTOR_MAKE(prog_section_def,       code_defs      );
484  * VECTOR_MAKE(prog_section_field,     code_fields    );
485  * VECTOR_MAKE(prog_section_function,  code_functions );
486  * VECTOR_MAKE(int,                    code_globals   );
487  * VECTOR_MAKE(char,                   code_chars     );
488  */
489 VECTOR_PROT(prog_section_statement, code_statements);
490 VECTOR_PROT(prog_section_statement, code_statements);
491 VECTOR_PROT(prog_section_def,       code_defs      );
492 VECTOR_PROT(prog_section_field,     code_fields    );
493 VECTOR_PROT(prog_section_function,  code_functions );
494 VECTOR_PROT(int,                    code_globals   );
495 VECTOR_PROT(char,                   code_chars     );
496
497 /*
498  * code_write -- writes out the compiled file
499  * code_init  -- prepares the code file
500  */
501 bool     code_write       (const char *filename);
502 void     code_init        ();
503 uint32_t code_genstring   (const char *string);
504 uint32_t code_cachedstring(const char *string);
505
506 /*===================================================================*/
507 /*========================= assembler.c =============================*/
508 /*===================================================================*/
509 static const struct {
510     const char  *m; /* menomic     */
511     const size_t o; /* operands    */
512     const size_t l; /* menomic len */
513 } asm_instr[] = {
514     { "DONE"      , 1, 4 },
515     { "MUL_F"     , 3, 5 },
516     { "MUL_V"     , 3, 5 },
517     { "MUL_VF"    , 3, 6 },
518     { "MUL_FV"    , 3, 6 },
519     { "DIV"       , 0, 3 },
520     { "ADD_F"     , 3, 5 },
521     { "ADD_V"     , 3, 5 },
522     { "SUB_F"     , 3, 5 },
523     { "DUB_V"     , 3, 5 },
524     { "EQ_F"      , 0, 4 },
525     { "EQ_V"      , 0, 4 },
526     { "EQ_S"      , 0, 4 },
527     { "EQ_E"      , 0, 4 },
528     { "EQ_FNC"    , 0, 6 },
529     { "NE_F"      , 0, 4 },
530     { "NE_V"      , 0, 4 },
531     { "NE_S"      , 0, 4 },
532     { "NE_E"      , 0, 4 },
533     { "NE_FNC"    , 0, 6 },
534     { "LE"        , 0, 2 },
535     { "GE"        , 0, 2 },
536     { "LT"        , 0, 2 },
537     { "GT"        , 0, 2 },
538     { "FIELD_F"   , 0, 7 },
539     { "FIELD_V"   , 0, 7 },
540     { "FIELD_S"   , 0, 7 },
541     { "FIELD_ENT" , 0, 9 },
542     { "FIELD_FLD" , 0, 9 },
543     { "FIELD_FNC" , 0, 9 },
544     { "ADDRESS"   , 0, 7 },
545     { "STORE_F"   , 0, 7 },
546     { "STORE_V"   , 0, 7 },
547     { "STORE_S"   , 0, 7 },
548     { "STORE_ENT" , 0, 9 },
549     { "STORE_FLD" , 0, 9 },
550     { "STORE_FNC" , 0, 9 },
551     { "STOREP_F"  , 0, 8 },
552     { "STOREP_V"  , 0, 8 },
553     { "STOREP_S"  , 0, 8 },
554     { "STOREP_ENT", 0, 10},
555     { "STOREP_FLD", 0, 10},
556     { "STOREP_FNC", 0, 10},
557     { "RETURN"    , 0, 6 },
558     { "NOT_F"     , 0, 5 },
559     { "NOT_V"     , 0, 5 },
560     { "NOT_S"     , 0, 5 },
561     { "NOT_ENT"   , 0, 7 },
562     { "NOT_FNC"   , 0, 7 },
563     { "IF"        , 0, 2 },
564     { "IFNOT"     , 0, 5 },
565     { "CALL0"     , 1, 5 },
566     { "CALL1"     , 2, 5 },
567     { "CALL2"     , 3, 5 },
568     { "CALL3"     , 4, 5 },
569     { "CALL4"     , 5, 5 },
570     { "CALL5"     , 6, 5 },
571     { "CALL6"     , 7, 5 },
572     { "CALL7"     , 8, 5 },
573     { "CALL8"     , 9, 5 },
574     { "STATE"     , 0, 5 },
575     { "GOTO"      , 0, 4 },
576     { "AND"       , 0, 3 },
577     { "OR"        , 0, 2 },
578     { "BITAND"    , 0, 6 },
579     { "BITOR"     , 0, 5 },
580
581     { "MUL_Q"     , 3, 5 },
582     { "MUL_QF"    , 3, 6 },
583     { "MUL_M"     , 3, 5 },
584     { "MUL_MF"    , 3, 6 },
585     { "EQ_Q"      , 0, 4 },
586     { "EQ_M"      , 0, 4 },
587     { "NE_Q"      , 0, 4 },
588     { "NE_M"      , 0, 4 },
589     { "FIELD_Q"   , 0, 7 },
590     { "FIELD_M"   , 0, 7 },
591     { "STORE_Q"   , 0, 7 },
592     { "STORE_M"   , 0, 7 },
593     { "STOREP_Q"  , 0, 8 },
594     { "STOREP_M"  , 0, 8 },
595     { "INV_Q"     , 0, 5 },
596     { "INV_M"     , 0, 5 },
597
598     { "END"       , 0, 3 } /* virtual assembler instruction */
599 };
600
601 void asm_init (const char *, FILE **);
602 void asm_close(FILE *);
603 void asm_parse(FILE *);
604 /*===================================================================*/
605 /*============================= main.c ==============================*/
606 /*===================================================================*/
607 enum {
608     COMPILER_QCC,     /* circa  QuakeC */
609     COMPILER_FTEQCC,  /* fteqcc QuakeC */
610     COMPILER_QCCX,    /* qccx   QuakeC */
611     COMPILER_GMQCC    /* this   QuakeC */
612 };
613 extern bool opts_debug;
614 extern bool opts_memchk;
615 extern bool opts_darkplaces_stringtablebug;
616 extern bool opts_omit_nullcode;
617 extern int  opts_compiler;
618 /*===================================================================*/
619 /*============================= ast.c ===============================*/
620 /*===================================================================*/
621 #define MEM_VECTOR_PROTO(Towner, Tmem, mem)                   \
622     bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem);      \
623     bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t)
624
625 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem)                    \
626     MEM_VECTOR_PROTO(Towner, Tmem, mem);                           \
627     bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
628     void Towner##_##mem##_clear(Towner*)
629
630 #define MEM_VECTOR_MAKE(Twhat, name) \
631     Twhat  *name;                    \
632     size_t name##_count;             \
633     size_t name##_alloc
634
635 #define _MEM_VEC_FUN_ADD(Tself, Twhat, mem)                          \
636 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f)            \
637 {                                                                    \
638     Twhat *reall;                                                    \
639     if (self->mem##_count == self->mem##_alloc) {                    \
640         if (!self->mem##_alloc) {                                    \
641             self->mem##_alloc = 16;                                  \
642         } else {                                                     \
643             self->mem##_alloc *= 2;                                  \
644         }                                                            \
645         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc);    \
646         if (!reall) {                                                \
647             return false;                                            \
648         }                                                            \
649         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
650         mem_d(self->mem);                                            \
651         self->mem = reall;                                           \
652     }                                                                \
653     self->mem[self->mem##_count++] = f;                              \
654     return true;                                                     \
655 }
656
657 #define _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)                       \
658 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx)      \
659 {                                                                    \
660     size_t i;                                                        \
661     Twhat *reall;                                                    \
662     if (idx >= self->mem##_count) {                                  \
663         return true; /* huh... */                                    \
664     }                                                                \
665     for (i = idx; i < self->mem##_count-1; ++i) {                    \
666         self->mem[i] = self->mem[i+1];                               \
667     }                                                                \
668     self->mem##_count--;                                             \
669     if (self->mem##_count < self->mem##_count/2) {                   \
670         self->mem##_alloc /= 2;                                      \
671         reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count);    \
672         if (!reall) {                                                \
673             return false;                                            \
674         }                                                            \
675         memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
676         mem_d(self->mem);                                            \
677         self->mem = reall;                                           \
678     }                                                                \
679     return true;                                                     \
680 }
681
682 #define _MEM_VEC_FUN_FIND(Tself, Twhat, mem)                    \
683 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
684 {                                                               \
685     size_t i;                                                   \
686     for (i = 0; i < self->mem##_count; ++i) {                   \
687         if (self->mem[i] == obj) {                              \
688             if (idx) {                                          \
689                 *idx = i;                                       \
690             }                                                   \
691             return true;                                        \
692         }                                                       \
693     }                                                           \
694     return false;                                               \
695 }
696
697 #define _MEM_VEC_FUN_CLEAR(Tself, mem)  \
698 void Tself##_##mem##_clear(Tself *self) \
699 {                                       \
700     if (!self->mem)                     \
701         return;                         \
702     mem_d((void*) self->mem);           \
703     self->mem = NULL;                   \
704     self->mem##_count = 0;              \
705     self->mem##_alloc = 0;              \
706 }
707
708 #define MEM_VECTOR_CLEAR(owner, mem)  \
709     if ((owner)->mem)                 \
710         mem_d((void*)((owner)->mem)); \
711     (owner)->mem = NULL;              \
712     (owner)->mem##_count = 0;         \
713     (owner)->mem##_alloc = 0
714
715 #define MEM_VECTOR_INIT(owner, mem) \
716 {                                   \
717     (owner)->mem = NULL;            \
718     (owner)->mem##_count = 0;       \
719     (owner)->mem##_alloc = 0;       \
720 }
721
722 #define MEM_VECTOR_MOVE(from, mem, to, tm)   \
723 {                                            \
724     (to)->tm = (from)->mem;                  \
725     (to)->tm##_count = (from)->mem##_count;  \
726     (to)->tm##_alloc = (from)->mem##_alloc;  \
727     (from)->mem = NULL;                      \
728     (from)->mem##_count = 0;                 \
729     (from)->mem##_alloc = 0;                 \
730 }
731
732 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
733 _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem)       \
734 _MEM_VEC_FUN_ADD(Tself, Twhat, mem)
735
736 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
737 MEM_VEC_FUNCTIONS(Tself, Twhat, mem)             \
738 _MEM_VEC_FUN_CLEAR(Tself, mem)                   \
739 _MEM_VEC_FUN_FIND(Tself, Twhat, mem)
740
741 enum store_types {
742     store_global,
743     store_local,  /* local, assignable for now, should get promoted later */
744     store_param,  /* parameters, they are locals with a fixed position */
745     store_value,  /* unassignable */
746     store_return  /* unassignable, at OFS_RETURN */
747 };
748
749 typedef struct {
750     float x, y, z;
751 } vector;
752
753 typedef float matrix[4][4]; /* OpenGL layout */
754 typedef float quaternion[4]; /* order: x, y, z, w */
755 #define MATRIX(axis, elem) ((4*(axis)) + (elem))
756 #define QUAT_X 0
757 #define QUAT_Y 1
758 #define QUAT_Z 2
759 #define QUAT_W 3
760
761 /*
762  * A shallow copy of a lex_file to remember where which ast node
763  * came from.
764  */
765 typedef struct {
766     const char *file;
767     size_t      line;
768 } lex_ctx;
769 #endif