2 * Copyright (C) 2012, 2013
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
28 /* TODO: cleanup this whole file .. it's a fuckign mess */
30 /* set by the standard */
31 const oper_info *operators = NULL;
32 size_t operator_count = 0;
33 static bool opts_output_wasset = false;
35 typedef struct { char *filename; int type; } argitem;
36 typedef struct { char *name; char *value; } ppitem;
37 static argitem *items = NULL;
38 static ppitem *ppems = NULL;
44 static const char *app_name;
46 static void version() {
47 con_out("GMQCC %d.%d.%d Built %s %s\n" GMQCC_DEV_VERSION_STRING,
57 con_out("usage: %s [options] [files...]", app_name);
59 " -h, --help show this help message\n"
60 " -debug turns on compiler debug messages\n"
61 " -memchk turns on compiler memory leak check\n");
62 con_out(" -o, --output=file output file, defaults to progs.dat\n"
63 " -s filename add a progs.src file to be used\n");
64 con_out(" -E stop after preprocessing\n");
65 con_out(" -q, --quiet be less verbose\n");
66 con_out(" -config file use the specified ini file\n");
67 con_out(" -std=standard select one of the following standards\n"
68 " -std=qcc original QuakeC\n"
69 " -std=fteqcc fteqcc QuakeC\n"
70 " -std=gmqcc this compiler (default)\n");
71 con_out(" -f<flag> enable a flag\n"
72 " -fno-<flag> disable a flag\n"
73 " -fhelp list possible flags\n");
74 con_out(" -W<warning> enable a warning\n"
75 " -Wno-<warning> disable a warning\n"
76 " -Wall enable all warnings\n");
77 con_out(" -Werror treat warnings as errors\n"
78 " -Werror-<warning> treat a warning as error\n"
79 " -Wno-error-<warning> opposite of the above\n");
80 con_out(" -Whelp list possible warnings\n");
81 con_out(" -O<number> optimization level\n"
82 " -O<name> enable specific optimization\n"
83 " -Ono-<name> disable specific optimization\n"
84 " -Ohelp list optimizations\n");
85 con_out(" -force-crc=num force a specific checksum into the header\n");
89 /* command line parsing */
90 static bool options_witharg(int *argc_, char ***argv_, char **out) {
99 if (argc < 2) /* no parameter was provided */
108 static bool options_long_witharg_all(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
110 char **argv = *argv_;
112 size_t len = strlen(optname);
114 if (strncmp(argv[0]+ds, optname, len))
117 /* it's --optname, check how the parameter is supplied */
118 if (argv[0][ds+len] == '=') {
119 /* using --opt=param */
120 *out = argv[0]+ds+len+1;
124 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
127 /* using --opt param */
133 static bool options_long_witharg(const char *optname, int *argc_, char ***argv_, char **out) {
134 return options_long_witharg_all(optname, argc_, argv_, out, 2, true);
136 static bool options_long_gcc(const char *optname, int *argc_, char ***argv_, char **out) {
137 return options_long_witharg_all(optname, argc_, argv_, out, 1, false);
140 static bool options_parse(int argc, char **argv) {
144 char *redirout = NULL;
145 char *redirerr = NULL;
147 char *memdumpcols = NULL;
149 while (!argend && argc > 1) {
157 if (argv[0][0] == '-') {
158 /* All gcc-type long options */
159 if (options_long_gcc("std", &argc, &argv, &argarg)) {
160 if (!strcmp(argarg, "gmqcc") || !strcmp(argarg, "default")) {
162 opts_set(opts.flags, ADJUST_VECTOR_FIELDS, true);
163 opts_set(opts.flags, CORRECT_LOGIC, true);
164 opts_set(opts.flags, FALSE_EMPTY_STRINGS, false);
165 opts_set(opts.flags, TRUE_EMPTY_STRINGS, true);
166 opts_set(opts.flags, LOOP_LABELS, true);
167 opts_set(opts.flags, TRANSLATABLE_STRINGS, true);
168 opts_set(opts.flags, INITIALIZED_NONCONSTANTS, true);
169 opts_set(opts.werror, WARN_INVALID_PARAMETER_COUNT, true);
170 opts_set(opts.werror, WARN_MISSING_RETURN_VALUES, true);
171 opts_set(opts.flags, EXPRESSIONS_FOR_BUILTINS, true);
174 OPTS_OPTION_U32(OPTION_STANDARD) = COMPILER_GMQCC;
176 } else if (!strcmp(argarg, "qcc")) {
178 opts_set(opts.flags, ADJUST_VECTOR_FIELDS, false);
179 opts_set(opts.flags, ASSIGN_FUNCTION_TYPES, true);
181 OPTS_OPTION_U32(OPTION_STANDARD) = COMPILER_QCC;
183 } else if (!strcmp(argarg, "fte") || !strcmp(argarg, "fteqcc")) {
185 opts_set(opts.flags, FTEPP, true);
186 opts_set(opts.flags, TRANSLATABLE_STRINGS, true);
187 opts_set(opts.flags, ADJUST_VECTOR_FIELDS, false);
188 opts_set(opts.flags, ASSIGN_FUNCTION_TYPES, true);
189 opts_set(opts.flags, CORRECT_TERNARY, false);
190 opts_set(opts.warn, WARN_TERNARY_PRECEDENCE, true);
192 OPTS_OPTION_U32(OPTION_STANDARD) = COMPILER_FTEQCC;
194 } else if (!strcmp(argarg, "qccx")) {
196 opts_set(opts.flags, ADJUST_VECTOR_FIELDS, false);
197 OPTS_OPTION_U32(OPTION_STANDARD) = COMPILER_QCCX;
200 con_out("Unknown standard: %s\n", argarg);
205 if (options_long_gcc("force-crc", &argc, &argv, &argarg)) {
207 OPTS_OPTION_BOOL(OPTION_FORCECRC) = true;
208 OPTS_OPTION_U16 (OPTION_FORCED_CRC) = strtol(argarg, NULL, 0);
211 if (options_long_gcc("redirout", &argc, &argv, &redirout)) {
212 con_change(redirout, redirerr);
215 if (options_long_gcc("redirerr", &argc, &argv, &redirerr)) {
216 con_change(redirout, redirerr);
219 if (options_long_gcc("config", &argc, &argv, &argarg)) {
223 if (options_long_gcc("memdumpcols", &argc, &argv, &memdumpcols)) {
224 OPTS_OPTION_U16(OPTION_MEMDUMPCOLS) = (uint16_t)strtol(memdumpcols, NULL, 10);
228 /* show defaults (like pathscale) */
229 if (!strcmp(argv[0]+1, "show-defaults")) {
230 for (itr = 0; itr < COUNT_FLAGS; ++itr) {
234 memset(buffer, 0, sizeof(buffer));
235 util_strtononcmd(opts_flag_list[itr].name, buffer, strlen(opts_flag_list[itr].name) + 1);
237 con_out("-f%s ", buffer);
239 for (itr = 0; itr < COUNT_WARNINGS; ++itr) {
243 memset(buffer, 0, sizeof(buffer));
244 util_strtononcmd(opts_warn_list[itr].name, buffer, strlen(opts_warn_list[itr].name) + 1);
245 con_out("-W%s ", buffer);
251 if (!strcmp(argv[0]+1, "debug")) {
252 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
255 if (!strcmp(argv[0]+1, "dump")) {
256 OPTS_OPTION_BOOL(OPTION_DUMP) = true;
259 if (!strcmp(argv[0]+1, "dumpfin")) {
260 OPTS_OPTION_BOOL(OPTION_DUMPFIN) = true;
263 if (!strcmp(argv[0]+1, "memchk")) {
264 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
267 if (!strcmp(argv[0]+1, "nocolor")) {
272 switch (argv[0][1]) {
273 /* -h, show usage but exit with 0 */
277 /* break; never reached because of exit(0) */
284 OPTS_OPTION_BOOL(OPTION_PP_ONLY) = true;
285 opts_set(opts.flags, FTEPP_PREDEFS, true); /* predefs on for -E */
288 /* debug turns on -flno */
290 opts_setflag("LNO", true);
291 OPTS_OPTION_BOOL(OPTION_G) = true;
295 OPTS_OPTION_BOOL(OPTION_QUIET) = true;
299 if (!strlen(argv[0]+2)) {
300 con_err("expected name after -D\n");
304 if (!(argarg = strchr(argv[0] + 2, '='))) {
305 macro.name = util_strdup(argv[0]+2);
308 *argarg='\0'; /* terminate for name */
309 macro.name = util_strdup(argv[0]+2);
310 macro.value = util_strdup(argarg+1);
312 vec_push(ppems, macro);
315 /* handle all -fflags */
317 util_strtocmd(argv[0]+2, argv[0]+2, strlen(argv[0]+2)+1);
318 if (!strcmp(argv[0]+2, "HELP") || *(argv[0]+2) == '?') {
319 con_out("Possible flags:\n\n");
320 for (itr = 0; itr < COUNT_FLAGS; ++itr) {
321 util_strtononcmd(opts_flag_list[itr].name, buffer, sizeof(buffer));
322 con_out(" -f%s\n", buffer);
326 else if (!strncmp(argv[0]+2, "NO_", 3)) {
327 if (!opts_setflag(argv[0]+5, false)) {
328 con_out("unknown flag: %s\n", argv[0]+2);
332 else if (!opts_setflag(argv[0]+2, true)) {
333 con_out("unknown flag: %s\n", argv[0]+2);
338 util_strtocmd(argv[0]+2, argv[0]+2, strlen(argv[0]+2)+1);
339 if (!strcmp(argv[0]+2, "HELP") || *(argv[0]+2) == '?') {
340 con_out("Possible warnings:\n");
341 for (itr = 0; itr < COUNT_WARNINGS; ++itr) {
342 util_strtononcmd(opts_warn_list[itr].name, buffer, sizeof(buffer));
343 con_out(" -W%s\n", buffer);
344 if (itr == WARN_DEBUG)
345 con_out(" Warnings included by -Wall:\n");
349 else if (!strcmp(argv[0]+2, "NO_ERROR") ||
350 !strcmp(argv[0]+2, "NO_ERROR_ALL"))
352 for (itr = 0; itr < sizeof(opts.werror)/sizeof(opts.werror[0]); ++itr)
353 opts.werror[itr] = 0;
356 else if (!strcmp(argv[0]+2, "ERROR") ||
357 !strcmp(argv[0]+2, "ERROR_ALL"))
359 opts_backup_non_Werror_all();
360 for (itr = 0; itr < sizeof(opts.werror)/sizeof(opts.werror[0]); ++itr)
361 opts.werror[itr] = 0xFFFFFFFFL;
362 opts_restore_non_Werror_all();
365 else if (!strcmp(argv[0]+2, "NONE")) {
366 for (itr = 0; itr < sizeof(opts.warn)/sizeof(opts.warn[0]); ++itr)
370 else if (!strcmp(argv[0]+2, "ALL")) {
371 opts_backup_non_Wall();
372 for (itr = 0; itr < sizeof(opts.warn)/sizeof(opts.warn[0]); ++itr)
373 opts.warn[itr] = 0xFFFFFFFFL;
374 opts_restore_non_Wall();
377 else if (!strncmp(argv[0]+2, "ERROR_", 6)) {
378 if (!opts_setwerror(argv[0]+8, true)) {
379 con_out("unknown warning: %s\n", argv[0]+2);
383 else if (!strncmp(argv[0]+2, "NO_ERROR_", 9)) {
384 if (!opts_setwerror(argv[0]+11, false)) {
385 con_out("unknown warning: %s\n", argv[0]+2);
389 else if (!strncmp(argv[0]+2, "NO_", 3)) {
390 if (!opts_setwarn(argv[0]+5, false)) {
391 con_out("unknown warning: %s\n", argv[0]+2);
395 else if (!opts_setwarn(argv[0]+2, true)) {
396 con_out("unknown warning: %s\n", argv[0]+2);
402 if (!options_witharg(&argc, &argv, &argarg)) {
403 con_out("option -O requires a numerical argument, or optimization name with an optional 'no-' prefix\n");
406 if (isdigit(argarg[0])) {
407 uint32_t val = (uint32_t)strtol(argarg, NULL, 10);
408 OPTS_OPTION_U32(OPTION_O) = val;
409 opts_setoptimlevel(val);
411 util_strtocmd(argarg, argarg, strlen(argarg)+1);
412 if (!strcmp(argarg, "HELP")) {
413 con_out("Possible optimizations:\n");
414 for (itr = 0; itr < COUNT_OPTIMIZATIONS; ++itr) {
415 util_strtononcmd(opts_opt_list[itr].name, buffer, sizeof(buffer));
416 con_out(" -O%-20s (-O%u)\n", buffer, opts_opt_oflag[itr]);
420 else if (!strcmp(argarg, "ALL"))
421 opts_setoptimlevel(OPTS_OPTION_U32(OPTION_O) = 9999);
422 else if (!strncmp(argarg, "NO_", 3)) {
423 if (!opts_setoptim(argarg+3, false)) {
424 con_out("unknown optimization: %s\n", argarg+3);
429 if (!opts_setoptim(argarg, true)) {
430 con_out("unknown optimization: %s\n", argarg);
438 if (!options_witharg(&argc, &argv, &argarg)) {
439 con_out("option -o requires an argument: the output file name\n");
442 OPTS_OPTION_STR(OPTION_OUTPUT) = argarg;
443 opts_output_wasset = true;
448 item.type = argv[0][1] == 'a' ? TYPE_ASM : TYPE_SRC;
449 if (!options_witharg(&argc, &argv, &argarg)) {
450 con_out("option -a requires a filename %s\n",
451 (argv[0][1] == 'a' ? "containing QC-asm" : "containing a progs.src formatted list"));
454 item.filename = argarg;
455 vec_push(items, item);
460 /* anything following -- is considered a non-option argument */
464 /* All long options without arguments */
465 else if (!strcmp(argv[0]+2, "help")) {
469 else if (!strcmp(argv[0]+2, "version")) {
473 else if (!strcmp(argv[0]+2, "quiet")) {
474 OPTS_OPTION_BOOL(OPTION_QUIET) = true;
477 else if (!strcmp(argv[0]+2, "correct")) {
478 OPTS_OPTION_BOOL(OPTION_CORRECTION) = true;
481 else if (!strcmp(argv[0]+2, "no-correct")) {
482 OPTS_OPTION_BOOL(OPTION_CORRECTION) = false;
485 else if (!strcmp(argv[0]+2, "add-info")) {
486 OPTS_OPTION_BOOL(OPTION_ADD_INFO) = true;
490 /* All long options with arguments */
491 if (options_long_witharg("output", &argc, &argv, &argarg)) {
492 OPTS_OPTION_STR(OPTION_OUTPUT) = argarg;
493 opts_output_wasset = true;
495 con_out("Unknown parameter: %s\n", argv[0]);
502 con_out("Unknown parameter: %s\n", argv[0]);
508 /* it's a QC filename */
509 item.filename = argv[0];
511 vec_push(items, item);
514 opts_ini_init(config);
518 /* returns the line number, or -1 on error */
519 static bool progs_nextline(char **out, size_t *alen,FILE *src) {
526 len = fs_file_getline(&line, alen, src);
530 /* start at first non-blank */
531 for (start = line; isspace(*start); ++start) {}
532 /* end at the first non-blank */
533 for (end = start; *end && !isspace(*end); ++end) {}
536 /* move the actual filename to the beginning */
537 while (start != end) {
544 int main(int argc, char **argv) {
547 bool opts_output_free = false;
548 bool operators_free = false;
549 bool progs_src = false;
550 FILE *outfile = NULL;
551 struct parser_s *parser = NULL;
552 struct ftepp_s *ftepp = NULL;
556 opts_init("progs.dat", COMPILER_GMQCC, (1024 << 3));
560 if (!options_parse(argc, argv)) {
564 if (OPTS_FLAG(TRUE_EMPTY_STRINGS) && OPTS_FLAG(FALSE_EMPTY_STRINGS)) {
565 con_err("-ftrue-empty-strings and -ffalse-empty-strings are mutually exclusive");
569 /* the standard decides which set of operators to use */
570 if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
571 operators = c_operators;
572 operator_count = c_operator_count;
573 } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_FTEQCC) {
574 operators = fte_operators;
575 operator_count = fte_operator_count;
577 operators = qcc_operators;
578 operator_count = qcc_operator_count;
581 if (operators == fte_operators) {
583 if (OPTS_FLAG(CORRECT_TERNARY)) {
585 if (operators[operator_count-2].id != opid1(',') ||
586 operators[operator_count-1].id != opid2(':','?'))
588 con_err("internal error: operator precedence table wasn't updated correctly!\n");
591 operators_free = true;
592 newops = (oper_info*)mem_a(sizeof(operators[0]) * operator_count);
593 memcpy(newops, operators, sizeof(operators[0]) * operator_count);
594 memcpy(&newops[operator_count-2], &operators[operator_count-1], sizeof(newops[0]));
595 memcpy(&newops[operator_count-1], &operators[operator_count-2], sizeof(newops[0]));
596 newops[operator_count-2].prec = newops[operator_count-1].prec+1;
601 if (OPTS_OPTION_BOOL(OPTION_DUMP)) {
602 for (itr = 0; itr < COUNT_FLAGS; ++itr)
603 con_out("Flag %s = %i\n", opts_flag_list[itr].name, OPTS_FLAG(itr));
604 for (itr = 0; itr < COUNT_WARNINGS; ++itr)
605 con_out("Warning %s = %i\n", opts_warn_list[itr].name, OPTS_WARN(itr));
607 con_out("output = %s\n", OPTS_OPTION_STR(OPTION_OUTPUT));
608 con_out("optimization level = %u\n", OPTS_OPTION_U32(OPTION_O));
609 con_out("standard = %u\n", OPTS_OPTION_U32(OPTION_STANDARD));
612 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY)) {
613 if (opts_output_wasset) {
614 outfile = fs_file_open(OPTS_OPTION_STR(OPTION_OUTPUT), "wb");
616 con_err("failed to open `%s` for writing\n", OPTS_OPTION_STR(OPTION_OUTPUT));
622 outfile = con_default_out();
626 if (!OPTS_OPTION_BOOL(OPTION_PP_ONLY)) {
627 if (!(parser = parser_create())) {
628 con_err("failed to initialize parser\n");
634 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY) || OPTS_FLAG(FTEPP)) {
635 if (!(ftepp = ftepp_create())) {
636 con_err("failed to initialize parser\n");
642 util_debug("COM", "starting ...\n");
645 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY) || OPTS_FLAG(FTEPP)) {
646 for (itr = 0; itr < vec_size(ppems); itr++) {
647 ftepp_add_macro(ftepp, ppems[itr].name, ppems[itr].value);
648 mem_d(ppems[itr].name);
651 if (ppems[itr].value)
652 mem_d(ppems[itr].value);
656 if (!vec_size(items)) {
663 src = fs_file_open("progs.src", "rb");
665 con_err("failed to open `progs.src` for reading\n");
671 if (!progs_nextline(&line, &linelen, src) || !line[0]) {
672 con_err("illformatted progs.src file: expected output filename in first line\n");
677 if (!opts_output_wasset) {
678 OPTS_OPTION_STR(OPTION_OUTPUT) = util_strdup(line);
679 opts_output_free = true;
682 while (progs_nextline(&line, &linelen, src)) {
684 if (!line[0] || (line[0] == '/' && line[1] == '/'))
686 item.filename = util_strdup(line);
688 vec_push(items, item);
699 if (vec_size(items)) {
700 if (!OPTS_OPTION_BOOL(OPTION_QUIET) &&
701 !OPTS_OPTION_BOOL(OPTION_PP_ONLY))
703 con_out("Mode: %s\n", (progs_src ? "progs.src" : "manual"));
704 con_out("There are %lu items to compile:\n", (unsigned long)vec_size(items));
707 for (itr = 0; itr < vec_size(items); ++itr) {
708 if (!OPTS_OPTION_BOOL(OPTION_QUIET) &&
709 !OPTS_OPTION_BOOL(OPTION_PP_ONLY))
711 con_out(" item: %s (%s)\n",
713 ( (items[itr].type == TYPE_QC ? "qc" :
714 (items[itr].type == TYPE_ASM ? "asm" :
715 (items[itr].type == TYPE_SRC ? "progs.src" :
719 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY)) {
721 if (!ftepp_preprocess_file(ftepp, items[itr].filename)) {
725 out = ftepp_get(ftepp);
727 fs_file_printf(outfile, "%s", out);
731 if (OPTS_FLAG(FTEPP)) {
733 if (!ftepp_preprocess_file(ftepp, items[itr].filename)) {
737 data = ftepp_get(ftepp);
738 if (vec_size(data)) {
739 if (!parser_compile_string(parser, items[itr].filename, data, vec_size(data))) {
747 if (!parser_compile_file(parser, items[itr].filename)) {
755 mem_d(items[itr].filename);
756 items[itr].filename = NULL;
762 if (!OPTS_OPTION_BOOL(OPTION_PP_ONLY)) {
763 if (!parser_finish(parser, OPTS_OPTION_STR(OPTION_OUTPUT))) {
771 if (!OPTS_OPTION_BOOL(OPTION_QUIET) &&
772 !OPTS_OPTION_BOOL(OPTION_PP_ONLY))
774 for (itr = 0; itr < COUNT_OPTIMIZATIONS; ++itr) {
775 if (opts_optimizationcount[itr]) {
776 con_out("%s: %u\n", opts_opt_list[itr].name, (unsigned int)opts_optimizationcount[itr]);
782 util_debug("COM", "cleaning ...\n");
789 if (!OPTS_OPTION_BOOL(OPTION_PP_ONLY))
790 parser_cleanup(parser);
791 if (opts_output_free)
792 mem_d(OPTS_OPTION_STR(OPTION_OUTPUT));
794 mem_d((void*)operators);