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`.
56 # if __STDC_VERSION__ < 199901L && __GNUC__ < 3
59 # endif /* !__cplusplus */
62 * Of some functions which are generated we want to make sure
63 * that the result isn't ignored. To find such function calls,
66 #if defined(__GNUC__) || defined(__CLANG__)
67 # define GMQCC_WARN __attribute__((warn_unused_result))
72 * This is a hack to silent clang regarding empty
75 #define GMQCC_SUPRESS_EMPTY_BODY do { } while (0)
78 * Inline is not supported in < C90, however some compilers
79 * like gcc and clang might have an inline attribute we can
82 #if __STDC_VERSION__ < 199901L
83 # if defined(__GNUC__) || defined (__CLANG__)
87 # define GMQCC_INLINE __attribute__ ((always_inline))
93 # define GMQCC_INLINE inline
97 * stdint.h and inttypes.h -less subset
98 * for systems that don't have it, which we must
99 * assume is all systems. (int8_t not required)
102 typedef unsigned char uint8_t; /* same as below */
103 #elif SCHAR_MIN == -128
104 typedef unsigned char uint8_t; /* same as above */
106 #if SHRT_MAX == 0x7FFF
107 typedef short int16_t;
108 typedef unsigned short uint16_t;
109 #elif INT_MAX == 0x7FFF
111 typedef unsigned int uint16_t;
113 #if INT_MAX == 0x7FFFFFFF
115 typedef unsigned int uint32_t;
116 typedef long int64_t;
117 typedef unsigned long uint64_t;
118 #elif LONG_MAX == 0x7FFFFFFF
119 typedef long int32_t;
120 typedef unsigned long uint32_t;
123 * It's nearly impossible to figure out a 64bit type at
124 * this point without making assumptions about the build
125 * enviroment. So if clang or gcc is detected use some
126 * compiler builtins to create a 64 signed and unsigned
129 # if defined(__GNUC__) || defined (__CLANG__)
130 typedef int int64_t __attribute__((__mode__(__DI__)));
131 typedef unsigned int uint64_t __attribute__((__mode__(__DI__)));
134 * Incoorectly size the types so static assertions below will
135 * fail. There is no valid way to get a 64bit type at this point
136 * without making assumptions of too many things.
138 typedef char int64_t;
139 typedef char uint64_t;
142 #ifdef _LP64 /* long pointer == 64 */
143 typedef unsigned long uintptr_t;
144 typedef long intptr_t;
146 typedef unsigned int uintptr_t;
147 typedef int intptr_t;
149 /* Ensure type sizes are correct: */
150 typedef char uint8_size_is_correct [sizeof(uint8_t) == 1?1:-1];
151 typedef char uint16_size_if_correct [sizeof(uint16_t) == 2?1:-1];
152 typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
153 typedef char uint64_size_is_correct [sizeof(uint64_t) == 8?1:-1];
154 typedef char int16_size_if_correct [sizeof(int16_t) == 2?1:-1];
155 typedef char int32_size_is_correct [sizeof(int32_t) == 4?1:-1];
156 typedef char int64_size_is_correct [sizeof(int64_t) == 8?1:-1];
157 /* intptr_t / uintptr_t correct size check */
158 typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
159 typedef char intptr_size_is_correct [sizeof(uintptr_t)== sizeof(int*)?1:-1];
161 /*===================================================================*/
162 /*============================ lex.c ================================*/
163 /*===================================================================*/
164 typedef struct lex_file_t {
165 FILE *file; /* file handler */
166 char *name; /* name of file */
170 int last; /* last token */
171 int current; /* current token */
172 int length; /* bytes left to parse */
173 int size; /* never changes (size of file) */
174 int line; /* what line are we on? */
178 * It's important that this table never exceed 32 keywords, the ascii
179 * table starts at 33 (and we don't want conflicts)
190 TOKEN_FOR , /* extension */
191 TOKEN_TYPEDEF , /* extension */
193 /* ensure the token types are out of the */
194 /* bounds of anyothers that may conflict. */
203 * Lexer state constants, these are numbers for where exactly in
204 * the lexing the lexer is at. Or where it decided to stop if a lexer
205 * error occurs. These numbers must be > where the ascii-table ends
206 * and > the last type token which is TOKEN_VOID
215 int lex_token (lex_file *);
216 void lex_reset (lex_file *);
217 void lex_close (lex_file *);
218 void lex_parse (lex_file *);
219 lex_file *lex_include(lex_file *, const char *);
220 void lex_init (const char *, lex_file **);
222 /*===================================================================*/
223 /*========================== error.c ================================*/
224 /*===================================================================*/
225 #define ERROR_LEX (SHRT_MAX+0)
226 #define ERROR_PARSE (SHRT_MAX+1)
227 #define ERROR_INTERNAL (SHRT_MAX+2)
228 #define ERROR_COMPILER (SHRT_MAX+3)
229 #define ERROR_PREPRO (SHRT_MAX+4)
230 int error(lex_file *, int, const char *, ...);
232 /*===================================================================*/
233 /*========================== parse.c ================================*/
234 /*===================================================================*/
235 int parse_gen(lex_file *);
237 /*===================================================================*/
238 /*========================== typedef.c ==============================*/
239 /*===================================================================*/
240 typedef struct typedef_node_t {
245 void typedef_clear();
246 typedef_node *typedef_find(const char *);
247 int typedef_add (lex_file *file, const char *, const char *);
250 /*===================================================================*/
251 /*=========================== util.c ================================*/
252 /*===================================================================*/
253 void *util_memory_a (unsigned int, unsigned int, const char *);
254 void util_memory_d (void *, unsigned int, const char *);
255 void util_meminfo ();
257 bool util_strupper (const char *);
258 bool util_strdigit (const char *);
259 char *util_strdup (const char *);
260 char *util_strrq (const char *);
261 char *util_strrnl (const char *);
262 char *util_strsws (const char *);
263 char *util_strchp (const char *, const char *);
264 void util_debug (const char *, const char *, ...);
265 int util_getline (char **, size_t *, FILE *);
266 void util_endianswap (void *, int, int);
268 uint32_t util_crc32(const char *, int, register const short);
271 # define mem_a(x) malloc(x)
272 # define mem_d(x) free (x)
274 # define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
275 # define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
279 * TODO: make these safer to use. Currently this only works on
280 * x86 and x86_64, some systems will likely not like this. Such
283 #define FLT2INT(Y) *((int32_t*)&(Y))
284 #define INT2FLT(Y) *((float *)&(Y))
286 /* Builds vector type (usefull for inside structures) */
287 #define VECTOR_SNAP(X,Y) X ## Y
288 #define VECTOR_FILL(X,Y) VECTOR_SNAP(X,Y)
289 #define VECTOR_TYPE(T,N) \
290 T* N##_data = NULL; \
291 long N##_elements = 0; \
292 long N##_allocated = 0
293 /* Builds vector add */
294 #define VECTOR_CORE(T,N) \
295 int N##_add(T element) { \
297 if (N##_elements == N##_allocated) { \
298 if (N##_allocated == 0) { \
299 N##_allocated = 12; \
301 N##_allocated *= 2; \
303 if (!(temp = mem_a(N##_allocated * sizeof(T)))) { \
307 memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
309 N##_data = (T*)temp; \
311 N##_data[N##_elements] = element; \
312 return N##_elements++; \
314 int N##_put(T* elements, size_t len) { \
317 while (N##_add(*++elements) != -1 && len--); \
318 return N##_elements; \
320 typedef char VECTOR_FILL(extra_semicolon_,__COUNTER__)
321 /* Builds a full vector inspot */
322 #define VECTOR_MAKE(T,N) \
326 /*===================================================================*/
327 /*=========================== code.c ================================*/
328 /*===================================================================*/
343 * Each paramater incerements by 3 since vector types hold
344 * 3 components (x,y,z).
348 #define OFS_PARM0 (OFS_RETURN+3)
349 #define OFS_PARM1 (OFS_PARM0 +3)
350 #define OFS_PARM2 (OFS_PARM1 +3)
351 #define OFS_PARM3 (OFS_PARM2 +3)
352 #define OFS_PARM4 (OFS_PARM3 +3)
353 #define OFS_PARM5 (OFS_PARM4 +3)
354 #define OFS_PARM6 (OFS_PARM5 +3)
355 #define OFS_PARM7 (OFS_PARM6 +3)
362 int16_t s1; /* signed */
363 uint16_t u1; /* unsigned */
367 int16_t s2; /* signed */
368 uint16_t u2; /* unsigned */
372 int16_t s3; /* signed */
373 uint16_t u3; /* unsigned */
377 * This is the same as the structure in darkplaces
382 * But this one is more sane to work with, and the
383 * type sizes are guranteed.
385 } prog_section_statement;
396 * 7 = ev_pointer -- engine only
397 * 8 = ev_bad -- engine only
403 typedef prog_section_both prog_section_def;
404 typedef prog_section_both prog_section_field;
407 int32_t entry; /* in statement table for instructions */
408 uint32_t firstlocal; /* First local in local table */
409 uint32_t locals; /* Total ints of params + locals */
410 uint32_t profile; /* Always zero (engine uses this) */
411 uint32_t name; /* name of function in string table */
412 uint32_t file; /* file of the source file */
413 uint32_t nargs; /* number of arguments */
414 uint8_t argsize[8]; /* size of arguments (keep 8 always?) */
415 } prog_section_function;
419 * These are the external instructions supported by the interperter
420 * this is what things compile to (from the C code).
490 /* Virtual instructions used by the IR
499 * The symbols below are created by the following
502 * VECTOR_MAKE(prog_section_statement, code_statements);
503 * VECTOR_MAKE(prog_section_def, code_defs );
504 * VECTOR_MAKE(prog_section_field, code_fields );
505 * VECTOR_MAKE(prog_section_function, code_functions );
506 * VECTOR_MAKE(int, code_globals );
507 * VECTOR_MAKE(char, code_chars );
509 int code_statements_add(prog_section_statement);
510 int code_defs_add (prog_section_def);
511 int code_fields_add (prog_section_field);
512 int code_functions_add (prog_section_function);
513 int code_globals_add (int);
514 int code_chars_add (char);
515 int code_statements_put(prog_section_statement*, size_t);
516 int code_defs_put (prog_section_def*, size_t);
517 int code_fields_put (prog_section_field*, size_t);
518 int code_functions_put (prog_section_function*, size_t);
519 int code_globals_put (int*, size_t);
520 int code_chars_put (char*, size_t);
521 extern long code_statements_elements;
522 extern long code_chars_elements;
523 extern long code_globals_elements;
524 extern int *code_globals_data;
525 extern long code_functions_elements;
526 extern long code_fields_elements;
527 extern long code_defs_elements;
530 * code_write -- writes out the compiled file
531 * code_init -- prepares the code file
536 /*===================================================================*/
537 /*========================= assembler.c =============================*/
538 /*===================================================================*/
539 static const struct {
540 const char *m; /* menomic */
541 const size_t o; /* operands */
542 const size_t l; /* menomic len */
568 { "FIELD_F" , 0, 7 },
569 { "FIELD_V" , 0, 7 },
570 { "FIELD_S" , 0, 7 },
571 { "FIELD_ENT" , 0, 9 },
572 { "FIELD_FLD" , 0, 9 },
573 { "FIELD_FNC" , 0, 9 },
574 { "ADDRESS" , 0, 7 },
575 { "STORE_F" , 0, 7 },
576 { "STORE_V" , 0, 7 },
577 { "STORE_S" , 0, 7 },
578 { "STORE_ENT" , 0, 9 },
579 { "STORE_FLD" , 0, 9 },
580 { "STORE_FNC" , 0, 9 },
581 { "STOREP_F" , 0, 8 },
582 { "STOREP_V" , 0, 8 },
583 { "STOREP_S" , 0, 8 },
584 { "STOREP_ENT", 0, 10},
585 { "STOREP_FLD", 0, 10},
586 { "STOREP_FNC", 0, 10},
591 { "NOT_ENT" , 0, 7 },
592 { "NOT_FNC" , 0, 7 },
612 void asm_init (const char *, FILE **);
613 void asm_close(FILE *);
614 void asm_parse(FILE *);
615 /*===================================================================*/
616 /*============================= main.c ==============================*/
617 /*===================================================================*/
619 COMPILER_QCC, /* circa QuakeC */
620 COMPILER_FTEQCC, /* fteqcc QuakeC */
621 COMPILER_QCCX, /* qccx QuakeC */
622 COMPILER_GMQCC /* this QuakeC */
624 extern bool opts_debug;
625 extern bool opts_memchk;
626 extern bool opts_darkplaces_stringtablebug;
627 extern bool opts_omit_nullcode;
628 extern int opts_compiler;
629 /*===================================================================*/
630 /*============================= ast.c ===============================*/
631 /*===================================================================*/
632 #define MEM_VECTOR_PROTO(Towner, Tmem, mem) \
633 bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem); \
634 bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t)
636 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem) \
637 MEM_VECTOR_PROTO(Towner, Tmem, mem); \
638 bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
639 void Towner##_##mem##_clear(Towner*)
641 #define MEM_VECTOR_MAKE(Twhat, name) \
643 size_t name##_count; \
646 #define _MEM_VEC_FUN_ADD(Tself, Twhat, mem) \
647 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f) \
650 if (self->mem##_count == self->mem##_alloc) { \
651 if (!self->mem##_alloc) { \
652 self->mem##_alloc = 16; \
654 self->mem##_alloc *= 2; \
656 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc); \
660 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
664 self->mem[self->mem##_count++] = f; \
668 #define _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
669 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx) \
673 if (idx >= self->mem##_count) { \
674 return true; /* huh... */ \
676 for (i = idx; i < self->mem##_count-1; ++i) { \
677 self->mem[i] = self->mem[i+1]; \
679 self->mem##_count--; \
680 if (self->mem##_count < self->mem##_count/2) { \
681 self->mem##_alloc /= 2; \
682 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count); \
686 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
693 #define _MEM_VEC_FUN_FIND(Tself, Twhat, mem) \
694 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
697 for (i = 0; i < self->mem##_count; ++i) { \
698 if (self->mem[i] == obj) { \
708 #define _MEM_VEC_FUN_CLEAR(Tself, mem) \
709 void Tself##_##mem##_clear(Tself *self) \
713 mem_d((void*) self->mem); \
715 self->mem##_count = 0; \
716 self->mem##_alloc = 0; \
719 #define MEM_VECTOR_CLEAR(owner, mem) \
721 mem_d((void*)((owner)->mem)); \
722 (owner)->mem = NULL; \
723 (owner)->mem##_count = 0; \
724 (owner)->mem##_alloc = 0
726 #define MEM_VECTOR_INIT(owner, mem) \
728 (owner)->mem = NULL; \
729 (owner)->mem##_count = 0; \
730 (owner)->mem##_alloc = 0; \
733 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
734 _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
735 _MEM_VEC_FUN_ADD(Tself, Twhat, mem)
737 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
738 MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
739 _MEM_VEC_FUN_CLEAR(Tself, mem) \
740 _MEM_VEC_FUN_FIND(Tself, Twhat, mem)
744 store_local, /* local, assignable for now, should get promoted later */
745 store_value /* unassignable */
753 * A shallow copy of a lex_file to remember where which ast node