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`.
56 # if __STDC_VERSION__ < 199901L && __GNUC__ < 3
61 # endif /* !__cplusplus */
64 * Of some functions which are generated we want to make sure
65 * that the result isn't ignored. To find such function calls,
68 #if defined(__GNUC__) || defined(__CLANG__)
69 # define GMQCC_WARN __attribute__((warn_unused_result))
74 * This is a hack to silent clang regarding empty
77 #define GMQCC_SUPRESS_EMPTY_BODY do { } while (0)
80 * Inline is not supported in < C90, however some compilers
81 * like gcc and clang might have an inline attribute we can
84 #if __STDC_VERSION__ < 199901L
85 # if defined(__GNUC__) || defined (__CLANG__)
89 # define GMQCC_INLINE __attribute__ ((always_inline))
95 # define GMQCC_INLINE inline
99 * stdint.h and inttypes.h -less subset
100 * for systems that don't have it, which we must
101 * assume is all systems. (int8_t not required)
104 typedef unsigned char uint8_t; /* same as below */
105 #elif SCHAR_MIN == -128
106 typedef unsigned char uint8_t; /* same as above */
108 #if SHRT_MAX == 0x7FFF
109 typedef short int16_t;
110 typedef unsigned short uint16_t;
111 #elif INT_MAX == 0x7FFF
113 typedef unsigned int uint16_t;
115 #if INT_MAX == 0x7FFFFFFF
117 typedef unsigned int uint32_t;
118 typedef long int64_t;
119 typedef unsigned long uint64_t;
120 #elif LONG_MAX == 0x7FFFFFFF
121 typedef long int32_t;
122 typedef unsigned long uint32_t;
125 * It's nearly impossible to figure out a 64bit type at
126 * this point without making assumptions about the build
127 * enviroment. So if clang or gcc is detected use some
128 * compiler builtins to create a 64 signed and unsigned
131 # if defined(__GNUC__) || defined (__CLANG__)
132 typedef int int64_t __attribute__((__mode__(__DI__)));
133 typedef unsigned int uint64_t __attribute__((__mode__(__DI__)));
136 * Incoorectly size the types so static assertions below will
137 * fail. There is no valid way to get a 64bit type at this point
138 * without making assumptions of too many things.
140 typedef char int64_t;
141 typedef char uint64_t;
144 #ifdef _LP64 /* long pointer == 64 */
145 typedef unsigned long uintptr_t;
146 typedef long intptr_t;
148 typedef unsigned int uintptr_t;
149 typedef int intptr_t;
151 /* Ensure type sizes are correct: */
152 typedef char uint8_size_is_correct [sizeof(uint8_t) == 1?1:-1];
153 typedef char uint16_size_if_correct [sizeof(uint16_t) == 2?1:-1];
154 typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
155 typedef char uint64_size_is_correct [sizeof(uint64_t) == 8?1:-1];
156 typedef char int16_size_if_correct [sizeof(int16_t) == 2?1:-1];
157 typedef char int32_size_is_correct [sizeof(int32_t) == 4?1:-1];
158 typedef char int64_size_is_correct [sizeof(int64_t) == 8?1:-1];
159 /* intptr_t / uintptr_t correct size check */
160 typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
161 typedef char intptr_size_is_correct [sizeof(uintptr_t)== sizeof(int*)?1:-1];
163 /*===================================================================*/
164 /*============================ lex.c ================================*/
165 /*===================================================================*/
166 typedef struct lex_file_t {
167 FILE *file; /* file handler */
168 char *name; /* name of file */
172 int last; /* last token */
173 int current; /* current token */
174 int length; /* bytes left to parse */
175 int size; /* never changes (size of file) */
176 int line; /* what line are we on? */
180 * It's important that this table never exceed 32 keywords, the ascii
181 * table starts at 33 (and we don't want conflicts)
192 TOKEN_FOR , /* extension */
193 TOKEN_TYPEDEF , /* extension */
195 /* ensure the token types are out of the */
196 /* bounds of anyothers that may conflict. */
205 * Lexer state constants, these are numbers for where exactly in
206 * the lexing the lexer is at. Or where it decided to stop if a lexer
207 * error occurs. These numbers must be > where the ascii-table ends
208 * and > the last type token which is TOKEN_VOID
217 int lex_token (lex_file *);
218 void lex_reset (lex_file *);
219 void lex_close (lex_file *);
220 void lex_parse (lex_file *);
221 lex_file *lex_include(lex_file *, const char *);
222 void lex_init (const char *, lex_file **);
224 /*===================================================================*/
225 /*========================== error.c ================================*/
226 /*===================================================================*/
227 #define ERROR_LEX (SHRT_MAX+0)
228 #define ERROR_PARSE (SHRT_MAX+1)
229 #define ERROR_INTERNAL (SHRT_MAX+2)
230 #define ERROR_COMPILER (SHRT_MAX+3)
231 #define ERROR_PREPRO (SHRT_MAX+4)
232 int error(lex_file *, int, const char *, ...);
234 /*===================================================================*/
235 /*========================== parse.c ================================*/
236 /*===================================================================*/
237 int parse_gen(lex_file *);
239 /*===================================================================*/
240 /*========================== typedef.c ==============================*/
241 /*===================================================================*/
242 typedef struct typedef_node_t {
247 void typedef_clear();
248 typedef_node *typedef_find(const char *);
249 int typedef_add (lex_file *file, const char *, const char *);
252 /*===================================================================*/
253 /*=========================== util.c ================================*/
254 /*===================================================================*/
255 void *util_memory_a (unsigned int, unsigned int, const char *);
256 void util_memory_d (void *, unsigned int, const char *);
257 void util_meminfo ();
259 bool util_strupper (const char *);
260 bool util_strdigit (const char *);
261 bool util_strncmpexact (const char *, const char *, size_t);
262 char *util_strdup (const char *);
263 char *util_strrq (const char *);
264 char *util_strrnl (const char *);
265 char *util_strsws (const char *);
266 char *util_strchp (const char *, const char *);
267 void util_debug (const char *, const char *, ...);
268 int util_getline (char **, size_t *, FILE *);
269 void util_endianswap (void *, int, int);
271 uint32_t util_crc32(const char *, int, register const short);
274 # define mem_a(x) malloc(x)
275 # define mem_d(x) free (x)
277 # define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
278 # define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
282 * TODO: make these safer to use. Currently this only works on
283 * x86 and x86_64, some systems will likely not like this. Such
286 #define FLT2INT(Y) *((int32_t*)&(Y))
287 #define INT2FLT(Y) *((float *)&(Y))
289 /* Builds vector type (usefull for inside structures) */
290 #define VECTOR_SNAP(X,Y) X ## Y
291 #define VECTOR_FILL(X,Y) VECTOR_SNAP(X,Y)
292 #define VECTOR_TYPE(T,N) \
293 T* N##_data = NULL; \
294 long N##_elements = 0; \
295 long N##_allocated = 0
296 /* Builds vector add */
297 #define VECTOR_CORE(T,N) \
298 int N##_add(T element) { \
300 if (N##_elements == N##_allocated) { \
301 if (N##_allocated == 0) { \
302 N##_allocated = 12; \
304 N##_allocated *= 2; \
306 if (!(temp = mem_a(N##_allocated * sizeof(T)))) { \
310 memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
312 N##_data = (T*)temp; \
314 N##_data[N##_elements] = element; \
315 return N##_elements++; \
317 int N##_put(T* elements, size_t len) { \
320 while (N##_add(*++elements) != -1 && len--); \
321 return N##_elements; \
323 typedef char VECTOR_FILL(extra_semicolon_,__COUNTER__)
324 #define VECTOR_PROT(T,N) \
325 extern T* N##_data ; \
326 extern long N##_elements ; \
327 extern long N##_allocated; \
329 int N##_put(T *, size_t)
330 #define VECTOR_MAKE(T,N) \
334 /*===================================================================*/
335 /*=========================== code.c ================================*/
336 /*===================================================================*/
351 * Each paramater incerements by 3 since vector types hold
352 * 3 components (x,y,z).
356 #define OFS_PARM0 (OFS_RETURN+3)
357 #define OFS_PARM1 (OFS_PARM0 +3)
358 #define OFS_PARM2 (OFS_PARM1 +3)
359 #define OFS_PARM3 (OFS_PARM2 +3)
360 #define OFS_PARM4 (OFS_PARM3 +3)
361 #define OFS_PARM5 (OFS_PARM4 +3)
362 #define OFS_PARM6 (OFS_PARM5 +3)
363 #define OFS_PARM7 (OFS_PARM6 +3)
370 int16_t s1; /* signed */
371 uint16_t u1; /* unsigned */
375 int16_t s1; /* signed */
376 uint16_t u1; /* unsigned */
380 int16_t s1; /* signed */
381 uint16_t u1; /* unsigned */
385 * This is the same as the structure in darkplaces
390 * But this one is more sane to work with, and the
391 * type sizes are guranteed.
393 } prog_section_statement;
404 * 7 = ev_pointer -- engine only
405 * 8 = ev_bad -- engine only
411 typedef prog_section_both prog_section_def;
412 typedef prog_section_both prog_section_field;
415 int32_t entry; /* in statement table for instructions */
416 uint32_t firstlocal; /* First local in local table */
417 uint32_t locals; /* Total ints of params + locals */
418 uint32_t profile; /* Always zero (engine uses this) */
419 uint32_t name; /* name of function in string table */
420 uint32_t file; /* file of the source file */
421 uint32_t nargs; /* number of arguments */
422 uint8_t argsize[8]; /* size of arguments (keep 8 always?) */
423 } prog_section_function;
427 * These are the external instructions supported by the interperter
428 * this is what things compile to (from the C code).
499 * Virtual instructions used by the assembler
500 * keep at the end but before virtual instructions
506 * Virtual instructions used by the IR
515 * The symbols below are created by the following
518 * VECTOR_MAKE(prog_section_statement, code_statements);
519 * VECTOR_MAKE(prog_section_def, code_defs );
520 * VECTOR_MAKE(prog_section_field, code_fields );
521 * VECTOR_MAKE(prog_section_function, code_functions );
522 * VECTOR_MAKE(int, code_globals );
523 * VECTOR_MAKE(char, code_chars );
525 VECTOR_PROT(prog_section_statement, code_statements);
526 VECTOR_PROT(prog_section_statement, code_statements);
527 VECTOR_PROT(prog_section_def, code_defs );
528 VECTOR_PROT(prog_section_field, code_fields );
529 VECTOR_PROT(prog_section_function, code_functions );
530 VECTOR_PROT(int, code_globals );
531 VECTOR_PROT(char, code_chars );
534 * code_write -- writes out the compiled file
535 * code_init -- prepares the code file
537 bool code_write (const char *filename);
539 uint32_t code_genstring (const char *string);
540 uint32_t code_cachedstring(const char *string);
542 /*===================================================================*/
543 /*========================= assembler.c =============================*/
544 /*===================================================================*/
545 static const struct {
546 const char *m; /* menomic */
547 const size_t o; /* operands */
548 const size_t l; /* menomic len */
574 { "FIELD_F" , 0, 7 },
575 { "FIELD_V" , 0, 7 },
576 { "FIELD_S" , 0, 7 },
577 { "FIELD_ENT" , 0, 9 },
578 { "FIELD_FLD" , 0, 9 },
579 { "FIELD_FNC" , 0, 9 },
580 { "ADDRESS" , 0, 7 },
581 { "STORE_F" , 0, 7 },
582 { "STORE_V" , 0, 7 },
583 { "STORE_S" , 0, 7 },
584 { "STORE_ENT" , 0, 9 },
585 { "STORE_FLD" , 0, 9 },
586 { "STORE_FNC" , 0, 9 },
587 { "STOREP_F" , 0, 8 },
588 { "STOREP_V" , 0, 8 },
589 { "STOREP_S" , 0, 8 },
590 { "STOREP_ENT", 0, 10},
591 { "STOREP_FLD", 0, 10},
592 { "STOREP_FNC", 0, 10},
597 { "NOT_ENT" , 0, 7 },
598 { "NOT_FNC" , 0, 7 },
616 { "END" , 0, 3 } /* virtual assembler instruction */
619 void asm_init (const char *, FILE **);
620 void asm_close(FILE *);
621 void asm_parse(FILE *);
622 /*===================================================================*/
623 /*============================= main.c ==============================*/
624 /*===================================================================*/
626 COMPILER_QCC, /* circa QuakeC */
627 COMPILER_FTEQCC, /* fteqcc QuakeC */
628 COMPILER_QCCX, /* qccx QuakeC */
629 COMPILER_GMQCC /* this QuakeC */
631 extern bool opts_debug;
632 extern bool opts_memchk;
633 extern bool opts_darkplaces_stringtablebug;
634 extern bool opts_omit_nullcode;
635 extern int opts_compiler;
636 /*===================================================================*/
637 /*============================= ast.c ===============================*/
638 /*===================================================================*/
639 #define MEM_VECTOR_PROTO(Towner, Tmem, mem) \
640 bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem); \
641 bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t)
643 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem) \
644 MEM_VECTOR_PROTO(Towner, Tmem, mem); \
645 bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
646 void Towner##_##mem##_clear(Towner*)
648 #define MEM_VECTOR_MAKE(Twhat, name) \
650 size_t name##_count; \
653 #define _MEM_VEC_FUN_ADD(Tself, Twhat, mem) \
654 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f) \
657 if (self->mem##_count == self->mem##_alloc) { \
658 if (!self->mem##_alloc) { \
659 self->mem##_alloc = 16; \
661 self->mem##_alloc *= 2; \
663 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc); \
667 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
671 self->mem[self->mem##_count++] = f; \
675 #define _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
676 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx) \
680 if (idx >= self->mem##_count) { \
681 return true; /* huh... */ \
683 for (i = idx; i < self->mem##_count-1; ++i) { \
684 self->mem[i] = self->mem[i+1]; \
686 self->mem##_count--; \
687 if (self->mem##_count < self->mem##_count/2) { \
688 self->mem##_alloc /= 2; \
689 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count); \
693 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
700 #define _MEM_VEC_FUN_FIND(Tself, Twhat, mem) \
701 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
704 for (i = 0; i < self->mem##_count; ++i) { \
705 if (self->mem[i] == obj) { \
715 #define _MEM_VEC_FUN_CLEAR(Tself, mem) \
716 void Tself##_##mem##_clear(Tself *self) \
720 mem_d((void*) self->mem); \
722 self->mem##_count = 0; \
723 self->mem##_alloc = 0; \
726 #define MEM_VECTOR_CLEAR(owner, mem) \
728 mem_d((void*)((owner)->mem)); \
729 (owner)->mem = NULL; \
730 (owner)->mem##_count = 0; \
731 (owner)->mem##_alloc = 0
733 #define MEM_VECTOR_INIT(owner, mem) \
735 (owner)->mem = NULL; \
736 (owner)->mem##_count = 0; \
737 (owner)->mem##_alloc = 0; \
740 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
741 _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
742 _MEM_VEC_FUN_ADD(Tself, Twhat, mem)
744 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
745 MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
746 _MEM_VEC_FUN_CLEAR(Tself, mem) \
747 _MEM_VEC_FUN_FIND(Tself, Twhat, mem)
751 store_local, /* local, assignable for now, should get promoted later */
752 store_value /* unassignable */
760 * A shallow copy of a lex_file to remember where which ast node