2 * Copyright (C) 2012, 2013, 2014
6 * Permission is hereby granted, free of charge, to any person obtaining a copy of
7 * this software and associated documentation files (the "Software"), to deal in
8 * the Software without restriction, including without limitation the rights to
9 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10 * of the Software, and to permit persons to whom the Software is furnished to do
11 * so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 /* TODO: cleanup this whole file .. it's a fuckign mess */
32 /* set by the standard */
33 const oper_info *operators = NULL;
34 size_t operator_count = 0;
35 static bool opts_output_wasset = false;
37 typedef struct { char *filename; int type; } argitem;
38 typedef struct { char *name; char *value; } ppitem;
39 static argitem *items = NULL;
40 static ppitem *ppems = NULL;
46 static const char *app_name;
48 static void version(void) {
49 con_out("GMQCC %d.%d.%d Built %s %s\n" GMQCC_DEV_VERSION_STRING,
58 static int usage(void) {
59 con_out("usage: %s [options] [files...]", app_name);
61 " -h, --help show this help message\n"
62 " -debug turns on compiler debug messages\n"
63 " -memchk turns on compiler memory leak check\n");
64 con_out(" -o, --output=file output file, defaults to progs.dat\n"
65 " -s filename add a progs.src file to be used\n");
66 con_out(" -E stop after preprocessing\n");
67 con_out(" -q, --quiet be less verbose\n");
68 con_out(" -config file use the specified ini file\n");
69 con_out(" -std=standard select one of the following standards\n"
70 " -std=qcc original QuakeC\n"
71 " -std=fteqcc fteqcc QuakeC\n"
72 " -std=gmqcc this compiler (default)\n");
73 con_out(" -f<flag> enable a flag\n"
74 " -fno-<flag> disable a flag\n"
75 " -fhelp list possible flags\n");
76 con_out(" -W<warning> enable a warning\n"
77 " -Wno-<warning> disable a warning\n"
78 " -Wall enable all warnings\n");
79 con_out(" -Werror treat warnings as errors\n"
80 " -Werror-<warning> treat a warning as error\n"
81 " -Wno-error-<warning> opposite of the above\n");
82 con_out(" -Whelp list possible warnings\n");
83 con_out(" -O<number> optimization level\n"
84 " -O<name> enable specific optimization\n"
85 " -Ono-<name> disable specific optimization\n"
86 " -Ohelp list optimizations\n");
87 con_out(" -force-crc=num force a specific checksum into the header\n");
88 con_out(" -state-fps=num emulate OP_STATE with the specified FPS\n");
89 con_out(" -coverage add coverage support\n");
93 /* command line parsing */
94 static bool options_witharg(int *argc_, char ***argv_, char **out) {
102 /* eat up the next */
103 if (argc < 2) /* no parameter was provided */
112 static bool options_long_witharg_all(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
114 char **argv = *argv_;
116 size_t len = strlen(optname);
118 if (strncmp(argv[0]+ds, optname, len))
121 /* it's --optname, check how the parameter is supplied */
122 if (argv[0][ds+len] == '=') {
123 /* using --opt=param */
124 *out = argv[0]+ds+len+1;
128 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
131 /* using --opt param */
137 static bool options_long_witharg(const char *optname, int *argc_, char ***argv_, char **out) {
138 return options_long_witharg_all(optname, argc_, argv_, out, 2, true);
140 static bool options_long_gcc(const char *optname, int *argc_, char ***argv_, char **out) {
141 return options_long_witharg_all(optname, argc_, argv_, out, 1, false);
144 static bool options_parse(int argc, char **argv) {
148 char *redirout = NULL;
149 char *redirerr = NULL;
151 char *memdumpcols = NULL;
153 while (!argend && argc > 1) {
161 if (argv[0][0] == '-') {
162 /* All gcc-type long options */
163 if (options_long_gcc("std", &argc, &argv, &argarg)) {
164 if (!strcmp(argarg, "gmqcc") || !strcmp(argarg, "default")) {
166 opts_set(opts.flags, ADJUST_VECTOR_FIELDS, true);
167 opts_set(opts.flags, CORRECT_LOGIC, true);
168 opts_set(opts.flags, SHORT_LOGIC, true);
169 opts_set(opts.flags, UNTYPED_NIL, true);
170 opts_set(opts.flags, VARIADIC_ARGS, true);
171 opts_set(opts.flags, FALSE_EMPTY_STRINGS, false);
172 opts_set(opts.flags, TRUE_EMPTY_STRINGS, true);
173 opts_set(opts.flags, LOOP_LABELS, true);
174 opts_set(opts.flags, TRANSLATABLE_STRINGS, true);
175 opts_set(opts.flags, INITIALIZED_NONCONSTANTS, true);
176 opts_set(opts.werror, WARN_INVALID_PARAMETER_COUNT, true);
177 opts_set(opts.werror, WARN_MISSING_RETURN_VALUES, true);
178 opts_set(opts.flags, EXPRESSIONS_FOR_BUILTINS, true);
179 opts_set(opts.warn, WARN_BREAKDEF, true);
183 OPTS_OPTION_U32(OPTION_STANDARD) = COMPILER_GMQCC;
185 } else if (!strcmp(argarg, "qcc")) {
187 opts_set(opts.flags, ADJUST_VECTOR_FIELDS, false);
188 opts_set(opts.flags, ASSIGN_FUNCTION_TYPES, true);
190 OPTS_OPTION_U32(OPTION_STANDARD) = COMPILER_QCC;
192 } else if (!strcmp(argarg, "fte") || !strcmp(argarg, "fteqcc")) {
194 opts_set(opts.flags, FTEPP, true);
195 opts_set(opts.flags, TRANSLATABLE_STRINGS, true);
196 opts_set(opts.flags, ADJUST_VECTOR_FIELDS, false);
197 opts_set(opts.flags, ASSIGN_FUNCTION_TYPES, true);
198 opts_set(opts.flags, CORRECT_TERNARY, false);
199 opts_set(opts.warn, WARN_TERNARY_PRECEDENCE, true);
200 opts_set(opts.warn, WARN_BREAKDEF, true);
202 OPTS_OPTION_U32(OPTION_STANDARD) = COMPILER_FTEQCC;
204 } else if (!strcmp(argarg, "qccx")) {
206 opts_set(opts.flags, ADJUST_VECTOR_FIELDS, false);
207 OPTS_OPTION_U32(OPTION_STANDARD) = COMPILER_QCCX;
210 con_out("Unknown standard: %s\n", argarg);
215 if (options_long_gcc("force-crc", &argc, &argv, &argarg)) {
217 OPTS_OPTION_BOOL(OPTION_FORCECRC) = true;
218 OPTS_OPTION_U16 (OPTION_FORCED_CRC) = strtol(argarg, NULL, 0);
221 if (options_long_gcc("state-fps", &argc, &argv, &argarg)) {
222 OPTS_OPTION_U32(OPTION_STATE_FPS) = strtol(argarg, NULL, 0);
223 opts_set(opts.flags, EMULATE_STATE, true);
226 if (options_long_gcc("redirout", &argc, &argv, &redirout)) {
227 con_change(redirout, redirerr);
230 if (options_long_gcc("redirerr", &argc, &argv, &redirerr)) {
231 con_change(redirout, redirerr);
234 if (options_long_gcc("config", &argc, &argv, &argarg)) {
238 if (options_long_gcc("memdumpcols", &argc, &argv, &memdumpcols)) {
239 OPTS_OPTION_U16(OPTION_MEMDUMPCOLS) = (uint16_t)strtol(memdumpcols, NULL, 10);
242 if (options_long_gcc("progsrc", &argc, &argv, &argarg)) {
243 OPTS_OPTION_STR(OPTION_PROGSRC) = argarg;
247 /* show defaults (like pathscale) */
248 if (!strcmp(argv[0]+1, "show-defaults")) {
249 for (itr = 0; itr < COUNT_FLAGS; ++itr) {
253 memset(buffer, 0, sizeof(buffer));
254 util_strtononcmd(opts_flag_list[itr].name, buffer, strlen(opts_flag_list[itr].name) + 1);
256 con_out("-f%s ", buffer);
258 for (itr = 0; itr < COUNT_WARNINGS; ++itr) {
262 memset(buffer, 0, sizeof(buffer));
263 util_strtononcmd(opts_warn_list[itr].name, buffer, strlen(opts_warn_list[itr].name) + 1);
264 con_out("-W%s ", buffer);
270 if (!strcmp(argv[0]+1, "debug")) {
271 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
274 if (!strcmp(argv[0]+1, "dump")) {
275 OPTS_OPTION_BOOL(OPTION_DUMP) = true;
278 if (!strcmp(argv[0]+1, "dumpfin")) {
279 OPTS_OPTION_BOOL(OPTION_DUMPFIN) = true;
282 if (!strcmp(argv[0]+1, "memchk")) {
283 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
286 if (!strcmp(argv[0]+1, "nocolor")) {
290 if (!strcmp(argv[0]+1, "coverage")) {
291 OPTS_OPTION_BOOL(OPTION_COVERAGE) = true;
295 switch (argv[0][1]) {
296 /* -h, show usage but exit with 0 */
300 /* break; never reached because of exit(0) */
307 OPTS_OPTION_BOOL(OPTION_PP_ONLY) = true;
308 opts_set(opts.flags, FTEPP_PREDEFS, true); /* predefs on for -E */
311 /* debug turns on -flno */
313 opts_setflag("LNO", true);
314 OPTS_OPTION_BOOL(OPTION_G) = true;
318 OPTS_OPTION_BOOL(OPTION_QUIET) = true;
322 if (!strlen(argv[0]+2)) {
323 con_err("expected name after -D\n");
327 if (!(argarg = strchr(argv[0] + 2, '='))) {
328 macro.name = util_strdup(argv[0]+2);
331 *argarg='\0'; /* terminate for name */
332 macro.name = util_strdup(argv[0]+2);
333 macro.value = util_strdup(argarg+1);
335 vec_push(ppems, macro);
338 /* handle all -fflags */
340 util_strtocmd(argv[0]+2, argv[0]+2, strlen(argv[0]+2)+1);
341 if (!strcmp(argv[0]+2, "HELP") || *(argv[0]+2) == '?') {
342 con_out("Possible flags:\n\n");
343 for (itr = 0; itr < COUNT_FLAGS; ++itr) {
344 util_strtononcmd(opts_flag_list[itr].name, buffer, sizeof(buffer));
345 con_out(" -f%s\n", buffer);
349 else if (!strncmp(argv[0]+2, "NO_", 3)) {
350 if (!opts_setflag(argv[0]+5, false)) {
351 con_out("unknown flag: %s\n", argv[0]+2);
355 else if (!opts_setflag(argv[0]+2, true)) {
356 con_out("unknown flag: %s\n", argv[0]+2);
361 util_strtocmd(argv[0]+2, argv[0]+2, strlen(argv[0]+2)+1);
362 if (!strcmp(argv[0]+2, "HELP") || *(argv[0]+2) == '?') {
363 con_out("Possible warnings:\n");
364 for (itr = 0; itr < COUNT_WARNINGS; ++itr) {
365 util_strtononcmd(opts_warn_list[itr].name, buffer, sizeof(buffer));
366 con_out(" -W%s\n", buffer);
367 if (itr == WARN_DEBUG)
368 con_out(" Warnings included by -Wall:\n");
372 else if (!strcmp(argv[0]+2, "NO_ERROR") ||
373 !strcmp(argv[0]+2, "NO_ERROR_ALL"))
375 for (itr = 0; itr < GMQCC_ARRAY_COUNT(opts.werror); ++itr)
376 opts.werror[itr] = 0;
379 else if (!strcmp(argv[0]+2, "ERROR") ||
380 !strcmp(argv[0]+2, "ERROR_ALL"))
382 opts_backup_non_Werror_all();
383 for (itr = 0; itr < GMQCC_ARRAY_COUNT(opts.werror); ++itr)
384 opts.werror[itr] = 0xFFFFFFFFL;
385 opts_restore_non_Werror_all();
388 else if (!strcmp(argv[0]+2, "NONE")) {
389 for (itr = 0; itr < GMQCC_ARRAY_COUNT(opts.warn); ++itr)
393 else if (!strcmp(argv[0]+2, "ALL")) {
394 opts_backup_non_Wall();
395 for (itr = 0; itr < GMQCC_ARRAY_COUNT(opts.warn); ++itr)
396 opts.warn[itr] = 0xFFFFFFFFL;
397 opts_restore_non_Wall();
400 else if (!strncmp(argv[0]+2, "ERROR_", 6)) {
401 if (!opts_setwerror(argv[0]+8, true)) {
402 con_out("unknown warning: %s\n", argv[0]+2);
406 else if (!strncmp(argv[0]+2, "NO_ERROR_", 9)) {
407 if (!opts_setwerror(argv[0]+11, false)) {
408 con_out("unknown warning: %s\n", argv[0]+2);
412 else if (!strncmp(argv[0]+2, "NO_", 3)) {
413 if (!opts_setwarn(argv[0]+5, false)) {
414 con_out("unknown warning: %s\n", argv[0]+2);
418 else if (!opts_setwarn(argv[0]+2, true)) {
419 con_out("unknown warning: %s\n", argv[0]+2);
425 if (!options_witharg(&argc, &argv, &argarg)) {
426 con_out("option -O requires a numerical argument, or optimization name with an optional 'no-' prefix\n");
429 if (util_isdigit(argarg[0])) {
430 uint32_t val = (uint32_t)strtol(argarg, NULL, 10);
431 OPTS_OPTION_U32(OPTION_O) = val;
432 opts_setoptimlevel(val);
434 util_strtocmd(argarg, argarg, strlen(argarg)+1);
435 if (!strcmp(argarg, "HELP")) {
436 con_out("Possible optimizations:\n");
437 for (itr = 0; itr < COUNT_OPTIMIZATIONS; ++itr) {
438 util_strtononcmd(opts_opt_list[itr].name, buffer, sizeof(buffer));
439 con_out(" -O%-20s (-O%u)\n", buffer, opts_opt_oflag[itr]);
443 else if (!strcmp(argarg, "ALL"))
444 opts_setoptimlevel(OPTS_OPTION_U32(OPTION_O) = 9999);
445 else if (!strncmp(argarg, "NO_", 3)) {
446 /* constant folding cannot be turned off for obvious reasons */
447 if (!strcmp(argarg, "NO_CONST_FOLD") || !opts_setoptim(argarg+3, false)) {
448 con_out("unknown optimization: %s\n", argarg+3);
453 if (!opts_setoptim(argarg, true)) {
454 con_out("unknown optimization: %s\n", argarg);
462 if (!options_witharg(&argc, &argv, &argarg)) {
463 con_out("option -o requires an argument: the output file name\n");
466 OPTS_OPTION_STR(OPTION_OUTPUT) = argarg;
467 opts_output_wasset = true;
472 item.type = argv[0][1] == 'a' ? TYPE_ASM : TYPE_SRC;
473 if (!options_witharg(&argc, &argv, &argarg)) {
474 con_out("option -a requires a filename %s\n",
475 (argv[0][1] == 'a' ? "containing QC-asm" : "containing a progs.src formatted list"));
478 item.filename = argarg;
479 vec_push(items, item);
484 /* anything following -- is considered a non-option argument */
488 /* All long options without arguments */
489 else if (!strcmp(argv[0]+2, "help")) {
493 else if (!strcmp(argv[0]+2, "version")) {
497 else if (!strcmp(argv[0]+2, "quiet")) {
498 OPTS_OPTION_BOOL(OPTION_QUIET) = true;
501 else if (!strcmp(argv[0]+2, "correct")) {
502 OPTS_OPTION_BOOL(OPTION_CORRECTION) = true;
505 else if (!strcmp(argv[0]+2, "no-correct")) {
506 OPTS_OPTION_BOOL(OPTION_CORRECTION) = false;
509 else if (!strcmp(argv[0]+2, "add-info")) {
510 OPTS_OPTION_BOOL(OPTION_ADD_INFO) = true;
514 /* All long options with arguments */
515 if (options_long_witharg("output", &argc, &argv, &argarg)) {
516 OPTS_OPTION_STR(OPTION_OUTPUT) = argarg;
517 opts_output_wasset = true;
519 con_out("Unknown parameter: %s\n", argv[0]);
526 con_out("Unknown parameter: %s\n", argv[0]);
532 /* it's a QC filename */
533 item.filename = argv[0];
535 vec_push(items, item);
538 opts_ini_init(config);
542 /* returns the line number, or -1 on error */
543 static bool progs_nextline(char **out, size_t *alen, fs_file_t *src) {
550 len = fs_file_getline(&line, alen, src);
554 /* start at first non-blank */
555 for (start = line; util_isspace(*start); ++start) {}
556 /* end at the first non-blank */
557 for (end = start; *end && !util_isspace(*end); ++end) {}
560 /* move the actual filename to the beginning */
561 while (start != end) {
568 int main(int argc, char **argv) {
571 bool operators_free = false;
572 bool progs_src = false;
573 fs_file_t *outfile = NULL;
574 struct parser_s *parser = NULL;
575 struct ftepp_s *ftepp = NULL;
579 opts_init("progs.dat", COMPILER_QCC, (1024 << 3));
583 if (!options_parse(argc, argv)) {
587 if (OPTS_FLAG(TRUE_EMPTY_STRINGS) && OPTS_FLAG(FALSE_EMPTY_STRINGS)) {
588 con_err("-ftrue-empty-strings and -ffalse-empty-strings are mutually exclusive");
592 /* the standard decides which set of operators to use */
593 if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
594 operators = c_operators;
595 operator_count = GMQCC_ARRAY_COUNT(c_operators);
596 } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_FTEQCC) {
597 operators = fte_operators;
598 operator_count = GMQCC_ARRAY_COUNT(fte_operators);
600 operators = qcc_operators;
601 operator_count = GMQCC_ARRAY_COUNT(qcc_operators);
604 if (operators == fte_operators) {
606 if (OPTS_FLAG(CORRECT_TERNARY)) {
608 if (operators[operator_count-2].id != opid1(',') ||
609 operators[operator_count-1].id != opid2(':','?'))
611 con_err("internal error: operator precedence table wasn't updated correctly!\n");
614 operators_free = true;
615 newops = (oper_info*)mem_a(sizeof(operators[0]) * operator_count);
616 memcpy(newops, operators, sizeof(operators[0]) * operator_count);
617 memcpy(&newops[operator_count-2], &operators[operator_count-1], sizeof(newops[0]));
618 memcpy(&newops[operator_count-1], &operators[operator_count-2], sizeof(newops[0]));
619 newops[operator_count-2].prec = newops[operator_count-1].prec+1;
624 if (OPTS_OPTION_BOOL(OPTION_DUMP)) {
625 for (itr = 0; itr < COUNT_FLAGS; ++itr)
626 con_out("Flag %s = %i\n", opts_flag_list[itr].name, OPTS_FLAG(itr));
627 for (itr = 0; itr < COUNT_WARNINGS; ++itr)
628 con_out("Warning %s = %i\n", opts_warn_list[itr].name, OPTS_WARN(itr));
630 con_out("output = %s\n", OPTS_OPTION_STR(OPTION_OUTPUT));
631 con_out("optimization level = %u\n", OPTS_OPTION_U32(OPTION_O));
632 con_out("standard = %u\n", OPTS_OPTION_U32(OPTION_STANDARD));
635 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY)) {
636 if (opts_output_wasset) {
637 outfile = fs_file_open(OPTS_OPTION_STR(OPTION_OUTPUT), "wb");
639 con_err("failed to open `%s` for writing\n", OPTS_OPTION_STR(OPTION_OUTPUT));
645 outfile = con_default_out();
649 if (!OPTS_OPTION_BOOL(OPTION_PP_ONLY)) {
650 if (!(parser = parser_create())) {
651 con_err("failed to initialize parser\n");
657 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY) || OPTS_FLAG(FTEPP)) {
658 if (!(ftepp = ftepp_create())) {
659 con_err("failed to initialize parser\n");
666 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY) || OPTS_FLAG(FTEPP)) {
667 for (itr = 0; itr < vec_size(ppems); itr++) {
668 ftepp_add_macro(ftepp, ppems[itr].name, ppems[itr].value);
669 mem_d(ppems[itr].name);
672 if (ppems[itr].value)
673 mem_d(ppems[itr].value);
677 if (!vec_size(items)) {
681 bool hasline = false;
685 src = fs_file_open(OPTS_OPTION_STR(OPTION_PROGSRC), "rb");
687 con_err("failed to open `%s` for reading\n", OPTS_OPTION_STR(OPTION_PROGSRC));
692 while (progs_nextline(&line, &linelen, src)) {
695 if (!line[0] || (line[0] == '/' && line[1] == '/'))
699 item.filename = util_strdup(line);
701 vec_push(items, item);
702 } else if (!opts_output_wasset) {
703 OPTS_OPTION_DUP(OPTION_OUTPUT) = util_strdup(line);
712 if (vec_size(items)) {
713 if (!OPTS_OPTION_BOOL(OPTION_QUIET) &&
714 !OPTS_OPTION_BOOL(OPTION_PP_ONLY))
716 con_out("Mode: %s\n", (progs_src ? "progs.src" : "manual"));
717 con_out("There are %lu items to compile:\n", (unsigned long)vec_size(items));
720 for (itr = 0; itr < vec_size(items); ++itr) {
721 if (!OPTS_OPTION_BOOL(OPTION_QUIET) &&
722 !OPTS_OPTION_BOOL(OPTION_PP_ONLY))
724 con_out(" item: %s (%s)\n",
726 ( (items[itr].type == TYPE_QC ? "qc" :
727 (items[itr].type == TYPE_ASM ? "asm" :
728 (items[itr].type == TYPE_SRC ? "progs.src" :
732 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY)) {
734 if (!ftepp_preprocess_file(ftepp, items[itr].filename)) {
738 out = ftepp_get(ftepp);
740 fs_file_printf(outfile, "%s", out);
744 if (OPTS_FLAG(FTEPP)) {
746 if (!ftepp_preprocess_file(ftepp, items[itr].filename)) {
750 data = ftepp_get(ftepp);
751 if (vec_size(data)) {
752 if (!parser_compile_string(parser, items[itr].filename, data, vec_size(data))) {
760 if (!parser_compile_file(parser, items[itr].filename)) {
768 mem_d(items[itr].filename);
769 items[itr].filename = NULL;
775 if (!OPTS_OPTION_BOOL(OPTION_PP_ONLY)) {
776 if (!parser_finish(parser, OPTS_OPTION_STR(OPTION_OUTPUT))) {
790 if (!OPTS_OPTION_BOOL(OPTION_PP_ONLY))
791 if(parser) parser_cleanup(parser);
793 /* free allocated option strings */
794 for (itr = 0; itr < OPTION_COUNT; itr++)
795 if (OPTS_OPTION_DUPED(itr))
796 mem_d(OPTS_OPTION_STR(itr));
799 mem_d((void*)operators);
804 if (!retval && compile_errors)