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))
73 * stdint.h and inttypes.h -less subset
74 * for systems that don't have it, which we must
75 * assume is all systems. (int8_t not required)
78 typedef unsigned char uint8_t; /* same as below */
79 #elif SCHAR_MIN == -128
80 typedef unsigned char uint8_t; /* same as above */
82 #if SHRT_MAX == 0x7FFF
83 typedef short int16_t;
84 typedef unsigned short uint16_t;
85 #elif INT_MAX == 0x7FFF
87 typedef unsigned int uint16_t;
89 #if INT_MAX == 0x7FFFFFFF
91 typedef unsigned int uint32_t;
92 #elif LONG_MAX == 0x7FFFFFFF
94 typedef unsigned long uint32_t;
96 #ifdef _LP64 /* long pointer == 64 */
97 typedef unsigned long uintptr_t;
98 typedef long intptr_t;
100 typedef unsigned int uintptr_t;
101 typedef int intptr_t;
103 /* Ensure type sizes are correct: */
104 typedef char uint8_size_is_correct [sizeof(uint8_t) == 1?1:-1];
105 typedef char uint16_size_if_correct [sizeof(uint16_t) == 2?1:-1];
106 typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
107 typedef char int16_size_if_correct [sizeof(int16_t) == 2?1:-1];
108 typedef char int32_size_is_correct [sizeof(int32_t) == 4?1:-1];
109 /* intptr_t / uintptr_t correct size check */
110 typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
111 typedef char intptr_size_is_correct [sizeof(uintptr_t)== sizeof(int*)?1:-1];
113 //===================================================================
114 //============================ lex.c ================================
115 //===================================================================
117 FILE *file; /* file handler */
118 char *name; /* name of file */
122 int last; /* last token */
123 int current; /* current token */
124 int length; /* bytes left to parse */
125 int size; /* never changes (size of file) */
126 int line; /* what line are we on? */
130 * It's important that this table never exceed 32 keywords, the ascii
131 * table starts at 33 (and we don't want conflicts)
142 TOKEN_FOR , // extension
143 TOKEN_TYPEDEF , // extension
145 // ensure the token types are out of the
146 // bounds of anyothers that may conflict.
155 * Lexer state constants, these are numbers for where exactly in
156 * the lexing the lexer is at. Or where it decided to stop if a lexer
157 * error occurs. These numbers must be > where the ascii-table ends
158 * and > the last type token which is TOKEN_VOID
167 int lex_token (struct lex_file *);
168 void lex_reset (struct lex_file *);
169 void lex_close (struct lex_file *);
170 struct lex_file *lex_include(struct lex_file *, char *);
171 struct lex_file *lex_open (FILE *);
173 //===================================================================
174 //========================== error.c ================================
175 //===================================================================
176 #define ERROR_LEX (SHRT_MAX+0)
177 #define ERROR_PARSE (SHRT_MAX+1)
178 #define ERROR_INTERNAL (SHRT_MAX+2)
179 #define ERROR_COMPILER (SHRT_MAX+3)
180 #define ERROR_PREPRO (SHRT_MAX+4)
181 int error(struct lex_file *, int, const char *, ...);
183 //===================================================================
184 //========================== parse.c ================================
185 //===================================================================
186 int parse_gen(struct lex_file *);
188 //===================================================================
189 //========================== typedef.c ==============================
190 //===================================================================
191 typedef struct typedef_node_t {
196 void typedef_clear();
197 typedef_node *typedef_find(const char *);
198 int typedef_add (struct lex_file *file, const char *, const char *);
201 //===================================================================
202 //=========================== util.c ================================
203 //===================================================================
204 void *util_memory_a (unsigned int, unsigned int, const char *);
205 void util_memory_d (void *, unsigned int, const char *);
206 void util_meminfo ();
208 bool util_strupper (const char *);
209 bool util_strdigit (const char *);
210 char *util_strdup (const char *);
211 char *util_strrq (char *);
212 char *util_strrnl (char *);
213 char *util_strsws (const char *);
214 char *util_strchp (const char *, const char *);
215 void util_debug (const char *, const char *, ...);
216 int util_getline (char **, size_t *, FILE *);
217 void util_endianswap (void *, int, int);
219 uint32_t util_crc32(const char *, int, register const short);
222 # define mem_a(x) malloc(x)
223 # define mem_d(x) free (x)
225 # define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
226 # define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
229 /* Builds vector type (usefull for inside structures) */
230 #define VECTOR_TYPE(T,N) \
231 T* N##_data = NULL; \
232 long N##_elements = 0; \
233 long N##_allocated = 0
234 /* Builds vector add */
235 #define VECTOR_CORE(T,N) \
236 int N##_add(T element) { \
237 if (N##_elements == N##_allocated) { \
238 if (N##_allocated == 0) { \
239 N##_allocated = 12; \
241 N##_allocated *= 2; \
243 void *temp = mem_a(N##_allocated * sizeof(T)); \
248 memcpy(temp, N##_data, (N##_elements * sizeof(T))); \
250 N##_data = (T*)temp; \
252 N##_data[N##_elements] = element; \
253 return N##_elements++; \
255 int N##_put(T* elements, size_t len) { \
258 while (N##_add(*++elements) != -1 && len--); \
259 return N##_elements; \
261 /* Builds a full vector inspot */
262 #define VECTOR_MAKE(T,N) \
265 /* Builds a vector add function pointer for inside structures */
266 #define VECTOR_IMPL(T,N) int (*N##_add)(T)
268 //===================================================================
269 //=========================== code.c ================================
270 //===================================================================
285 * Each paramater incerements by 3 since vector types hold
286 * 3 components (x,y,z).
290 #define OFS_PARM0 (OFS_RETURN+3)
291 #define OFS_PARM1 (OFS_PARM0 +3)
292 #define OFS_PARM2 (OFS_PARM1 +3)
293 #define OFS_PARM3 (OFS_PARM2 +3)
294 #define OFS_PARM4 (OFS_PARM3 +3)
295 #define OFS_PARM5 (OFS_PARM4 +3)
296 #define OFS_PARM6 (OFS_PARM5 +3)
297 #define OFS_PARM7 (OFS_PARM6 +3)
304 int16_t s1; /* signed */
305 uint16_t u1; /* unsigned */
309 int16_t s2; /* signed */
310 uint16_t u2; /* unsigned */
314 int16_t s3; /* signed */
315 uint16_t u3; /* unsigned */
319 * This is the same as the structure in darkplaces
324 * But this one is more sane to work with, and the
325 * type sizes are guranteed.
327 } prog_section_statement;
338 * 7 = ev_pointer -- engine only
339 * 8 = ev_bad -- engine only
345 typedef prog_section_both prog_section_def;
346 typedef prog_section_both prog_section_field;
349 int32_t entry; /* in statement table for instructions */
350 uint32_t firstlocal; /* First local in local table */
351 uint32_t locals; /* Total ints of params + locals */
352 uint32_t profile; /* Always zero (engine uses this) */
353 uint32_t name; /* name of function in string table */
354 uint32_t file; /* file of the source file */
355 uint32_t nargs; /* number of arguments */
356 uint8_t argsize[8]; /* size of arguments (keep 8 always?) */
357 } prog_section_function;
361 * These are the external instructions supported by the interperter
362 * this is what things compile to (from the C code).
432 /* Virtual instructions used by the IR
441 * The symbols below are created by the following
444 * VECTOR_MAKE(prog_section_statement, code_statements);
445 * VECTOR_MAKE(prog_section_def, code_defs );
446 * VECTOR_MAKE(prog_section_field, code_fields );
447 * VECTOR_MAKE(prog_section_function, code_functions );
448 * VECTOR_MAKE(int, code_globals );
449 * VECTOR_MAKE(char, code_chars );
451 int code_statements_add(prog_section_statement);
452 int code_defs_add (prog_section_def);
453 int code_fields_add (prog_section_field);
454 int code_functions_add (prog_section_function);
455 int code_globals_add (int);
456 int code_chars_add (char);
457 int code_statements_put(prog_section_statement*, size_t);
458 int code_defs_put (prog_section_def*, size_t);
459 int code_fields_put (prog_section_field*, size_t);
460 int code_functions_put (prog_section_function*, size_t);
461 int code_globals_put (int*, size_t);
462 int code_chars_put (char*, size_t);
463 extern long code_statements_elements;
464 extern long code_chars_elements;
465 extern long code_globals_elements;
466 extern long code_functions_elements;
467 extern long code_fields_elements;
468 extern long code_defs_elements;
471 * code_write -- writes out the compiled file
472 * code_init -- prepares the code file
477 //===================================================================
478 //========================= assembler.c =============================
479 //===================================================================
480 static const struct {
481 const char *m; /* menomic */
482 const size_t o; /* operands */
483 const size_t l; /* menomic len */
484 } const asm_instr[] = {
485 [INSTR_DONE] = { "DONE" , 1, 4 },
486 [INSTR_MUL_F] = { "MUL_F" , 3, 5 },
487 [INSTR_MUL_V] = { "MUL_V" , 3, 5 },
488 [INSTR_MUL_FV] = { "MUL_FV" , 3, 6 },
489 [INSTR_MUL_VF] = { "MUL_VF" , 3, 6 },
490 [INSTR_DIV_F] = { "DIV" , 0, 3 },
491 [INSTR_ADD_F] = { "ADD_F" , 3, 5 },
492 [INSTR_ADD_V] = { "ADD_V" , 3, 5 },
493 [INSTR_SUB_F] = { "SUB_F" , 3, 5 },
494 [INSTR_SUB_V] = { "DUB_V" , 3, 5 },
495 [INSTR_EQ_F] = { "EQ_F" , 0, 4 },
496 [INSTR_EQ_V] = { "EQ_V" , 0, 4 },
497 [INSTR_EQ_S] = { "EQ_S" , 0, 4 },
498 [INSTR_EQ_E] = { "EQ_E" , 0, 4 },
499 [INSTR_EQ_FNC] = { "ES_FNC" , 0, 6 },
500 [INSTR_NE_F] = { "NE_F" , 0, 4 },
501 [INSTR_NE_V] = { "NE_V" , 0, 4 },
502 [INSTR_NE_S] = { "NE_S" , 0, 4 },
503 [INSTR_NE_E] = { "NE_E" , 0, 4 },
504 [INSTR_NE_FNC] = { "NE_FNC" , 0, 6 },
505 [INSTR_LE] = { "LE" , 0, 2 },
506 [INSTR_GE] = { "GE" , 0, 2 },
507 [INSTR_LT] = { "LT" , 0, 2 },
508 [INSTR_GT] = { "GT" , 0, 2 },
509 [INSTR_LOAD_F] = { "FIELD_F" , 0, 7 },
510 [INSTR_LOAD_V] = { "FIELD_V" , 0, 7 },
511 [INSTR_LOAD_S] = { "FIELD_S" , 0, 7 },
512 [INSTR_LOAD_ENT] = { "FIELD_ENT" , 0, 9 },
513 [INSTR_LOAD_FLD] = { "FIELD_FLD" , 0, 9 },
514 [INSTR_LOAD_FNC] = { "FIELD_FNC" , 0, 9 },
515 [INSTR_ADDRESS] = { "ADDRESS" , 0, 7 },
516 [INSTR_STORE_F] = { "STORE_F" , 0, 7 },
517 [INSTR_STORE_V] = { "STORE_V" , 0, 7 },
518 [INSTR_STORE_S] = { "STORE_S" , 0, 7 },
519 [INSTR_STORE_ENT] = { "STORE_ENT" , 0, 9 },
520 [INSTR_STORE_FLD] = { "STORE_FLD" , 0, 9 },
521 [INSTR_STORE_FNC] = { "STORE_FNC" , 0, 9 },
522 [INSTR_STOREP_F] = { "STOREP_F" , 0, 8 },
523 [INSTR_STOREP_V] = { "STOREP_V" , 0, 8 },
524 [INSTR_STOREP_S] = { "STOREP_S" , 0, 8 },
525 [INSTR_STOREP_ENT] = { "STOREP_ENT", 0, 10},
526 [INSTR_STOREP_FLD] = { "STOREP_FLD", 0, 10},
527 [INSTR_STOREP_FNC] = { "STOREP_FNC", 0, 10},
528 [INSTR_RETURN] = { "RETURN" , 0, 6 },
529 [INSTR_NOT_F] = { "NOT_F" , 0, 5 },
530 [INSTR_NOT_V] = { "NOT_V" , 0, 5 },
531 [INSTR_NOT_S] = { "NOT_S" , 0, 5 },
532 [INSTR_NOT_ENT] = { "NOT_ENT" , 0, 7 },
533 [INSTR_NOT_FNC] = { "NOT_FNC" , 0, 7 },
534 [INSTR_IF] = { "IF" , 0, 2 },
535 [INSTR_IFNOT] = { "IFNOT" , 0, 5 },
536 [INSTR_CALL0] = { "CALL0" , 0, 5 },
537 [INSTR_CALL1] = { "CALL1" , 0, 5 },
538 [INSTR_CALL2] = { "CALL2" , 0, 5 },
539 [INSTR_CALL3] = { "CALL3" , 0, 5 },
540 [INSTR_CALL4] = { "CALL4" , 0, 5 },
541 [INSTR_CALL5] = { "CALL5" , 0, 5 },
542 [INSTR_CALL6] = { "CALL6" , 0, 5 },
543 [INSTR_CALL7] = { "CALL7" , 0, 5 },
544 [INSTR_CALL8] = { "CALL8" , 0, 5 },
545 [INSTR_STATE] = { "STATE" , 0, 5 },
546 [INSTR_GOTO] = { "GOTO" , 0, 4 },
547 [INSTR_AND] = { "AND" , 0, 3 },
548 [INSTR_OR] = { "OR" , 0, 2 },
549 [INSTR_BITAND] = { "BITAND" , 0, 6 },
550 [INSTR_BITOR] = { "BITOR" , 0, 5 }
553 void asm_init (const char *, FILE **);
554 void asm_close(FILE *);
555 void asm_parse(FILE *);
556 //======================================================================
557 //============================= main.c =================================
558 //======================================================================
560 COMPILER_QCC, /* circa QuakeC */
561 COMPILER_FTEQCC, /* fteqcc QuakeC */
562 COMPILER_QCCX, /* qccx QuakeC */
563 COMPILER_GMQCC /* this QuakeC */
565 extern bool opts_debug;
566 extern bool opts_memchk;
567 extern bool opts_darkplaces_stringtablebug;
568 extern bool opts_omit_nullcode;
569 extern int opts_compiler;
570 //======================================================================
571 //============================= ast.c ==================================
572 //======================================================================
573 #define MEM_VECTOR_PROTO(Towner, Tmem, mem) \
574 bool GMQCC_WARN Towner##_##mem##_add(Towner*, Tmem); \
575 bool GMQCC_WARN Towner##_##mem##_remove(Towner*, size_t);
577 #define MEM_VECTOR_PROTO_ALL(Towner, Tmem, mem) \
578 MEM_VECTOR_PROTO(Towner, Tmem, mem) \
579 bool GMQCC_WARN Towner##_##mem##_find(Towner*, Tmem, size_t*); \
580 void Towner##_##mem##_clear(Towner*);
582 #define MEM_VECTOR_MAKE(Twhat, name) \
584 size_t name##_count; \
587 #define _MEM_VEC_FUN_ADD(Tself, Twhat, mem) \
588 bool GMQCC_WARN Tself##_##mem##_add(Tself *self, Twhat f) \
591 if (self->mem##_count == self->mem##_alloc) { \
592 if (!self->mem##_alloc) { \
593 self->mem##_alloc = 16; \
595 self->mem##_alloc *= 2; \
597 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_alloc); \
601 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
605 self->mem[self->mem##_count++] = f; \
609 #define _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
610 bool GMQCC_WARN Tself##_##mem##_remove(Tself *self, size_t idx) \
614 if (idx >= self->mem##_count) { \
615 return true; /* huh... */ \
617 for (i = idx; i < self->mem##_count-1; ++i) { \
618 self->mem[i] = self->mem[i+1]; \
620 self->mem##_count--; \
621 if (self->mem##_count < self->mem##_count/2) { \
622 self->mem##_alloc /= 2; \
623 reall = (Twhat*)mem_a(sizeof(Twhat) * self->mem##_count); \
627 memcpy(reall, self->mem, sizeof(Twhat) * self->mem##_count); \
634 #define _MEM_VEC_FUN_FIND(Tself, Twhat, mem) \
635 bool GMQCC_WARN Tself##_##mem##_find(Tself *self, Twhat obj, size_t *idx) \
638 for (i = 0; i < self->mem##_count; ++i) { \
639 if (self->mem[i] == obj) { \
649 #define _MEM_VEC_FUN_CLEAR(Tself, mem) \
650 void Tself##_##mem##_clear(Tself *self) \
654 free((void*) self->mem); \
656 self->mem##_count = 0; \
657 self->mem##_alloc = 0; \
660 #define MEM_VECTOR_CLEAR(owner, mem) \
662 free((void*)((owner)->mem)); \
663 (owner)->mem = NULL; \
664 (owner)->mem##_count = 0; \
665 (owner)->mem##_alloc = 0
667 #define MEM_VECTOR_INIT(owner, mem) \
669 (owner)->mem = NULL; \
670 (owner)->mem##_count = 0; \
671 (owner)->mem##_alloc = 0; \
674 #define MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
675 _MEM_VEC_FUN_REMOVE(Tself, Twhat, mem) \
676 _MEM_VEC_FUN_ADD(Tself, Twhat, mem)
678 #define MEM_VEC_FUNCTIONS_ALL(Tself, Twhat, mem) \
679 MEM_VEC_FUNCTIONS(Tself, Twhat, mem) \
680 _MEM_VEC_FUN_CLEAR(Tself, mem) \
681 _MEM_VEC_FUN_FIND(Tself, Twhat, mem)
685 store_local, /* local, assignable for now, should get promoted later */
686 store_value, /* unassignable */
694 * A shallow copy of a lex_file to remember where which ast node
697 typedef struct lex_ctx {