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
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)
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`.
55 # ifdef __STDC_VERSION__
56 # if __STDC_VERSION__ < 199901L && __GNUC__ < 3
63 # endif /* !__STDC_VERSION__ */
64 #endif /* !__cplusplus */
67 * Of some functions which are generated we want to make sure
68 * that the result isn't ignored. To find such function calls,
71 #if defined(__GNUC__) || defined(__CLANG__)
72 # define GMQCC_WARN __attribute__((warn_unused_result))
77 * This is a hack to silent clang regarding empty
80 #define GMQCC_SUPPRESS_EMPTY_BODY do { } while (0)
83 * Inline is not supported in < C90, however some compilers
84 * like gcc and clang might have an inline attribute we can
87 #ifdef __STDC_VERSION__
88 # if __STDC_VERSION__ < 199901L
89 # if defined(__GNUC__) || defined (__CLANG__)
93 # define GMQCC_INLINE __attribute__ ((always_inline))
99 # define GMQCC_INLINE inline
102 # define GMQCC_INLINE
103 #endif /* !__STDC_VERSION__ */
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
111 #if (defined(__GNUC__) && __GNUC__ >= 2) || defined(__CLANG__)
112 # define GMQCC_NORETURN __attribute__ ((noreturn))
114 # define GMQCC_NORETURN
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)
123 typedef unsigned char uint8_t; /* same as below */
124 #elif SCHAR_MIN == -128
125 typedef unsigned char uint8_t; /* same as above */
127 #if SHRT_MAX == 0x7FFF
128 typedef short int16_t;
129 typedef unsigned short uint16_t;
130 #elif INT_MAX == 0x7FFF
132 typedef unsigned int uint16_t;
134 #if INT_MAX == 0x7FFFFFFF
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;
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
150 # if defined(__GNUC__) || defined (__CLANG__)
151 typedef int int64_t __attribute__((__mode__(__DI__)));
152 typedef unsigned int uint64_t __attribute__((__mode__(__DI__)));
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.
159 typedef struct { char _fail : 0; } int64_t;
160 typedef struct { char _fail : 0; } uint64_t;
163 #ifdef _LP64 /* long pointer == 64 */
164 typedef unsigned long uintptr_t;
165 typedef long intptr_t;
167 typedef unsigned int uintptr_t;
168 typedef int intptr_t;
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];
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 ();
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);
201 uint32_t util_crc32(const char *, int, register const short);
204 # define mem_a(x) malloc(x)
205 # define mem_d(x) free (x)
207 # define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
208 # define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
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
216 #define FLT2INT(Y) *((int32_t*)&(Y))
217 #define INT2FLT(Y) *((float *)&(Y))
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) { \
230 if (N##_elements == N##_allocated) { \
231 if (N##_allocated == 0) { \
232 N##_allocated = 12; \
234 N##_allocated *= 2; \
236 if (!(temp = mem_a(N##_allocated * sizeof(T)))) { \
240 memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
242 N##_data = (T*)temp; \
244 N##_data[N##_elements] = element; \
245 return N##_elements++; \
247 int N##_put(T* elements, size_t len) { \
250 while (N##_add(*++elements) != -1 && len--); \
251 return N##_elements; \
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; \
259 int N##_put(T *, size_t)
260 #define VECTOR_MAKE(T,N) \
264 /*===================================================================*/
265 /*=========================== code.c ================================*/
266 /*===================================================================*/
268 /* Note: if you change the order, fix type_sizeof in ir.c */
286 extern const char *type_name[TYPE_COUNT];
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.
295 extern uint16_t type_storep_instr[TYPE_COUNT];
298 * Each paramater incerements by 3 since vector types hold
299 * 3 components (x,y,z).
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)
317 int16_t s1; /* signed */
318 uint16_t u1; /* unsigned */
322 int16_t s1; /* signed */
323 uint16_t u1; /* unsigned */
327 int16_t s1; /* signed */
328 uint16_t u1; /* unsigned */
332 * This is the same as the structure in darkplaces
337 * But this one is more sane to work with, and the
338 * type sizes are guranteed.
340 } prog_section_statement;
351 * 7 = ev_pointer -- engine only
352 * 8 = ev_bad -- engine only
358 typedef prog_section_both prog_section_def;
359 typedef prog_section_both prog_section_field;
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;
374 * These are the external instructions supported by the interperter
375 * this is what things compile to (from the C code).
445 /* warning: will be reordered */
463 * Virtual instructions used by the assembler
464 * keep at the end but before virtual instructions
470 * Virtual instructions used by the IR
479 * The symbols below are created by the following
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 );
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 );
498 * code_write -- writes out the compiled file
499 * code_init -- prepares the code file
501 bool code_write (const char *filename);
503 uint32_t code_genstring (const char *string);
504 uint32_t code_cachedstring(const char *string);
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 */
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},
561 { "NOT_ENT" , 0, 7 },
562 { "NOT_FNC" , 0, 7 },
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 },
598 { "END" , 0, 3 } /* virtual assembler instruction */
601 void asm_init (const char *, FILE **);
602 void asm_close(FILE *);
603 void asm_parse(FILE *);
604 /*===================================================================*/
605 /*============================= main.c ==============================*/
606 /*===================================================================*/
608 COMPILER_QCC, /* circa QuakeC */
609 COMPILER_FTEQCC, /* fteqcc QuakeC */
610 COMPILER_QCCX, /* qccx QuakeC */
611 COMPILER_GMQCC /* this QuakeC */
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)
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*)
630 #define MEM_VECTOR_MAKE(Twhat, name) \
632 size_t name##_count; \
635 #define _MEM_VEC_FUN_ADD(Tself, Twhat, mem) \
636 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f) \
639 if (self->mem##_count == self->mem##_alloc) { \
640 if (!self->mem##_alloc) { \
641 self->mem##_alloc = 16; \
643 self->mem##_alloc *= 2; \
645 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc); \
649 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
653 self->mem[self->mem##_count++] = f; \
657 #define _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
658 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx) \
662 if (idx >= self->mem##_count) { \
663 return true; /* huh... */ \
665 for (i = idx; i < self->mem##_count-1; ++i) { \
666 self->mem[i] = self->mem[i+1]; \
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); \
675 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
682 #define _MEM_VEC_FUN_FIND(Tself, Twhat, mem) \
683 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
686 for (i = 0; i < self->mem##_count; ++i) { \
687 if (self->mem[i] == obj) { \
697 #define _MEM_VEC_FUN_CLEAR(Tself, mem) \
698 void Tself##_##mem##_clear(Tself *self) \
702 mem_d((void*) self->mem); \
704 self->mem##_count = 0; \
705 self->mem##_alloc = 0; \
708 #define MEM_VECTOR_CLEAR(owner, mem) \
710 mem_d((void*)((owner)->mem)); \
711 (owner)->mem = NULL; \
712 (owner)->mem##_count = 0; \
713 (owner)->mem##_alloc = 0
715 #define MEM_VECTOR_INIT(owner, mem) \
717 (owner)->mem = NULL; \
718 (owner)->mem##_count = 0; \
719 (owner)->mem##_alloc = 0; \
722 #define MEM_VECTOR_MOVE(from, mem, to, tm) \
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; \
732 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
733 _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
734 _MEM_VEC_FUN_ADD(Tself, Twhat, mem)
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)
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 */
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))
762 * A shallow copy of a lex_file to remember where which ast node