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 /*============================ lex.c ================================*/
184 /*===================================================================*/
185 typedef struct lex_file_t {
186 FILE *file; /* file handler */
187 char *name; /* name of file */
191 int last; /* last token */
192 int current; /* current token */
193 int length; /* bytes left to parse */
194 int size; /* never changes (size of file) */
195 int line; /* what line are we on? */
199 * It's important that this table never exceed 32 keywords, the ascii
200 * table starts at 33 (and we don't want conflicts)
211 TOKEN_FOR , /* extension */
212 TOKEN_TYPEDEF , /* extension */
214 /* ensure the token types are out of the */
215 /* bounds of anyothers that may conflict. */
224 * Lexer state constants, these are numbers for where exactly in
225 * the lexing the lexer is at. Or where it decided to stop if a lexer
226 * error occurs. These numbers must be > where the ascii-table ends
227 * and > the last type token which is TOKEN_VOID
236 int lex_token (lex_file *);
237 void lex_reset (lex_file *);
238 void lex_close (lex_file *);
239 void lex_parse (lex_file *);
240 lex_file *lex_include(lex_file *, const char *);
241 void lex_init (const char *, lex_file **);
243 /*===================================================================*/
244 /*========================== error.c ================================*/
245 /*===================================================================*/
246 #define ERROR_LEX (SHRT_MAX+0)
247 #define ERROR_PARSE (SHRT_MAX+1)
248 #define ERROR_INTERNAL (SHRT_MAX+2)
249 #define ERROR_COMPILER (SHRT_MAX+3)
250 #define ERROR_PREPRO (SHRT_MAX+4)
251 int error(lex_file *, int, const char *, ...);
253 /*===================================================================*/
254 /*========================== parse.c ================================*/
255 /*===================================================================*/
256 int parse_gen(lex_file *);
258 /*===================================================================*/
259 /*========================== typedef.c ==============================*/
260 /*===================================================================*/
261 typedef struct typedef_node_t {
266 void typedef_clear();
267 typedef_node *typedef_find(const char *);
268 int typedef_add (lex_file *file, const char *, const char *);
271 /*===================================================================*/
272 /*=========================== util.c ================================*/
273 /*===================================================================*/
274 void *util_memory_a (unsigned int, unsigned int, const char *);
275 void util_memory_d (void *, unsigned int, const char *);
276 void util_meminfo ();
278 bool util_strupper (const char *);
279 bool util_strdigit (const char *);
280 bool util_strncmpexact (const char *, const char *, size_t);
281 char *util_strdup (const char *);
282 char *util_strrq (const char *);
283 char *util_strrnl (const char *);
284 char *util_strsws (const char *);
285 char *util_strchp (const char *, const char *);
286 void util_debug (const char *, const char *, ...);
287 int util_getline (char **, size_t *, FILE *);
288 void util_endianswap (void *, int, int);
290 uint32_t util_crc32(const char *, int, register const short);
293 # define mem_a(x) malloc(x)
294 # define mem_d(x) free (x)
296 # define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
297 # define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
301 * TODO: make these safer to use. Currently this only works on
302 * x86 and x86_64, some systems will likely not like this. Such
305 #define FLT2INT(Y) *((int32_t*)&(Y))
306 #define INT2FLT(Y) *((float *)&(Y))
308 /* Builds vector type (usefull for inside structures) */
309 #define VECTOR_SNAP(X,Y) X ## Y
310 #define VECTOR_FILL(X,Y) VECTOR_SNAP(X,Y)
311 #define VECTOR_TYPE(T,N) \
312 T* N##_data = NULL; \
313 long N##_elements = 0; \
314 long N##_allocated = 0
315 /* Builds vector add */
316 #define VECTOR_CORE(T,N) \
317 int N##_add(T element) { \
319 if (N##_elements == N##_allocated) { \
320 if (N##_allocated == 0) { \
321 N##_allocated = 12; \
323 N##_allocated *= 2; \
325 if (!(temp = mem_a(N##_allocated * sizeof(T)))) { \
329 memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
331 N##_data = (T*)temp; \
333 N##_data[N##_elements] = element; \
334 return N##_elements++; \
336 int N##_put(T* elements, size_t len) { \
339 while (N##_add(*++elements) != -1 && len--); \
340 return N##_elements; \
342 typedef char VECTOR_FILL(extra_semicolon_,__COUNTER__)
343 #define VECTOR_PROT(T,N) \
344 extern T* N##_data ; \
345 extern long N##_elements ; \
346 extern long N##_allocated; \
348 int N##_put(T *, size_t)
349 #define VECTOR_MAKE(T,N) \
353 /*===================================================================*/
354 /*=========================== code.c ================================*/
355 /*===================================================================*/
357 /* Note: if you change the order, fix type_sizeof in ir.c */
375 extern size_t type_sizeof[TYPE_COUNT];
376 extern uint16_t type_store_instr[TYPE_COUNT];
377 /* could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
378 * but this breaks when TYPE_INTEGER is added, since with the enhanced
379 * instruction set, the old ones are left untouched, thus the _I instructions
380 * are at a seperate place.
382 extern uint16_t type_storep_instr[TYPE_COUNT];
385 * Each paramater incerements by 3 since vector types hold
386 * 3 components (x,y,z).
390 #define OFS_PARM0 (OFS_RETURN+3)
391 #define OFS_PARM1 (OFS_PARM0 +3)
392 #define OFS_PARM2 (OFS_PARM1 +3)
393 #define OFS_PARM3 (OFS_PARM2 +3)
394 #define OFS_PARM4 (OFS_PARM3 +3)
395 #define OFS_PARM5 (OFS_PARM4 +3)
396 #define OFS_PARM6 (OFS_PARM5 +3)
397 #define OFS_PARM7 (OFS_PARM6 +3)
404 int16_t s1; /* signed */
405 uint16_t u1; /* unsigned */
409 int16_t s1; /* signed */
410 uint16_t u1; /* unsigned */
414 int16_t s1; /* signed */
415 uint16_t u1; /* unsigned */
419 * This is the same as the structure in darkplaces
424 * But this one is more sane to work with, and the
425 * type sizes are guranteed.
427 } prog_section_statement;
438 * 7 = ev_pointer -- engine only
439 * 8 = ev_bad -- engine only
445 typedef prog_section_both prog_section_def;
446 typedef prog_section_both prog_section_field;
449 int32_t entry; /* in statement table for instructions */
450 uint32_t firstlocal; /* First local in local table */
451 uint32_t locals; /* Total ints of params + locals */
452 uint32_t profile; /* Always zero (engine uses this) */
453 uint32_t name; /* name of function in string table */
454 uint32_t file; /* file of the source file */
455 uint32_t nargs; /* number of arguments */
456 uint8_t argsize[8]; /* size of arguments (keep 8 always?) */
457 } prog_section_function;
461 * These are the external instructions supported by the interperter
462 * this is what things compile to (from the C code).
549 * Virtual instructions used by the assembler
550 * keep at the end but before virtual instructions
556 * Virtual instructions used by the IR
565 * The symbols below are created by the following
568 * VECTOR_MAKE(prog_section_statement, code_statements);
569 * VECTOR_MAKE(prog_section_def, code_defs );
570 * VECTOR_MAKE(prog_section_field, code_fields );
571 * VECTOR_MAKE(prog_section_function, code_functions );
572 * VECTOR_MAKE(int, code_globals );
573 * VECTOR_MAKE(char, code_chars );
575 VECTOR_PROT(prog_section_statement, code_statements);
576 VECTOR_PROT(prog_section_statement, code_statements);
577 VECTOR_PROT(prog_section_def, code_defs );
578 VECTOR_PROT(prog_section_field, code_fields );
579 VECTOR_PROT(prog_section_function, code_functions );
580 VECTOR_PROT(int, code_globals );
581 VECTOR_PROT(char, code_chars );
584 * code_write -- writes out the compiled file
585 * code_init -- prepares the code file
587 bool code_write (const char *filename);
589 uint32_t code_genstring (const char *string);
590 uint32_t code_cachedstring(const char *string);
592 /*===================================================================*/
593 /*========================= assembler.c =============================*/
594 /*===================================================================*/
595 static const struct {
596 const char *m; /* menomic */
597 const size_t o; /* operands */
598 const size_t l; /* menomic len */
632 { "FIELD_F" , 0, 7 },
633 { "FIELD_V" , 0, 7 },
634 { "FIELD_S" , 0, 7 },
635 { "FIELD_ENT" , 0, 9 },
636 { "FIELD_FLD" , 0, 9 },
637 { "FIELD_FNC" , 0, 9 },
638 { "FIELD_Q" , 0, 7 },
639 { "FIELD_M" , 0, 7 },
640 { "ADDRESS" , 0, 7 },
641 { "STORE_F" , 0, 7 },
642 { "STORE_V" , 0, 7 },
643 { "STORE_S" , 0, 7 },
644 { "STORE_ENT" , 0, 9 },
645 { "STORE_FLD" , 0, 9 },
646 { "STORE_FNC" , 0, 9 },
647 { "STORE_Q" , 0, 7 },
648 { "STORE_M" , 0, 7 },
649 { "STOREP_F" , 0, 8 },
650 { "STOREP_V" , 0, 8 },
651 { "STOREP_S" , 0, 8 },
652 { "STOREP_ENT", 0, 10},
653 { "STOREP_FLD", 0, 10},
654 { "STOREP_FNC", 0, 10},
655 { "STOREP_Q" , 0, 8 },
656 { "STOREP_M" , 0, 8 },
661 { "NOT_ENT" , 0, 7 },
662 { "NOT_FNC" , 0, 7 },
682 { "END" , 0, 3 } /* virtual assembler instruction */
685 void asm_init (const char *, FILE **);
686 void asm_close(FILE *);
687 void asm_parse(FILE *);
688 /*===================================================================*/
689 /*============================= main.c ==============================*/
690 /*===================================================================*/
692 COMPILER_QCC, /* circa QuakeC */
693 COMPILER_FTEQCC, /* fteqcc QuakeC */
694 COMPILER_QCCX, /* qccx QuakeC */
695 COMPILER_GMQCC /* this QuakeC */
697 extern bool opts_debug;
698 extern bool opts_memchk;
699 extern bool opts_darkplaces_stringtablebug;
700 extern bool opts_omit_nullcode;
701 extern int opts_compiler;
702 /*===================================================================*/
703 /*============================= ast.c ===============================*/
704 /*===================================================================*/
705 #define MEM_VECTOR_PROTO(Towner, Tmem, mem) \
706 bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem); \
707 bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t)
709 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem) \
710 MEM_VECTOR_PROTO(Towner, Tmem, mem); \
711 bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
712 void Towner##_##mem##_clear(Towner*)
714 #define MEM_VECTOR_MAKE(Twhat, name) \
716 size_t name##_count; \
719 #define _MEM_VEC_FUN_ADD(Tself, Twhat, mem) \
720 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f) \
723 if (self->mem##_count == self->mem##_alloc) { \
724 if (!self->mem##_alloc) { \
725 self->mem##_alloc = 16; \
727 self->mem##_alloc *= 2; \
729 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc); \
733 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
737 self->mem[self->mem##_count++] = f; \
741 #define _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
742 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx) \
746 if (idx >= self->mem##_count) { \
747 return true; /* huh... */ \
749 for (i = idx; i < self->mem##_count-1; ++i) { \
750 self->mem[i] = self->mem[i+1]; \
752 self->mem##_count--; \
753 if (self->mem##_count < self->mem##_count/2) { \
754 self->mem##_alloc /= 2; \
755 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count); \
759 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
766 #define _MEM_VEC_FUN_FIND(Tself, Twhat, mem) \
767 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
770 for (i = 0; i < self->mem##_count; ++i) { \
771 if (self->mem[i] == obj) { \
781 #define _MEM_VEC_FUN_CLEAR(Tself, mem) \
782 void Tself##_##mem##_clear(Tself *self) \
786 mem_d((void*) self->mem); \
788 self->mem##_count = 0; \
789 self->mem##_alloc = 0; \
792 #define MEM_VECTOR_CLEAR(owner, mem) \
794 mem_d((void*)((owner)->mem)); \
795 (owner)->mem = NULL; \
796 (owner)->mem##_count = 0; \
797 (owner)->mem##_alloc = 0
799 #define MEM_VECTOR_INIT(owner, mem) \
801 (owner)->mem = NULL; \
802 (owner)->mem##_count = 0; \
803 (owner)->mem##_alloc = 0; \
806 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
807 _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
808 _MEM_VEC_FUN_ADD(Tself, Twhat, mem)
810 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
811 MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
812 _MEM_VEC_FUN_CLEAR(Tself, mem) \
813 _MEM_VEC_FUN_FIND(Tself, Twhat, mem)
817 store_local, /* local, assignable for now, should get promoted later */
818 store_value, /* unassignable */
819 store_return /* unassignable, at OFS_RETURN */
826 typedef float matrix[4][4]; /* OpenGL layout */
827 typedef float quaternion[4]; /* order: x, y, z, w */
828 #define MATRIX(axis, elem) ((4*(axis)) + (elem))
835 * A shallow copy of a lex_file to remember where which ast node