3 * Dale Weiler, Wolfgang Bumiller
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:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
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
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)
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`.
57 # if __STDC_VERSION__ < 199901L && __GNUC__ < 3
60 # endif /* !__cplusplus */
63 * Of some functions which are generated we want to make sure
64 * that the result isn't ignored. To find such function calls,
67 #if defined(__GNUC__) || defined(__CLANG__)
68 # define GMQCC_WARN __attribute__((warn_unused_result))
73 * This is a hack to silent clang regarding empty
76 #define GMQCC_SUPRESS_EMPTY_BODY do { } while (0)
79 * Inline is not supported in < C90, however some compilers
80 * like gcc and clang might have an inline attribute we can
83 #if __STDC_VERSION__ < 199901L
84 # if defined(__GNUC__) || defined (__CLANG__)
88 # define GMQCC_INLINE __attribute__ ((always_inline))
94 # define GMQCC_INLINE inline
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)
103 typedef unsigned char uint8_t; /* same as below */
104 #elif SCHAR_MIN == -128
105 typedef unsigned char uint8_t; /* same as above */
107 #if SHRT_MAX == 0x7FFF
108 typedef short int16_t;
109 typedef unsigned short uint16_t;
110 #elif INT_MAX == 0x7FFF
112 typedef unsigned int uint16_t;
114 #if INT_MAX == 0x7FFFFFFF
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;
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
130 # if defined(__GNUC__) || defined (__CLANG__)
131 typedef int int64_t __attribute__((__mode__(__DI__)));
132 typedef unsigned int uint64_t __attribute__((__mode__(__DI__)));
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.
139 typedef char int64_t;
140 typedef char uint64_t;
143 #ifdef _LP64 /* long pointer == 64 */
144 typedef unsigned long uintptr_t;
145 typedef long intptr_t;
147 typedef unsigned int uintptr_t;
148 typedef int intptr_t;
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];
162 /*===================================================================*/
163 /*============================ lex.c ================================*/
164 /*===================================================================*/
165 typedef struct lex_file_t {
166 FILE *file; /* file handler */
167 char *name; /* name of file */
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? */
179 * It's important that this table never exceed 32 keywords, the ascii
180 * table starts at 33 (and we don't want conflicts)
191 TOKEN_FOR , /* extension */
192 TOKEN_TYPEDEF , /* extension */
194 /* ensure the token types are out of the */
195 /* bounds of anyothers that may conflict. */
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
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 **);
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 *, ...);
233 /*===================================================================*/
234 /*========================== parse.c ================================*/
235 /*===================================================================*/
236 int parse_gen(lex_file *);
238 /*===================================================================*/
239 /*========================== typedef.c ==============================*/
240 /*===================================================================*/
241 typedef struct typedef_node_t {
246 void typedef_clear();
247 typedef_node *typedef_find(const char *);
248 int typedef_add (lex_file *file, const char *, const char *);
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 ();
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);
270 uint32_t util_crc32(const char *, int, register const short);
273 # define mem_a(x) malloc(x)
274 # define mem_d(x) free (x)
276 # define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
277 # define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
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
285 #define FLT2INT(Y) *((int32_t*)&(Y))
286 #define INT2FLT(Y) *((float *)&(Y))
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) { \
299 if (N##_elements == N##_allocated) { \
300 if (N##_allocated == 0) { \
301 N##_allocated = 12; \
303 N##_allocated *= 2; \
305 if (!(temp = mem_a(N##_allocated * sizeof(T)))) { \
309 memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
311 N##_data = (T*)temp; \
313 N##_data[N##_elements] = element; \
314 return N##_elements++; \
316 int N##_put(T* elements, size_t len) { \
319 while (N##_add(*++elements) != -1 && len--); \
320 return N##_elements; \
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; \
328 int N##_put(T *, size_t)
329 #define VECTOR_MAKE(T,N) \
333 /*===================================================================*/
334 /*=========================== code.c ================================*/
335 /*===================================================================*/
350 * Each paramater incerements by 3 since vector types hold
351 * 3 components (x,y,z).
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)
369 int16_t s1; /* signed */
370 uint16_t u1; /* unsigned */
374 int16_t s1; /* signed */
375 uint16_t u1; /* unsigned */
379 int16_t s1; /* signed */
380 uint16_t u1; /* unsigned */
384 * This is the same as the structure in darkplaces
389 * But this one is more sane to work with, and the
390 * type sizes are guranteed.
392 } prog_section_statement;
403 * 7 = ev_pointer -- engine only
404 * 8 = ev_bad -- engine only
410 typedef prog_section_both prog_section_def;
411 typedef prog_section_both prog_section_field;
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;
426 * These are the external instructions supported by the interperter
427 * this is what things compile to (from the C code).
498 * Virtual instructions used by the assembler
499 * keep at the end but before virtual instructions
505 * Virtual instructions used by the IR
514 * The symbols below are created by the following
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 );
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 );
533 * code_write -- writes out the compiled file
534 * code_init -- prepares the code file
536 bool code_write (const char *filename);
538 uint32_t code_genstring (const char *string);
540 /*===================================================================*/
541 /*========================= assembler.c =============================*/
542 /*===================================================================*/
543 static const struct {
544 const char *m; /* menomic */
545 const size_t o; /* operands */
546 const size_t l; /* menomic len */
572 { "FIELD_F" , 0, 7 },
573 { "FIELD_V" , 0, 7 },
574 { "FIELD_S" , 0, 7 },
575 { "FIELD_ENT" , 0, 9 },
576 { "FIELD_FLD" , 0, 9 },
577 { "FIELD_FNC" , 0, 9 },
578 { "ADDRESS" , 0, 7 },
579 { "STORE_F" , 0, 7 },
580 { "STORE_V" , 0, 7 },
581 { "STORE_S" , 0, 7 },
582 { "STORE_ENT" , 0, 9 },
583 { "STORE_FLD" , 0, 9 },
584 { "STORE_FNC" , 0, 9 },
585 { "STOREP_F" , 0, 8 },
586 { "STOREP_V" , 0, 8 },
587 { "STOREP_S" , 0, 8 },
588 { "STOREP_ENT", 0, 10},
589 { "STOREP_FLD", 0, 10},
590 { "STOREP_FNC", 0, 10},
595 { "NOT_ENT" , 0, 7 },
596 { "NOT_FNC" , 0, 7 },
614 { "END" , 0, 3 } /* virtual assembler instruction */
617 void asm_init (const char *, FILE **);
618 void asm_close(FILE *);
619 void asm_parse(FILE *);
620 /*===================================================================*/
621 /*============================= main.c ==============================*/
622 /*===================================================================*/
624 COMPILER_QCC, /* circa QuakeC */
625 COMPILER_FTEQCC, /* fteqcc QuakeC */
626 COMPILER_QCCX, /* qccx QuakeC */
627 COMPILER_GMQCC /* this QuakeC */
629 extern bool opts_debug;
630 extern bool opts_memchk;
631 extern bool opts_darkplaces_stringtablebug;
632 extern bool opts_omit_nullcode;
633 extern int opts_compiler;
634 /*===================================================================*/
635 /*============================= ast.c ===============================*/
636 /*===================================================================*/
637 #define MEM_VECTOR_PROTO(Towner, Tmem, mem) \
638 bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem); \
639 bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t)
641 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem) \
642 MEM_VECTOR_PROTO(Towner, Tmem, mem); \
643 bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
644 void Towner##_##mem##_clear(Towner*)
646 #define MEM_VECTOR_MAKE(Twhat, name) \
648 size_t name##_count; \
651 #define _MEM_VEC_FUN_ADD(Tself, Twhat, mem) \
652 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f) \
655 if (self->mem##_count == self->mem##_alloc) { \
656 if (!self->mem##_alloc) { \
657 self->mem##_alloc = 16; \
659 self->mem##_alloc *= 2; \
661 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc); \
665 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
669 self->mem[self->mem##_count++] = f; \
673 #define _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
674 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx) \
678 if (idx >= self->mem##_count) { \
679 return true; /* huh... */ \
681 for (i = idx; i < self->mem##_count-1; ++i) { \
682 self->mem[i] = self->mem[i+1]; \
684 self->mem##_count--; \
685 if (self->mem##_count < self->mem##_count/2) { \
686 self->mem##_alloc /= 2; \
687 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count); \
691 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
698 #define _MEM_VEC_FUN_FIND(Tself, Twhat, mem) \
699 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
702 for (i = 0; i < self->mem##_count; ++i) { \
703 if (self->mem[i] == obj) { \
713 #define _MEM_VEC_FUN_CLEAR(Tself, mem) \
714 void Tself##_##mem##_clear(Tself *self) \
718 mem_d((void*) self->mem); \
720 self->mem##_count = 0; \
721 self->mem##_alloc = 0; \
724 #define MEM_VECTOR_CLEAR(owner, mem) \
726 mem_d((void*)((owner)->mem)); \
727 (owner)->mem = NULL; \
728 (owner)->mem##_count = 0; \
729 (owner)->mem##_alloc = 0
731 #define MEM_VECTOR_INIT(owner, mem) \
733 (owner)->mem = NULL; \
734 (owner)->mem##_count = 0; \
735 (owner)->mem##_alloc = 0; \
738 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
739 _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
740 _MEM_VEC_FUN_ADD(Tself, Twhat, mem)
742 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
743 MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
744 _MEM_VEC_FUN_CLEAR(Tself, mem) \
745 _MEM_VEC_FUN_FIND(Tself, Twhat, mem)
749 store_local, /* local, assignable for now, should get promoted later */
750 store_value /* unassignable */
758 * A shallow copy of a lex_file to remember where which ast node