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