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
33 * Disable some over protective warnings in visual studio because fixing them is a waste
37 # pragma warning(disable : 4244 ) /* conversion from 'int' to 'float', possible loss of data */
38 # pragma warning(disable : 4018 ) /* signed/unsigned mismatch */
39 # pragma warning(disable : 4996 ) /* This function or variable may be unsafe */
40 # pragma warning(disable : 4700 ) /* uninitialized local variable used */
43 #define GMQCC_VERSION_MAJOR 0
44 #define GMQCC_VERSION_MINOR 2
45 #define GMQCC_VERSION_PATCH 0
46 #define GMQCC_VERSION_BUILD(J,N,P) (((J)<<16)|((N)<<8)|(P))
47 #define GMQCC_VERSION \
48 GMQCC_VERSION_BUILD(GMQCC_VERSION_MAJOR, GMQCC_VERSION_MINOR, GMQCC_VERSION_PATCH)
51 * We cannoy rely on C99 at all, since compilers like MSVC
52 * simply don't support it. We define our own boolean type
53 * as a result (since we cannot include <stdbool.h>). For
54 * compilers that are in 1999 mode (C99 compliant) we can use
55 * the language keyword _Bool which can allow for better code
56 * on GCC and GCC-like compilers, opposed to `int`.
67 # ifdef __STDC_VERSION__
68 # if __STDC_VERSION__ < 199901L && __GNUC__ < 3
75 # endif /* !__STDC_VERSION__ */
76 #endif /* !__cplusplus */
79 * Of some functions which are generated we want to make sure
80 * that the result isn't ignored. To find such function calls,
83 #if defined(__GNUC__) || defined(__CLANG__)
84 # define GMQCC_WARN __attribute__((warn_unused_result))
89 * This is a hack to silent clang regarding empty
92 #define GMQCC_SUPPRESS_EMPTY_BODY do { } while (0)
95 * Inline is not supported in < C90, however some compilers
96 * like gcc and clang might have an inline attribute we can
99 #ifdef __STDC_VERSION__
100 # if __STDC_VERSION__ < 199901L
101 # if defined(__GNUC__) || defined (__CLANG__)
103 # define GMQCC_INLINE
105 # define GMQCC_INLINE __attribute__ ((always_inline))
108 # define GMQCC_INLINE
111 # define GMQCC_INLINE inline
114 * Visual studio has __forcinline we can use. So lets use that
115 * I suspect it also has just __inline of some sort, but our use
116 * of inline is correct (not guessed), WE WANT IT TO BE INLINE
118 #elseif defined(_MSC_VER)
119 # define GMQCC_INLINE __forceinline
121 # define GMQCC_INLINE
122 #endif /* !__STDC_VERSION__ */
125 * noreturn is present in GCC and clang
126 * it's required for _ast_node_destory otherwise -Wmissing-noreturn
127 * in clang complains about there being no return since abort() is
130 #if (defined(__GNUC__) && __GNUC__ >= 2) || defined(__CLANG__)
131 # define GMQCC_NORETURN __attribute__ ((noreturn))
133 # define GMQCC_NORETURN
137 * stdint.h and inttypes.h -less subset
138 * for systems that don't have it, which we must
139 * assume is all systems. (int8_t not required)
142 typedef unsigned char uint8_t; /* same as below */
143 #elif SCHAR_MIN == -128
144 typedef unsigned char uint8_t; /* same as above */
146 #if SHRT_MAX == 0x7FFF
147 typedef short int16_t;
148 typedef unsigned short uint16_t;
149 #elif INT_MAX == 0x7FFF
151 typedef unsigned int uint16_t;
153 #if INT_MAX == 0x7FFFFFFF
155 typedef unsigned int uint32_t;
156 #elif LONG_MAX == 0x7FFFFFFF
157 typedef long int32_t;
158 typedef unsigned long uint32_t;
162 #if defined(__GNUC__) || defined (__CLANG__)
163 typedef int int64_t __attribute__((__mode__(__DI__)));
164 typedef unsigned int uint64_t __attribute__((__mode__(__DI__)));
165 #elif defined(_MSC_VER)
166 typedef __int64 int64_t;
167 typedef unsigned __int64 uint64_t;
170 * Incorrectly size the types so static assertions below will
171 * fail. There is no valid way to get a 64bit type at this point
172 * without making assumptions of too many things.
174 typedef struct { char _fail : 0; } int64_t;
175 typedef struct { char _fail : 0; } uint64_t;
177 #ifdef _LP64 /* long pointer == 64 */
178 typedef unsigned long uintptr_t;
179 typedef long intptr_t;
181 typedef unsigned int uintptr_t;
182 typedef int intptr_t;
184 /* Ensure type sizes are correct: */
185 typedef char uint8_size_is_correct [sizeof(uint8_t) == 1?1:-1];
186 typedef char uint16_size_is_correct [sizeof(uint16_t) == 2?1:-1];
187 typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
188 typedef char uint64_size_is_correct [sizeof(uint64_t) == 8?1:-1];
189 typedef char int16_size_if_correct [sizeof(int16_t) == 2?1:-1];
190 typedef char int32_size_is_correct [sizeof(int32_t) == 4?1:-1];
191 typedef char int64_size_is_correct [sizeof(int64_t) >= 8?1:-1];
192 /* intptr_t / uintptr_t correct size check */
193 typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
194 typedef char intptr_size_is_correct [sizeof(uintptr_t)== sizeof(int*)?1:-1];
196 /*===================================================================*/
197 /*=========================== util.c ================================*/
198 /*===================================================================*/
199 FILE *util_fopen(const char *filename, const char *mode);
201 void *util_memory_a (size_t, unsigned int, const char *);
202 void util_memory_d (void *, unsigned int, const char *);
203 void *util_memory_r (void *, size_t, unsigned int, const char *);
204 void util_meminfo ();
206 bool util_filexists (const char *);
207 bool util_strupper (const char *);
208 bool util_strdigit (const char *);
209 bool util_strncmpexact (const char *, const char *, size_t);
210 char *util_strdup (const char *);
211 char *util_strrq (const char *);
212 char *util_strrnl (const 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 size_t util_strtocmd (const char *, char *, size_t);
220 size_t util_strtononcmd (const char *, char *, size_t);
222 uint16_t util_crc16(uint16_t crc, const char *data, size_t len);
223 uint32_t util_crc32(uint32_t crc, const char *data, size_t len);
226 # define mem_a(x) malloc (x)
227 # define mem_d(x) free (x)
228 # define mem_r(x, n) realloc(x, n)
230 # define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
231 # define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
232 # define mem_r(x, n) util_memory_r((x), (n), __LINE__, __FILE__)
236 * TODO: make these safer to use. Currently this only works on
237 * x86 and x86_64, some systems will likely not like this. Such
240 #define FLT2INT(Y) *((int32_t*)&(Y))
241 #define INT2FLT(Y) *((float *)&(Y))
243 /* New flexible vector implementation from Dale */
244 #define _vec_raw(A) (((size_t*)(void*)(A)) - 2)
245 #define _vec_beg(A) (_vec_raw(A)[0])
246 #define _vec_end(A) (_vec_raw(A)[1])
247 #define _vec_needsgrow(A,N) ((!(A)) || (_vec_end(A) + (N) >= _vec_beg(A)))
248 #define _vec_mightgrow(A,N) (_vec_needsgrow((A), (N)) ? (void)_vec_forcegrow((A),(N)) : (void)0)
249 #define _vec_forcegrow(A,N) _util_vec_grow(((void**)&(A)), (N), sizeof(*(A)))
250 #define _vec_remove(A,S,I,N) (memmove((char*)(A)+(I)*(S),(char*)(A)+((I)+(N))*(S),(S)*(vec_size(A)-(I)-(N))), _vec_end(A)-=(N))
251 void _util_vec_grow(void **a, size_t i, size_t s);
252 /* exposed interface */
253 #define vec_free(A) ((A) ? (mem_d((void*)_vec_raw(A)), (A) = NULL) : 0)
254 #define vec_push(A,V) (_vec_mightgrow((A),1), (A)[_vec_end(A)++] = (V))
255 #define vec_size(A) ((A) ? _vec_end(A) : 0)
256 #define vec_add(A,N) (_vec_mightgrow((A),(N)), _vec_end(A)+=(N), &(A)[_vec_end(A)-(N)])
257 #define vec_last(A) ((A)[_vec_end(A)-1])
258 #define vec_append(A,N,S) memcpy(vec_add((A), (N)), (S), N * sizeof(*(S)))
259 #define vec_remove(A,I,N) _vec_remove((A), sizeof(*(A)), (I), (N))
260 #define vec_pop(A) vec_remove((A), _vec_end(A)-1, 1)
261 /* these are supposed to NOT reallocate */
262 #define vec_shrinkto(A,N) (_vec_end(A) = (N))
263 #define vec_shrinkby(A,N) (_vec_end(A) -= (N))
265 typedef struct hash_table_t {
267 struct hash_node_t **table;
271 * hashtable implementation:
273 * util_htnew(size) -- to make a new hashtable
274 * util_htset(table, key, value, sizeof(value)) -- to set something in the table
275 * util_htget(table, key) -- to get something from the table
276 * util_htdel(table) -- to delete the table
280 * ht foo = util_htnew(1024);
282 * char *test = "hello world\n";
283 * util_htset(foo, "foo", (void*)&data, sizeof(int));
284 * util_gtset(foo, "bar", (void*)test, strlen(test));
286 * printf("foo: %d, bar %s",
287 * *((int *)util_htget(foo, "foo")),
288 * ((char*)util_htget(foo, "bar"))
293 hash_table_t *util_htnew(size_t size);
294 void util_htset(hash_table_t *ht, const char *key, void *value, size_t size);
295 void *util_htget(hash_table_t *ht, const char *key);
296 void util_htdel(hash_table_t *ht);
297 /*===================================================================*/
298 /*=========================== code.c ================================*/
299 /*===================================================================*/
301 /* Note: if you change the order, fix type_sizeof in ir.c */
320 extern const char *type_name[TYPE_COUNT];
322 extern size_t type_sizeof[TYPE_COUNT];
323 extern uint16_t type_store_instr[TYPE_COUNT];
324 extern uint16_t field_store_instr[TYPE_COUNT];
325 /* could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
326 * but this breaks when TYPE_INTEGER is added, since with the enhanced
327 * instruction set, the old ones are left untouched, thus the _I instructions
328 * are at a seperate place.
330 extern uint16_t type_storep_instr[TYPE_COUNT];
331 /* other useful lists */
332 extern uint16_t type_eq_instr[TYPE_COUNT];
333 extern uint16_t type_ne_instr[TYPE_COUNT];
334 extern uint16_t type_not_instr[TYPE_COUNT];
337 uint32_t offset; /* Offset in file of where data begins */
338 uint32_t length; /* Length of section (how many of) */
342 uint32_t version; /* Program version (6) */
343 uint16_t crc16; /* What is this? */
344 uint16_t skip; /* see propsal.txt */
346 prog_section statements; /* prog_section_statement */
347 prog_section defs; /* prog_section_def */
348 prog_section fields; /* prog_section_field */
349 prog_section functions; /* prog_section_function */
350 prog_section strings; /* What is this? */
351 prog_section globals; /* What is this? */
352 uint32_t entfield; /* Number of entity fields */
356 * Each paramater incerements by 3 since vector types hold
357 * 3 components (x,y,z).
361 #define OFS_PARM0 (OFS_RETURN+3)
362 #define OFS_PARM1 (OFS_PARM0 +3)
363 #define OFS_PARM2 (OFS_PARM1 +3)
364 #define OFS_PARM3 (OFS_PARM2 +3)
365 #define OFS_PARM4 (OFS_PARM3 +3)
366 #define OFS_PARM5 (OFS_PARM4 +3)
367 #define OFS_PARM6 (OFS_PARM5 +3)
368 #define OFS_PARM7 (OFS_PARM6 +3)
375 int16_t s1; /* signed */
376 uint16_t u1; /* unsigned */
380 int16_t s1; /* signed */
381 uint16_t u1; /* unsigned */
385 int16_t s1; /* signed */
386 uint16_t u1; /* unsigned */
390 * This is the same as the structure in darkplaces
395 * But this one is more sane to work with, and the
396 * type sizes are guranteed.
398 } prog_section_statement;
409 * 7 = ev_pointer -- engine only
410 * 8 = ev_bad -- engine only
416 typedef prog_section_both prog_section_def;
417 typedef prog_section_both prog_section_field;
419 /* this is ORed to the type */
420 #define DEF_SAVEGLOBAL (1<<15)
421 #define DEF_TYPEMASK ((1<<15)-1)
424 int32_t entry; /* in statement table for instructions */
425 uint32_t firstlocal; /* First local in local table */
426 uint32_t locals; /* Total ints of params + locals */
427 uint32_t profile; /* Always zero (engine uses this) */
428 uint32_t name; /* name of function in string table */
429 uint32_t file; /* file of the source file */
430 uint32_t nargs; /* number of arguments */
431 uint8_t argsize[8]; /* size of arguments (keep 8 always?) */
432 } prog_section_function;
436 * These are the external instructions supported by the interperter
437 * this is what things compile to (from the C code).
443 INSTR_MUL_FV, /* NOTE: the float operands must NOT be at the same locations: A != C */
444 INSTR_MUL_VF, /* and here: B != C */
508 * Virtual instructions used by the assembler
509 * keep at the end but before virtual instructions
515 * Virtual instructions used by the IR
523 extern prog_section_statement *code_statements;
524 extern prog_section_def *code_defs;
525 extern prog_section_field *code_fields;
526 extern prog_section_function *code_functions;
527 extern int *code_globals;
528 extern char *code_chars;
529 extern uint16_t code_crc;
531 typedef float qcfloat;
532 typedef int32_t qcint;
535 * code_write -- writes out the compiled file
536 * code_init -- prepares the code file
538 bool code_write (const char *filename);
540 uint32_t code_genstring (const char *string);
541 uint32_t code_cachedstring(const char *string);
542 qcint code_alloc_field (size_t qcsize);
544 /*===================================================================*/
545 /*============================ con.c ================================*/
546 /*===================================================================*/
566 void con_vprintmsg (int level, const char *name, size_t line, const char *msgtype, const char *msg, va_list ap);
567 void con_printmsg (int level, const char *name, size_t line, const char *msgtype, const char *msg, ...);
568 void con_cvprintmsg(void *ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
569 void con_cprintmsg (void *ctx, int lvl, const char *msgtype, const char *msg, ...);
572 void con_color(int state);
575 int con_change(const char *out, const char *err);
576 int con_verr (const char *fmt, va_list va);
577 int con_vout (const char *fmt, va_list va);
578 int con_err (const char *fmt, ...);
579 int con_out (const char *fmt, ...);
581 /*===================================================================*/
582 /*========================= assembler.c =============================*/
583 /*===================================================================*/
584 static const struct {
585 const char *m; /* menomic */
586 const size_t o; /* operands */
587 const size_t l; /* menomic len */
613 { "FIELD_F" , 0, 7 },
614 { "FIELD_V" , 0, 7 },
615 { "FIELD_S" , 0, 7 },
616 { "FIELD_ENT" , 0, 9 },
617 { "FIELD_FLD" , 0, 9 },
618 { "FIELD_FNC" , 0, 9 },
619 { "ADDRESS" , 0, 7 },
620 { "STORE_F" , 0, 7 },
621 { "STORE_V" , 0, 7 },
622 { "STORE_S" , 0, 7 },
623 { "STORE_ENT" , 0, 9 },
624 { "STORE_FLD" , 0, 9 },
625 { "STORE_FNC" , 0, 9 },
626 { "STOREP_F" , 0, 8 },
627 { "STOREP_V" , 0, 8 },
628 { "STOREP_S" , 0, 8 },
629 { "STOREP_ENT", 0, 10},
630 { "STOREP_FLD", 0, 10},
631 { "STOREP_FNC", 0, 10},
636 { "NOT_ENT" , 0, 7 },
637 { "NOT_FNC" , 0, 7 },
656 { "END" , 0, 3 } /* virtual assembler instruction */
658 /*===================================================================*/
659 /*============================= ir.c ================================*/
660 /*===================================================================*/
664 store_local, /* local, assignable for now, should get promoted later */
665 store_param, /* parameters, they are locals with a fixed position */
666 store_value, /* unassignable */
667 store_return /* unassignable, at OFS_RETURN */
674 vector vec3_add (vector, vector);
675 vector vec3_sub (vector, vector);
676 qcfloat vec3_mulvv(vector, vector);
677 vector vec3_mulvf(vector, float);
680 * A shallow copy of a lex_file to remember where which ast node
688 /*===================================================================*/
689 /*============================= exec.c ==============================*/
690 /*===================================================================*/
692 /* darkplaces has (or will have) a 64 bit prog loader
693 * where the 32 bit qc program is autoconverted on load.
694 * Since we may want to support that as well, let's redefine
695 * float and int here.
707 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
708 typedef char qcint_size_is_correct [sizeof(qcint) == 4 ?1:-1];
712 VMERR_TEMPSTRING_ALLOC,
717 #define VM_JUMPS_DEFAULT 1000000
720 #define VMXF_DEFAULT 0x0000 /* default flags - nothing */
721 #define VMXF_TRACE 0x0001 /* trace: print statements before executing */
722 #define VMXF_PROFILE 0x0002 /* profile: increment the profile counters */
726 typedef int (*prog_builtin)(struct qc_program_s *prog);
731 prog_section_function *function;
734 typedef struct qc_program_s {
737 prog_section_statement *code;
738 prog_section_def *defs;
739 prog_section_def *fields;
740 prog_section_function *functions;
746 const char* *function_stack;
750 size_t tempstring_start;
751 size_t tempstring_at;
757 prog_builtin *builtins;
758 size_t builtins_count;
763 bool allowworldwrites;
766 qc_exec_stack *stack;
771 int argc; /* current arg count for debugging */
774 qc_program* prog_load(const char *filename);
775 void prog_delete(qc_program *prog);
777 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
779 char* prog_getstring (qc_program *prog, qcint str);
780 prog_section_def* prog_entfield (qc_program *prog, qcint off);
781 prog_section_def* prog_getdef (qc_program *prog, qcint off);
782 qcany* prog_getedict (qc_program *prog, qcint e);
783 qcint prog_tempstring(qc_program *prog, const char *_str);
786 /*===================================================================*/
787 /*===================== parser.c commandline ========================*/
788 /*===================================================================*/
791 bool parser_compile_file (const char *filename);
792 bool parser_compile_string(const char *name, const char *str);
793 bool parser_finish (const char *output);
794 void parser_cleanup ();
795 /* There's really no need to strlen() preprocessed files */
796 bool parser_compile_string_len(const char *name, const char *str, size_t len);
798 /*===================================================================*/
799 /*====================== ftepp.c commandline ========================*/
800 /*===================================================================*/
802 bool ftepp_preprocess_file (const char *filename);
803 bool ftepp_preprocess_string(const char *name, const char *str);
804 void ftepp_finish ();
805 const char *ftepp_get ();
807 void ftepp_add_define (const char *source, const char *name);
809 /*===================================================================*/
810 /*======================= main.c commandline ========================*/
811 /*===================================================================*/
814 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
815 * to 32 or 64 -f options...
818 size_t idx; /* index into an array of 32 bit words */
819 uint8_t bit; /* index _into_ the 32 bit word, thus just uint8 */
821 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
823 typedef uint32_t longbit;
824 #define LONGBIT(bit) (bit)
827 /* Used to store the list of flags with names */
833 /*===================================================================*/
834 /* list of -f flags, like -fdarkplaces-string-table-bug */
836 # define GMQCC_TYPE_FLAGS
837 # define GMQCC_DEFINE_FLAG(X) X,
841 static const opts_flag_def opts_flag_list[] = {
842 # define GMQCC_TYPE_FLAGS
843 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
849 # define GMQCC_TYPE_WARNS
850 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
854 static const opts_flag_def opts_warn_list[] = {
855 # define GMQCC_TYPE_WARNS
856 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
863 COMPILER_QCC, /* circa QuakeC */
864 COMPILER_FTEQCC, /* fteqcc QuakeC */
865 COMPILER_QCCX, /* qccx QuakeC */
866 COMPILER_GMQCC /* this QuakeC */
868 extern uint32_t opts_O; /* -Ox */
869 extern const char *opts_output; /* -o file */
870 extern int opts_standard;
871 extern bool opts_debug;
872 extern bool opts_memchk;
873 extern bool opts_dumpfin;
874 extern bool opts_dump;
875 extern bool opts_werror;
876 extern bool opts_forcecrc;
877 extern uint16_t opts_forced_crc;
878 extern bool opts_pp_only;
879 extern size_t opts_max_array_size;
881 /*===================================================================*/
882 #define OPTS_FLAG(i) (!! (opts_flags[(i)/32] & (1<< ((i)%32))))
883 extern uint32_t opts_flags[1 + (COUNT_FLAGS / 32)];
884 #define OPTS_WARN(i) (!! (opts_warn[(i)/32] & (1<< ((i)%32))))
885 extern uint32_t opts_warn[1 + (COUNT_WARNINGS / 32)];