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;
122 /* bail on 64 bit type! */
123 typedef char int64_t;
124 typedef char uint64_t;
126 #ifdef _LP64 /* long pointer == 64 */
127 typedef unsigned long uintptr_t;
128 typedef long intptr_t;
130 typedef unsigned int uintptr_t;
131 typedef int intptr_t;
133 /* Ensure type sizes are correct: */
134 typedef char uint8_size_is_correct [sizeof(uint8_t) == 1?1:-1];
135 typedef char uint16_size_if_correct [sizeof(uint16_t) == 2?1:-1];
136 typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
137 typedef char uint64_size_is_correct [sizeof(uint64_t) == 8?1:-1];
138 typedef char int16_size_if_correct [sizeof(int16_t) == 2?1:-1];
139 typedef char int32_size_is_correct [sizeof(int32_t) == 4?1:-1];
140 typedef char int64_size_is_correct [sizeof(int64_t) == 8?1:-1];
141 /* intptr_t / uintptr_t correct size check */
142 typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
143 typedef char intptr_size_is_correct [sizeof(uintptr_t)== sizeof(int*)?1:-1];
145 /*===================================================================*/
146 /*============================ lex.c ================================*/
147 /*===================================================================*/
148 typedef struct lex_file_t {
149 FILE *file; /* file handler */
150 char *name; /* name of file */
154 int last; /* last token */
155 int current; /* current token */
156 int length; /* bytes left to parse */
157 int size; /* never changes (size of file) */
158 int line; /* what line are we on? */
162 * It's important that this table never exceed 32 keywords, the ascii
163 * table starts at 33 (and we don't want conflicts)
174 TOKEN_FOR , /* extension */
175 TOKEN_TYPEDEF , /* extension */
177 /* ensure the token types are out of the */
178 /* bounds of anyothers that may conflict. */
187 * Lexer state constants, these are numbers for where exactly in
188 * the lexing the lexer is at. Or where it decided to stop if a lexer
189 * error occurs. These numbers must be > where the ascii-table ends
190 * and > the last type token which is TOKEN_VOID
199 int lex_token (lex_file *);
200 void lex_reset (lex_file *);
201 void lex_close (lex_file *);
202 void lex_parse (lex_file *);
203 lex_file *lex_include(lex_file *, const char *);
204 void lex_init (const char *, lex_file **);
206 /*===================================================================*/
207 /*========================== error.c ================================*/
208 /*===================================================================*/
209 #define ERROR_LEX (SHRT_MAX+0)
210 #define ERROR_PARSE (SHRT_MAX+1)
211 #define ERROR_INTERNAL (SHRT_MAX+2)
212 #define ERROR_COMPILER (SHRT_MAX+3)
213 #define ERROR_PREPRO (SHRT_MAX+4)
214 int error(lex_file *, int, const char *, ...);
216 /*===================================================================*/
217 /*========================== parse.c ================================*/
218 /*===================================================================*/
219 int parse_gen(lex_file *);
221 /*===================================================================*/
222 /*========================== typedef.c ==============================*/
223 /*===================================================================*/
224 typedef struct typedef_node_t {
229 void typedef_clear();
230 typedef_node *typedef_find(const char *);
231 int typedef_add (lex_file *file, const char *, const char *);
234 /*===================================================================*/
235 /*=========================== util.c ================================*/
236 /*===================================================================*/
237 void *util_memory_a (unsigned int, unsigned int, const char *);
238 void util_memory_d (void *, unsigned int, const char *);
239 void util_meminfo ();
241 bool util_strupper (const char *);
242 bool util_strdigit (const char *);
243 char *util_strdup (const char *);
244 char *util_strrq (const char *);
245 char *util_strrnl (const char *);
246 char *util_strsws (const char *);
247 char *util_strchp (const char *, const char *);
248 void util_debug (const char *, const char *, ...);
249 int util_getline (char **, size_t *, FILE *);
250 void util_endianswap (void *, int, int);
252 uint32_t util_crc32(const char *, int, register const short);
255 # define mem_a(x) malloc(x)
256 # define mem_d(x) free (x)
258 # define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
259 # define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
262 /* Builds vector type (usefull for inside structures) */
263 #define VECTOR_SNAP(X,Y) X ## Y
264 #define VECTOR_FILL(X,Y) VECTOR_SNAP(X,Y)
265 #define VECTOR_TYPE(T,N) \
266 T* N##_data = NULL; \
267 long N##_elements = 0; \
268 long N##_allocated = 0
269 /* Builds vector add */
270 #define VECTOR_CORE(T,N) \
271 int N##_add(T element) { \
273 if (N##_elements == N##_allocated) { \
274 if (N##_allocated == 0) { \
275 N##_allocated = 12; \
277 N##_allocated *= 2; \
279 if (!(temp = mem_a(N##_allocated * sizeof(T)))) { \
283 memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
285 N##_data = (T*)temp; \
287 N##_data[N##_elements] = element; \
288 return N##_elements++; \
290 int N##_put(T* elements, size_t len) { \
293 while (N##_add(*++elements) != -1 && len--); \
294 return N##_elements; \
296 typedef char VECTOR_FILL(extra_semicolon_,__COUNTER__)
297 /* Builds a full vector inspot */
298 #define VECTOR_MAKE(T,N) \
302 /*===================================================================*/
303 /*=========================== code.c ================================*/
304 /*===================================================================*/
319 * Each paramater incerements by 3 since vector types hold
320 * 3 components (x,y,z).
324 #define OFS_PARM0 (OFS_RETURN+3)
325 #define OFS_PARM1 (OFS_PARM0 +3)
326 #define OFS_PARM2 (OFS_PARM1 +3)
327 #define OFS_PARM3 (OFS_PARM2 +3)
328 #define OFS_PARM4 (OFS_PARM3 +3)
329 #define OFS_PARM5 (OFS_PARM4 +3)
330 #define OFS_PARM6 (OFS_PARM5 +3)
331 #define OFS_PARM7 (OFS_PARM6 +3)
338 int16_t s1; /* signed */
339 uint16_t u1; /* unsigned */
343 int16_t s2; /* signed */
344 uint16_t u2; /* unsigned */
348 int16_t s3; /* signed */
349 uint16_t u3; /* unsigned */
353 * This is the same as the structure in darkplaces
358 * But this one is more sane to work with, and the
359 * type sizes are guranteed.
361 } prog_section_statement;
372 * 7 = ev_pointer -- engine only
373 * 8 = ev_bad -- engine only
379 typedef prog_section_both prog_section_def;
380 typedef prog_section_both prog_section_field;
383 int32_t entry; /* in statement table for instructions */
384 uint32_t firstlocal; /* First local in local table */
385 uint32_t locals; /* Total ints of params + locals */
386 uint32_t profile; /* Always zero (engine uses this) */
387 uint32_t name; /* name of function in string table */
388 uint32_t file; /* file of the source file */
389 uint32_t nargs; /* number of arguments */
390 uint8_t argsize[8]; /* size of arguments (keep 8 always?) */
391 } prog_section_function;
395 * These are the external instructions supported by the interperter
396 * this is what things compile to (from the C code).
466 /* Virtual instructions used by the IR
475 * The symbols below are created by the following
478 * VECTOR_MAKE(prog_section_statement, code_statements);
479 * VECTOR_MAKE(prog_section_def, code_defs );
480 * VECTOR_MAKE(prog_section_field, code_fields );
481 * VECTOR_MAKE(prog_section_function, code_functions );
482 * VECTOR_MAKE(int, code_globals );
483 * VECTOR_MAKE(char, code_chars );
485 int code_statements_add(prog_section_statement);
486 int code_defs_add (prog_section_def);
487 int code_fields_add (prog_section_field);
488 int code_functions_add (prog_section_function);
489 int code_globals_add (int);
490 int code_chars_add (char);
491 int code_statements_put(prog_section_statement*, size_t);
492 int code_defs_put (prog_section_def*, size_t);
493 int code_fields_put (prog_section_field*, size_t);
494 int code_functions_put (prog_section_function*, size_t);
495 int code_globals_put (int*, size_t);
496 int code_chars_put (char*, size_t);
497 extern long code_statements_elements;
498 extern long code_chars_elements;
499 extern long code_globals_elements;
500 extern long code_functions_elements;
501 extern long code_fields_elements;
502 extern long code_defs_elements;
505 * code_write -- writes out the compiled file
506 * code_init -- prepares the code file
511 /*===================================================================*/
512 /*========================= assembler.c =============================*/
513 /*===================================================================*/
514 static const struct {
515 const char *m; /* menomic */
516 const size_t o; /* operands */
517 const size_t l; /* menomic len */
543 { "FIELD_F" , 0, 7 },
544 { "FIELD_V" , 0, 7 },
545 { "FIELD_S" , 0, 7 },
546 { "FIELD_ENT" , 0, 9 },
547 { "FIELD_FLD" , 0, 9 },
548 { "FIELD_FNC" , 0, 9 },
549 { "ADDRESS" , 0, 7 },
550 { "STORE_F" , 0, 7 },
551 { "STORE_V" , 0, 7 },
552 { "STORE_S" , 0, 7 },
553 { "STORE_ENT" , 0, 9 },
554 { "STORE_FLD" , 0, 9 },
555 { "STORE_FNC" , 0, 9 },
556 { "STOREP_F" , 0, 8 },
557 { "STOREP_V" , 0, 8 },
558 { "STOREP_S" , 0, 8 },
559 { "STOREP_ENT", 0, 10},
560 { "STOREP_FLD", 0, 10},
561 { "STOREP_FNC", 0, 10},
566 { "NOT_ENT" , 0, 7 },
567 { "NOT_FNC" , 0, 7 },
587 void asm_init (const char *, FILE **);
588 void asm_close(FILE *);
589 void asm_parse(FILE *);
590 /*===================================================================*/
591 /*============================= main.c ==============================*/
592 /*===================================================================*/
594 COMPILER_QCC, /* circa QuakeC */
595 COMPILER_FTEQCC, /* fteqcc QuakeC */
596 COMPILER_QCCX, /* qccx QuakeC */
597 COMPILER_GMQCC /* this QuakeC */
599 extern bool opts_debug;
600 extern bool opts_memchk;
601 extern bool opts_darkplaces_stringtablebug;
602 extern bool opts_omit_nullcode;
603 extern int opts_compiler;
604 /*===================================================================*/
605 /*============================= ast.c ===============================*/
606 /*===================================================================*/
607 #define MEM_VECTOR_PROTO(Towner, Tmem, mem) \
608 bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem); \
609 bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t)
611 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem) \
612 MEM_VECTOR_PROTO(Towner, Tmem, mem); \
613 bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
614 void Towner##_##mem##_clear(Towner*)
616 #define MEM_VECTOR_MAKE(Twhat, name) \
618 size_t name##_count; \
621 #define _MEM_VEC_FUN_ADD(Tself, Twhat, mem) \
622 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f) \
625 if (self->mem##_count == self->mem##_alloc) { \
626 if (!self->mem##_alloc) { \
627 self->mem##_alloc = 16; \
629 self->mem##_alloc *= 2; \
631 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc); \
635 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
639 self->mem[self->mem##_count++] = f; \
643 #define _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
644 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx) \
648 if (idx >= self->mem##_count) { \
649 return true; /* huh... */ \
651 for (i = idx; i < self->mem##_count-1; ++i) { \
652 self->mem[i] = self->mem[i+1]; \
654 self->mem##_count--; \
655 if (self->mem##_count < self->mem##_count/2) { \
656 self->mem##_alloc /= 2; \
657 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count); \
661 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
668 #define _MEM_VEC_FUN_FIND(Tself, Twhat, mem) \
669 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
672 for (i = 0; i < self->mem##_count; ++i) { \
673 if (self->mem[i] == obj) { \
683 #define _MEM_VEC_FUN_CLEAR(Tself, mem) \
684 void Tself##_##mem##_clear(Tself *self) \
688 mem_d((void*) self->mem); \
690 self->mem##_count = 0; \
691 self->mem##_alloc = 0; \
694 #define MEM_VECTOR_CLEAR(owner, mem) \
696 mem_d((void*)((owner)->mem)); \
697 (owner)->mem = NULL; \
698 (owner)->mem##_count = 0; \
699 (owner)->mem##_alloc = 0
701 #define MEM_VECTOR_INIT(owner, mem) \
703 (owner)->mem = NULL; \
704 (owner)->mem##_count = 0; \
705 (owner)->mem##_alloc = 0; \
708 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
709 _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
710 _MEM_VEC_FUN_ADD(Tself, Twhat, mem)
712 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
713 MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
714 _MEM_VEC_FUN_CLEAR(Tself, mem) \
715 _MEM_VEC_FUN_FIND(Tself, Twhat, mem)
719 store_local, /* local, assignable for now, should get promoted later */
720 store_value /* unassignable */
728 * A shallow copy of a lex_file to remember where which ast node