main.c

   1 /*
   2  * Copyright (C) 2012
   3  *     Dale Weiler
   4  *
   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:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  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
  21  * SOFTWARE.
  22  */
  23 #include "gmqcc.h"
  24 #include "lexer.h"
  25
  26 uint32_t    opts_flags[1 + (COUNT_FLAGS / 32)];
  27 uint32_t    opts_warn [1 + (COUNT_WARNINGS / 32)];
  28
  29 uint32_t    opts_O        = 1;
  30 const char *opts_output   = "progs.dat";
  31 int         opts_standard = COMPILER_GMQCC;
  32 bool        opts_debug    = false;
  33 bool        opts_memchk   = false;
  34 bool        opts_dump     = false;
  35 bool        opts_werror   = false;
  36 bool        opts_forcecrc = false;
  37 bool        opts_pp_only  = false;
  38 size_t      opts_max_array_size = 1024;
  39
  40 uint16_t    opts_forced_crc;
  41
  42 static bool opts_output_wasset = false;
  43
  44 /* set by the standard */
  45 const oper_info *operators      = NULL;
  46 size_t           operator_count = 0;
  47
  48 typedef struct { char *filename; int type; } argitem;
  49 VECTOR_MAKE(argitem, items);
  50
  51 #define TYPE_QC  0
  52 #define TYPE_ASM 1
  53 #define TYPE_SRC 2
  54
  55 static const char *app_name;
  56
  57 static int usage() {
  58     con_out("usage: %s [options] [files...]", app_name);
  59     con_out("options:\n"
  60            "  -h, --help             show this help message\n"
  61            "  -debug                 turns on compiler debug messages\n"
  62            "  -memchk                turns on compiler memory leak check\n");
  63     con_out("  -o, --output=file      output file, defaults to progs.dat\n"
  64            "  -a filename            add an asm file to be assembled\n"
  65            "  -s filename            add a progs.src file to be used\n");
  66     con_out("  -E                     stop after preprocessing\n");
  67     con_out("  -f<flag>               enable a flag\n"
  68            "  -fno-<flag>            disable a flag\n"
  69            "  -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("  -W<warning>            enable a warning\n"
  74            "  -Wno-<warning>         disable a warning\n"
  75            "  -Wall                  enable all warnings\n"
  76            "  -Werror                treat warnings as errors\n");
  77     con_out("  -force-crc=num         force a specific checksum into the header\n");
  78     con_out("\n");
  79     con_out("flags:\n"
  80            "  -fadjust-vector-fields\n"
  81            "            when assigning a vector field, its _y and _z fields also get assigned\n"
  82            );
  83     return -1;
  84 }
  85
  86 static bool options_setflag_all(const char *name, bool on, uint32_t *flags, const opts_flag_def *list, size_t listsize) {
  87     size_t i;
  88
  89     for (i = 0; i < listsize; ++i) {
  90         if (!strcmp(name, list[i].name)) {
  91             longbit lb = list[i].bit;
  92 #if 0
  93             if (on)
  94                 flags[lb.idx] |= (1<<(lb.bit));
  95             else
  96                 flags[lb.idx] &= ~(1<<(lb.bit));
  97 #else
  98             if (on)
  99                 flags[0] |= (1<<lb);
 100             else
 101                 flags[0] &= ~(1<<(lb));
 102 #endif
 103             return true;
 104         }
 105     }
 106     return false;
 107 }
 108 static bool options_setflag(const char *name, bool on) {
 109     return options_setflag_all(name, on, opts_flags, opts_flag_list, COUNT_FLAGS);
 110 }
 111 static bool options_setwarn(const char *name, bool on) {
 112     return options_setflag_all(name, on, opts_warn, opts_warn_list, COUNT_WARNINGS);
 113 }
 114
 115 static bool options_witharg(int *argc_, char ***argv_, char **out) {
 116     int  argc   = *argc_;
 117     char **argv = *argv_;
 118
 119     if (argv[0][2]) {
 120         *out = argv[0]+2;
 121         return true;
 122     }
 123     /* eat up the next */
 124     if (argc < 2) /* no parameter was provided */
 125         return false;
 126
 127     *out = argv[1];
 128     --*argc_;
 129     ++*argv_;
 130     return true;
 131 }
 132
 133 static bool options_long_witharg_all(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
 134     int  argc   = *argc_;
 135     char **argv = *argv_;
 136
 137     size_t len = strlen(optname);
 138
 139     if (strncmp(argv[0]+ds, optname, len))
 140         return false;
 141
 142     /* it's --optname, check how the parameter is supplied */
 143     if (argv[0][ds+len] == '=') {
 144         /* using --opt=param */
 145         *out = argv[0]+ds+len+1;
 146         return true;
 147     }
 148
 149     if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
 150         return false;
 151
 152     /* using --opt param */
 153     *out = argv[1];
 154     --*argc_;
 155     ++*argv_;
 156     return true;
 157 }
 158 static bool options_long_witharg(const char *optname, int *argc_, char ***argv_, char **out) {
 159     return options_long_witharg_all(optname, argc_, argv_, out, 2, true);
 160 }
 161 static bool options_long_gcc(const char *optname, int *argc_, char ***argv_, char **out) {
 162     return options_long_witharg_all(optname, argc_, argv_, out, 1, false);
 163 }
 164
 165 static void options_set(uint32_t *flags, size_t idx, bool on)
 166 {
 167     longbit lb = LONGBIT(idx);
 168 #if 0
 169     if (on)
 170         flags[lb.idx] |= (1<<(lb.bit));
 171     else
 172         flags[lb.idx] &= ~(1<<(lb.bit));
 173 #else
 174     if (on)
 175         flags[0] |= (1<<(lb));
 176     else
 177         flags[0] &= ~(1<<(lb));
 178 #endif
 179 }
 180
 181 static bool options_parse(int argc, char **argv) {
 182     bool argend = false;
 183     size_t itr;
 184     char buffer[1024];
 185     while (!argend && argc > 1) {
 186         char *argarg;
 187         argitem item;
 188
 189         ++argv;
 190         --argc;
 191
 192         if (argv[0][0] == '-') {
 193     /* All gcc-type long options */
 194             if (options_long_gcc("std", &argc, &argv, &argarg)) {
 195                 if      (!strcmp(argarg, "gmqcc") || !strcmp(argarg, "default")) {
 196                     options_set(opts_flags, ADJUST_VECTOR_FIELDS, true);
 197                     opts_standard = COMPILER_GMQCC;
 198                 } else if (!strcmp(argarg, "qcc")) {
 199                     options_set(opts_flags, ADJUST_VECTOR_FIELDS, false);
 200                     opts_standard = COMPILER_QCC;
 201                 } else if (!strcmp(argarg, "fte") || !strcmp(argarg, "fteqcc")) {
 202                     options_set(opts_flags, ADJUST_VECTOR_FIELDS, false);
 203                     opts_standard = COMPILER_FTEQCC;
 204                 } else if (!strcmp(argarg, "qccx")) {
 205                     options_set(opts_flags, ADJUST_VECTOR_FIELDS, false);
 206                     opts_standard = COMPILER_QCCX;
 207                 } else {
 208                     con_out("Unknown standard: %s\n", argarg);
 209                     return false;
 210                 }
 211                 continue;
 212             }
 213             if (options_long_gcc("force-crc", &argc, &argv, &argarg)) {
 214                 opts_forcecrc = true;
 215                 opts_forced_crc = strtol(argarg, NULL, 0);
 216                 continue;
 217             }
 218             if (!strcmp(argv[0]+1, "debug")) {
 219                 opts_debug = true;
 220                 continue;
 221             }
 222             if (!strcmp(argv[0]+1, "dump")) {
 223                 opts_dump = true;
 224                 continue;
 225             }
 226             if (!strcmp(argv[0]+1, "memchk")) {
 227                 opts_memchk = true;
 228                 continue;
 229             }
 230             if (!strcmp(argv[0]+1, "nocolor")) {
 231                 con_color(0);
 232                 continue;
 233             }
 234
 235             switch (argv[0][1]) {
 236                 /* -h, show usage but exit with 0 */
 237                 case 'h':
 238                     usage();
 239                     exit(0);
 240                     break;
 241
 242                 case 'E':
 243                     opts_pp_only = true;
 244                     break;
 245
 246                 /* handle all -fflags */
 247                 case 'f':
 248                     util_strtocmd(argv[0]+2, argv[0]+2, strlen(argv[0]+2)+1);
 249                     if (!strcmp(argv[0]+2, "HELP")) {
 250                         con_out("Possible flags:\n");
 251                         for (itr = 0; itr < COUNT_FLAGS; ++itr) {
 252                             util_strtononcmd(opts_flag_list[itr].name, buffer, sizeof(buffer));
 253                             con_out(" -f%s\n", buffer);
 254                         }
 255                         exit(0);
 256                     }
 257                     else if (!strncmp(argv[0]+2, "NO_", 3)) {
 258                         if (!options_setflag(argv[0]+5, false)) {
 259                             con_out("unknown flag: %s\n", argv[0]+2);
 260                             return false;
 261                         }
 262                     }
 263                     else if (!options_setflag(argv[0]+2, true)) {
 264                         con_out("unknown flag: %s\n", argv[0]+2);
 265                         return false;
 266                     }
 267                     break;
 268                 case 'W':
 269                     util_strtocmd(argv[0]+2, argv[0]+2, strlen(argv[0]+2)+1);
 270                     if (!strcmp(argv[0]+2, "HELP")) {
 271                         con_out("Possible warnings:\n");
 272                         for (itr = 0; itr < COUNT_WARNINGS; ++itr) {
 273                             util_strtononcmd(opts_warn_list[itr].name, buffer, sizeof(buffer));
 274                             con_out(" -W%s\n", buffer);
 275                         }
 276                         exit(0);
 277                     }
 278                     else if (!strcmp(argv[0]+2, "NO_ERROR")) {
 279                         opts_werror = false;
 280                         break;
 281                     }
 282                     else if (!strcmp(argv[0]+2, "ERROR")) {
 283                         opts_werror = true;
 284                         break;
 285                     }
 286                     else if (!strcmp(argv[0]+2, "NONE")) {
 287                         for (itr = 0; itr < sizeof(opts_warn)/sizeof(opts_warn[0]); ++itr)
 288                             opts_warn[itr] = 0;
 289                         break;
 290                     }
 291                     else if (!strcmp(argv[0]+2, "ALL")) {
 292                         for (itr = 0; itr < sizeof(opts_warn)/sizeof(opts_warn[0]); ++itr)
 293                             opts_warn[itr] = 0xFFFFFFFFL;
 294                         break;
 295                     }
 296                     if (!strncmp(argv[0]+2, "NO_", 3)) {
 297                         if (!options_setwarn(argv[0]+5, false)) {
 298                             con_out("unknown warning: %s\n", argv[0]+2);
 299                             return false;
 300                         }
 301                     }
 302                     else if (!options_setwarn(argv[0]+2, true)) {
 303                         con_out("unknown warning: %s\n", argv[0]+2);
 304                         return false;
 305                     }
 306                     break;
 307
 308                 case 'O':
 309                     if (!options_witharg(&argc, &argv, &argarg)) {
 310                         con_out("option -O requires a numerical argument\n");
 311                         return false;
 312                     }
 313                     opts_O = atoi(argarg);
 314                     break;
 315
 316                 case 'o':
 317                     if (!options_witharg(&argc, &argv, &argarg)) {
 318                         con_out("option -o requires an argument: the output file name\n");
 319                         return false;
 320                     }
 321                     opts_output = argarg;
 322                     opts_output_wasset = true;
 323                     break;
 324
 325                 case 'a':
 326                 case 's':
 327                     item.type = argv[0][1] == 'a' ? TYPE_ASM : TYPE_SRC;
 328                     if (!options_witharg(&argc, &argv, &argarg)) {
 329                         con_out("option -a requires a filename %s\n",
 330                                 (argv[0][1] == 'a' ? "containing QC-asm" : "containing a progs.src formatted list"));
 331                         return false;
 332                     }
 333                     item.filename = argarg;
 334                     items_add(item);
 335                     break;
 336
 337                 case '-':
 338                     if (!argv[0][2]) {
 339                         /* anything following -- is considered a non-option argument */
 340                         argend = true;
 341                         break;
 342                     }
 343             /* All long options without arguments */
 344                     else if (!strcmp(argv[0]+2, "help")) {
 345                         usage();
 346                         exit(0);
 347                     }
 348                     else {
 349             /* All long options with arguments */
 350                         if (options_long_witharg("output", &argc, &argv, &argarg)) {
 351                             opts_output = argarg;
 352                             opts_output_wasset = true;
 353                         } else {
 354                             con_out("Unknown parameter: %s\n", argv[0]);
 355                             return false;
 356                         }
 357                     }
 358                     break;
 359
 360                 default:
 361                     con_out("Unknown parameter: %s\n", argv[0]);
 362                     return false;
 363             }
 364         }
 365         else
 366         {
 367             /* it's a QC filename */
 368             argitem item;
 369             item.filename = argv[0];
 370             item.type     = TYPE_QC;
 371             items_add(item);
 372         }
 373     }
 374     return true;
 375 }
 376
 377 /* returns the line number, or -1 on error */
 378 static bool progs_nextline(char **out, size_t *alen,FILE *src) {
 379     int    len;
 380     char  *line;
 381     char  *start;
 382     char  *end;
 383
 384     line = *out;
 385     len = util_getline(&line, alen, src);
 386     if (len == -1)
 387         return false;
 388
 389     /* start at first non-blank */
 390     for (start = line; isspace(*start); ++start) {}
 391     /* end at the first non-blank */
 392     for (end = start;  *end && !isspace(*end);  ++end)   {}
 393
 394     *out = line;
 395     /* move the actual filename to the beginning */
 396     while (start != end) {
 397         *line++ = *start++;
 398     }
 399     *line = 0;
 400     return true;
 401 }
 402
 403 int main(int argc, char **argv) {
 404     size_t itr;
 405     int retval = 0;
 406     bool opts_output_free = false;
 407
 408     app_name = argv[0];
 409     con_init();
 410
 411     /* default options / warn flags */
 412     options_set(opts_warn, WARN_UNKNOWN_CONTROL_SEQUENCE, true);
 413     options_set(opts_warn, WARN_EXTENSIONS, true);
 414     options_set(opts_warn, WARN_FIELD_REDECLARED, true);
 415     options_set(opts_warn, WARN_TOO_FEW_PARAMETERS, true);
 416     options_set(opts_warn, WARN_MISSING_RETURN_VALUES, true);
 417     options_set(opts_warn, WARN_USED_UNINITIALIZED, true);
 418     options_set(opts_warn, WARN_LOCAL_CONSTANTS, true);
 419     options_set(opts_warn, WARN_VOID_VARIABLES, true);
 420     options_set(opts_warn, WARN_IMPLICIT_FUNCTION_POINTER, true);
 421     options_set(opts_warn, WARN_VARIADIC_FUNCTION, true);
 422     options_set(opts_warn, WARN_FRAME_MACROS, true);
 423     options_set(opts_warn, WARN_UNUSED_VARIABLE, true);
 424     options_set(opts_warn, WARN_EFFECTLESS_STATEMENT, true);
 425     options_set(opts_warn, WARN_END_SYS_FIELDS, true);
 426     options_set(opts_warn, WARN_ASSIGN_FUNCTION_TYPES, true);
 427
 428     options_set(opts_flags, ADJUST_VECTOR_FIELDS, true);
 429
 430     if (!options_parse(argc, argv)) {
 431         return usage();
 432     }
 433
 434     /* the standard decides which set of operators to use */
 435     if (opts_standard == COMPILER_GMQCC) {
 436         operators = c_operators;
 437         operator_count = c_operator_count;
 438     } else {
 439         operators = qcc_operators;
 440         operator_count = qcc_operator_count;
 441     }
 442
 443     if (opts_dump) {
 444         for (itr = 0; itr < COUNT_FLAGS; ++itr) {
 445             con_out("Flag %s = %i\n", opts_flag_list[itr].name, OPTS_FLAG(itr));
 446         }
 447         for (itr = 0; itr < COUNT_WARNINGS; ++itr) {
 448             con_out("Warning %s = %i\n", opts_warn_list[itr].name, OPTS_WARN(itr));
 449         }
 450         con_out("output = %s\n", opts_output);
 451         con_out("optimization level = %i\n", (int)opts_O);
 452         con_out("standard = %i\n", opts_standard);
 453     }
 454
 455     if (!parser_init()) {
 456         con_out("failed to initialize parser\n");
 457         retval = 1;
 458         goto cleanup;
 459     }
 460
 461     util_debug("COM", "starting ...\n");
 462
 463     if (items_elements) {
 464         con_out("Mode: manual\n");
 465         con_out("There are %lu items to compile:\n", (unsigned long)items_elements);
 466         for (itr = 0; itr < items_elements; ++itr) {
 467             con_out("  item: %s (%s)\n",
 468                    items_data[itr].filename,
 469                    ( (items_data[itr].type == TYPE_QC ? "qc" :
 470                      (items_data[itr].type == TYPE_ASM ? "asm" :
 471                      (items_data[itr].type == TYPE_SRC ? "progs.src" :
 472                      ("unknown"))))));
 473
 474             if (!parser_compile_file(items_data[itr].filename))
 475             {
 476                     retval = 1;
 477                     goto cleanup;
 478             }
 479         }
 480
 481         if (!parser_finish(opts_output)) {
 482             retval = 1;
 483             goto cleanup;
 484         }
 485
 486     } else {
 487         FILE *src;
 488         char *line;
 489         size_t linelen = 0;
 490
 491         con_out("Mode: progs.src\n");
 492         src = util_fopen("progs.src", "rb");
 493         if (!src) {
 494             con_out("failed to open `progs.src` for reading\n");
 495             retval = 1;
 496             goto cleanup;
 497         }
 498
 499         line = NULL;
 500         if (!progs_nextline(&line, &linelen, src) || !line[0]) {
 501             con_out("illformatted progs.src file: expected output filename in first line\n");
 502             retval = 1;
 503             goto srcdone;
 504         }
 505
 506         if (!opts_output_wasset) {
 507             opts_output = util_strdup(line);
 508             opts_output_free = true;
 509         }
 510
 511         while (progs_nextline(&line, &linelen, src)) {
 512             if (!line[0] || (line[0] == '/' && line[1] == '/'))
 513                 continue;
 514             con_out("  src: %s\n", line);
 515             if (!parser_compile_file(line)) {
 516                 retval = 1;
 517                 goto srcdone;
 518             }
 519         }
 520
 521         parser_finish(opts_output);
 522
 523 srcdone:
 524         fclose(src);
 525         mem_d(line);
 526     }
 527
 528     /* stuff */
 529
 530 cleanup:
 531     util_debug("COM", "cleaning ...\n");
 532
 533     mem_d(items_data);
 534
 535     parser_cleanup();
 536     if (opts_output_free)
 537         mem_d((char*)opts_output);
 538
 539     lex_cleanup();
 540     util_meminfo();
 541     return retval;
 542 }