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 # define GMQCC_INLINE
115 #endif /* !__STDC_VERSION__ */
118 * noreturn is present in GCC and clang
119 * it's required for _ast_node_destory otherwise -Wmissing-noreturn
120 * in clang complains about there being no return since abort() is
123 #if (defined(__GNUC__) && __GNUC__ >= 2) || defined(__CLANG__)
124 # define GMQCC_NORETURN __attribute__ ((noreturn))
126 # define GMQCC_NORETURN
130 * stdint.h and inttypes.h -less subset
131 * for systems that don't have it, which we must
132 * assume is all systems. (int8_t not required)
135 typedef unsigned char uint8_t; /* same as below */
136 #elif SCHAR_MIN == -128
137 typedef unsigned char uint8_t; /* same as above */
139 #if SHRT_MAX == 0x7FFF
140 typedef short int16_t;
141 typedef unsigned short uint16_t;
142 #elif INT_MAX == 0x7FFF
144 typedef unsigned int uint16_t;
146 #if INT_MAX == 0x7FFFFFFF
148 typedef unsigned int uint32_t;
149 #elif LONG_MAX == 0x7FFFFFFF
150 typedef long int32_t;
151 typedef unsigned long uint32_t;
155 #if defined(__GNUC__) || defined (__CLANG__)
156 typedef int int64_t __attribute__((__mode__(__DI__)));
157 typedef unsigned int uint64_t __attribute__((__mode__(__DI__)));
158 #elif defined(_MSC_VER)
159 typedef __int64 int64_t;
160 typedef unsigned __int64 uint64_t;
163 * Incoorectly size the types so static assertions below will
164 * fail. There is no valid way to get a 64bit type at this point
165 * without making assumptions of too many things.
167 typedef struct { char _fail : 0; } int64_t;
168 typedef struct { char _fail : 0; } uint64_t;
170 #ifdef _LP64 /* long pointer == 64 */
171 typedef unsigned long uintptr_t;
172 typedef long intptr_t;
174 typedef unsigned int uintptr_t;
175 typedef int intptr_t;
177 /* Ensure type sizes are correct: */
178 typedef char uint8_size_is_correct [sizeof(uint8_t) == 1?1:-1];
179 typedef char uint16_size_is_correct [sizeof(uint16_t) == 2?1:-1];
180 typedef char uint32_size_is_correct [sizeof(uint32_t) == 4?1:-1];
181 typedef char uint64_size_is_correct [sizeof(uint64_t) == 8?1:-1];
182 typedef char int16_size_if_correct [sizeof(int16_t) == 2?1:-1];
183 typedef char int32_size_is_correct [sizeof(int32_t) == 4?1:-1];
184 typedef char int64_size_is_correct [sizeof(int64_t) >= 8?1:-1];
185 /* intptr_t / uintptr_t correct size check */
186 typedef char uintptr_size_is_correct[sizeof(intptr_t) == sizeof(int*)?1:-1];
187 typedef char intptr_size_is_correct [sizeof(uintptr_t)== sizeof(int*)?1:-1];
189 /*===================================================================*/
190 /*=========================== util.c ================================*/
191 /*===================================================================*/
192 FILE *util_fopen(const char *filename, const char *mode);
194 void *util_memory_a (size_t, unsigned int, const char *);
195 void util_memory_d (void *, unsigned int, const char *);
196 void *util_memory_r (void *, size_t, unsigned int, const char *);
197 void util_meminfo ();
199 bool util_filexists (const char *);
200 bool util_strupper (const char *);
201 bool util_strdigit (const char *);
202 bool util_strncmpexact (const char *, const char *, size_t);
203 char *util_strdup (const char *);
204 char *util_strrq (const char *);
205 char *util_strrnl (const char *);
206 char *util_strsws (const char *);
207 char *util_strchp (const char *, const char *);
208 void util_debug (const char *, const char *, ...);
209 int util_getline (char **, size_t *, FILE *);
210 void util_endianswap (void *, int, int);
212 size_t util_strtocmd (const char *, char *, size_t);
213 size_t util_strtononcmd (const char *, char *, size_t);
215 uint16_t util_crc16(uint16_t crc, const char *data, size_t len);
216 uint32_t util_crc32(uint32_t crc, const char *data, size_t len);
219 # define mem_a(x) malloc (x)
220 # define mem_d(x) free (x)
221 # define mem_r(x, n) realloc(x, n)
223 # define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
224 # define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
225 # define mem_r(x, n) util_memory_r((x), (n), __LINE__, __FILE__)
229 * TODO: make these safer to use. Currently this only works on
230 * x86 and x86_64, some systems will likely not like this. Such
233 #define FLT2INT(Y) *((int32_t*)&(Y))
234 #define INT2FLT(Y) *((float *)&(Y))
236 /* New flexible vector implementation from Dale */
237 #define _vec_raw(A) (((size_t*)(A)) - 2)
238 #define _vec_beg(A) (_vec_raw(A)[0])
239 #define _vec_end(A) (_vec_raw(A)[1])
240 #define _vec_needsgrow(A,N) ((!(A)) || (_vec_end(A) + (N) >= _vec_beg(A)))
241 #define _vec_mightgrow(A,N) (_vec_needsgrow((A), (N)) ? _vec_forcegrow((A),(N)) : 0)
242 #define _vec_forcegrow(A,N) _util_vec_grow((void**)&(A), (N), sizeof(*(A)))
243 #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))
244 void _util_vec_grow(void **a, size_t i, size_t s);
245 /* exposed interface */
246 #define vec_free(A) ((A) ? (mem_d(_vec_raw(A)), (A) = NULL) : 0)
247 #define vec_push(A,V) (_vec_mightgrow((A),1), (A)[_vec_end(A)++] = (V))
248 #define vec_size(A) ((A) ? _vec_end(A) : 0)
249 #define vec_add(A,N) (_vec_mightgrow((A),(N)), _vec_end(A)+=(N), &(A)[_vec_end(A)-(N)])
250 #define vec_last(A) ((A)[_vec_end(A)-1])
251 #define vec_append(A,N,S) memcpy(vec_add((A), (N)), (S), N * sizeof(*(S)))
252 #define vec_remove(A,I,N) _vec_remove((A), sizeof(*(A)), (I), (N))
253 #define vec_pop(A) vec_remove((A), _vec_end(A)-1, 1)
254 /* these are supposed to NOT reallocate */
255 #define vec_shrinkto(A,N) (_vec_end(A) = (N))
256 #define vec_shrinkby(A,N) (_vec_end(A) -= (N))
258 /*===================================================================*/
259 /*=========================== code.c ================================*/
260 /*===================================================================*/
262 /* Note: if you change the order, fix type_sizeof in ir.c */
281 extern const char *type_name[TYPE_COUNT];
283 extern size_t type_sizeof[TYPE_COUNT];
284 extern uint16_t type_store_instr[TYPE_COUNT];
285 extern uint16_t field_store_instr[TYPE_COUNT];
286 /* could use type_store_instr + INSTR_STOREP_F - INSTR_STORE_F
287 * but this breaks when TYPE_INTEGER is added, since with the enhanced
288 * instruction set, the old ones are left untouched, thus the _I instructions
289 * are at a seperate place.
291 extern uint16_t type_storep_instr[TYPE_COUNT];
292 /* other useful lists */
293 extern uint16_t type_eq_instr[TYPE_COUNT];
294 extern uint16_t type_ne_instr[TYPE_COUNT];
295 extern uint16_t type_not_instr[TYPE_COUNT];
298 uint32_t offset; /* Offset in file of where data begins */
299 uint32_t length; /* Length of section (how many of) */
303 uint32_t version; /* Program version (6) */
304 uint16_t crc16; /* What is this? */
305 uint16_t skip; /* see propsal.txt */
307 prog_section statements; /* prog_section_statement */
308 prog_section defs; /* prog_section_def */
309 prog_section fields; /* prog_section_field */
310 prog_section functions; /* prog_section_function */
311 prog_section strings; /* What is this? */
312 prog_section globals; /* What is this? */
313 uint32_t entfield; /* Number of entity fields */
317 * Each paramater incerements by 3 since vector types hold
318 * 3 components (x,y,z).
322 #define OFS_PARM0 (OFS_RETURN+3)
323 #define OFS_PARM1 (OFS_PARM0 +3)
324 #define OFS_PARM2 (OFS_PARM1 +3)
325 #define OFS_PARM3 (OFS_PARM2 +3)
326 #define OFS_PARM4 (OFS_PARM3 +3)
327 #define OFS_PARM5 (OFS_PARM4 +3)
328 #define OFS_PARM6 (OFS_PARM5 +3)
329 #define OFS_PARM7 (OFS_PARM6 +3)
336 int16_t s1; /* signed */
337 uint16_t u1; /* unsigned */
341 int16_t s1; /* signed */
342 uint16_t u1; /* unsigned */
346 int16_t s1; /* signed */
347 uint16_t u1; /* unsigned */
351 * This is the same as the structure in darkplaces
356 * But this one is more sane to work with, and the
357 * type sizes are guranteed.
359 } prog_section_statement;
370 * 7 = ev_pointer -- engine only
371 * 8 = ev_bad -- engine only
377 typedef prog_section_both prog_section_def;
378 typedef prog_section_both prog_section_field;
380 /* this is ORed to the type */
381 #define DEF_SAVEGLOBAL (1<<15)
382 #define DEF_TYPEMASK ((1<<15)-1)
385 int32_t entry; /* in statement table for instructions */
386 uint32_t firstlocal; /* First local in local table */
387 uint32_t locals; /* Total ints of params + locals */
388 uint32_t profile; /* Always zero (engine uses this) */
389 uint32_t name; /* name of function in string table */
390 uint32_t file; /* file of the source file */
391 uint32_t nargs; /* number of arguments */
392 uint8_t argsize[8]; /* size of arguments (keep 8 always?) */
393 } prog_section_function;
397 * These are the external instructions supported by the interperter
398 * this is what things compile to (from the C code).
404 INSTR_MUL_FV, /* NOTE: the float operands must NOT be at the same locations: A != C */
405 INSTR_MUL_VF, /* and here: B != C */
469 * Virtual instructions used by the assembler
470 * keep at the end but before virtual instructions
476 * Virtual instructions used by the IR
484 extern prog_section_statement *code_statements;
485 extern prog_section_def *code_defs;
486 extern prog_section_field *code_fields;
487 extern prog_section_function *code_functions;
488 extern int *code_globals;
489 extern char *code_chars;
490 extern uint16_t code_crc;
492 typedef float qcfloat;
493 typedef int32_t qcint;
496 * code_write -- writes out the compiled file
497 * code_init -- prepares the code file
499 bool code_write (const char *filename);
501 uint32_t code_genstring (const char *string);
502 uint32_t code_cachedstring(const char *string);
503 qcint code_alloc_field (size_t qcsize);
505 /*===================================================================*/
506 /*============================ con.c ================================*/
507 /*===================================================================*/
527 void con_vprintmsg (int level, const char *name, size_t line, const char *msgtype, const char *msg, va_list ap);
528 void con_printmsg (int level, const char *name, size_t line, const char *msgtype, const char *msg, ...);
529 void con_cvprintmsg(void *ctx, int lvl, const char *msgtype, const char *msg, va_list ap);
530 void con_cprintmsg (void *ctx, int lvl, const char *msgtype, const char *msg, ...);
533 void con_color(int state);
536 int con_change(const char *out, const char *err);
537 int con_verr (const char *fmt, va_list va);
538 int con_vout (const char *fmt, va_list va);
539 int con_err (const char *fmt, ...);
540 int con_out (const char *fmt, ...);
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 },
617 { "END" , 0, 3 } /* virtual assembler instruction */
619 /*===================================================================*/
620 /*============================= ir.c ================================*/
621 /*===================================================================*/
625 store_local, /* local, assignable for now, should get promoted later */
626 store_param, /* parameters, they are locals with a fixed position */
627 store_value, /* unassignable */
628 store_return /* unassignable, at OFS_RETURN */
635 vector vec3_add (vector, vector);
636 vector vec3_sub (vector, vector);
637 qcfloat vec3_mulvv(vector, vector);
638 vector vec3_mulvf(vector, float);
641 * A shallow copy of a lex_file to remember where which ast node
649 /*===================================================================*/
650 /*============================= exec.c ==============================*/
651 /*===================================================================*/
653 /* darkplaces has (or will have) a 64 bit prog loader
654 * where the 32 bit qc program is autoconverted on load.
655 * Since we may want to support that as well, let's redefine
656 * float and int here.
668 typedef char qcfloat_size_is_correct [sizeof(qcfloat) == 4 ?1:-1];
669 typedef char qcint_size_is_correct [sizeof(qcint) == 4 ?1:-1];
673 VMERR_TEMPSTRING_ALLOC,
678 #define VM_JUMPS_DEFAULT 1000000
681 #define VMXF_DEFAULT 0x0000 /* default flags - nothing */
682 #define VMXF_TRACE 0x0001 /* trace: print statements before executing */
683 #define VMXF_PROFILE 0x0002 /* profile: increment the profile counters */
687 typedef int (*prog_builtin)(struct qc_program_s *prog);
692 prog_section_function *function;
695 typedef struct qc_program_s {
698 prog_section_statement *code;
699 prog_section_def *defs;
700 prog_section_def *fields;
701 prog_section_function *functions;
707 const char* *function_stack;
711 size_t tempstring_start;
712 size_t tempstring_at;
718 prog_builtin *builtins;
719 size_t builtins_count;
724 bool allowworldwrites;
727 qc_exec_stack *stack;
732 int argc; /* current arg count for debugging */
735 qc_program* prog_load(const char *filename);
736 void prog_delete(qc_program *prog);
738 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps);
740 char* prog_getstring (qc_program *prog, qcint str);
741 prog_section_def* prog_entfield (qc_program *prog, qcint off);
742 prog_section_def* prog_getdef (qc_program *prog, qcint off);
743 qcany* prog_getedict (qc_program *prog, qcint e);
744 qcint prog_tempstring(qc_program *prog, const char *_str);
747 /*===================================================================*/
748 /*===================== parser.c commandline ========================*/
749 /*===================================================================*/
752 bool parser_compile_file (const char *filename);
753 bool parser_compile_string(const char *name, const char *str);
754 bool parser_finish (const char *output);
755 void parser_cleanup ();
756 /* There's really no need to strlen() preprocessed files */
757 bool parser_compile_string_len(const char *name, const char *str, size_t len);
759 /*===================================================================*/
760 /*====================== ftepp.c commandline ========================*/
761 /*===================================================================*/
763 bool ftepp_preprocess_file (const char *filename);
764 bool ftepp_preprocess_string(const char *name, const char *str);
765 void ftepp_finish ();
766 const char *ftepp_get ();
769 /*===================================================================*/
770 /*======================= main.c commandline ========================*/
771 /*===================================================================*/
774 /* Helpers to allow for a whole lot of flags. Otherwise we'd limit
775 * to 32 or 64 -f options...
778 size_t idx; /* index into an array of 32 bit words */
779 uint8_t bit; /* index _into_ the 32 bit word, thus just uint8 */
781 #define LONGBIT(bit) { ((bit)/32), ((bit)%32) }
783 typedef uint32_t longbit;
784 #define LONGBIT(bit) (bit)
787 /* Used to store the list of flags with names */
793 /*===================================================================*/
794 /* list of -f flags, like -fdarkplaces-string-table-bug */
796 # define GMQCC_TYPE_FLAGS
797 # define GMQCC_DEFINE_FLAG(X) X,
801 static const opts_flag_def opts_flag_list[] = {
802 # define GMQCC_TYPE_FLAGS
803 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
809 # define GMQCC_TYPE_WARNS
810 # define GMQCC_DEFINE_FLAG(X) WARN_##X,
814 static const opts_flag_def opts_warn_list[] = {
815 # define GMQCC_TYPE_WARNS
816 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
823 COMPILER_QCC, /* circa QuakeC */
824 COMPILER_FTEQCC, /* fteqcc QuakeC */
825 COMPILER_QCCX, /* qccx QuakeC */
826 COMPILER_GMQCC /* this QuakeC */
828 extern uint32_t opts_O; /* -Ox */
829 extern const char *opts_output; /* -o file */
830 extern int opts_standard;
831 extern bool opts_debug;
832 extern bool opts_memchk;
833 extern bool opts_dumpfin;
834 extern bool opts_dump;
835 extern bool opts_werror;
836 extern bool opts_forcecrc;
837 extern uint16_t opts_forced_crc;
838 extern bool opts_pp_only;
839 extern size_t opts_max_array_size;
841 /*===================================================================*/
842 #define OPTS_FLAG(i) (!! (opts_flags[(i)/32] & (1<< ((i)%32))))
843 extern uint32_t opts_flags[1 + (COUNT_FLAGS / 32)];
844 #define OPTS_WARN(i) (!! (opts_warn[(i)/32] & (1<< ((i)%32))))
845 extern uint32_t opts_warn[1 + (COUNT_WARNINGS / 32)];