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
  25 uint32_t    opts_flags[1 + (COUNT_FLAGS / 32)];
  26 uint32_t    opts_warn [1 + (COUNT_WARNINGS / 32)];
  27
  28 uint32_t    opts_O        = 1;
  29 const char *opts_output   = "progs.dat";
  30 int         opts_standard = COMPILER_GMQCC;
  31 bool        opts_debug    = false;
  32 bool        opts_memchk   = false;
  33 bool        opts_dump     = false;
  34 bool        opts_werror   = false;
  35
  36 static bool opts_output_wasset = false;
  37
  38 typedef struct { char *filename; int type; } argitem;
  39 VECTOR_MAKE(argitem, items);
  40
  41 #define TYPE_QC  0
  42 #define TYPE_ASM 1
  43 #define TYPE_SRC 2
  44
  45 static const char *app_name;
  46
  47 static int usage() {
  48     printf("usage: %s [options] [files...]", app_name);
  49     printf("options:\n"
  50            "  -h, --help             show this help message\n"
  51            "  -debug                 turns on compiler debug messages\n"
  52            "  -memchk                turns on compiler memory leak check\n");
  53     printf("  -o, --output=file      output file, defaults to progs.dat\n"
  54            "  -a filename            add an asm file to be assembled\n"
  55            "  -s filename            add a progs.src file to be used\n");
  56     printf("  -f<flag>               enable a flag\n"
  57            "  -fno-<flag>            disable a flag\n"
  58            "  -std standard          select one of the following standards\n"
  59            "       -std=qcc          original QuakeC\n"
  60            "       -std=fteqcc       fteqcc QuakeC\n"
  61            "       -std=gmqcc        this compiler (default)\n");
  62     printf("  -W<warning>            enable a warning\n"
  63            "  -Wno-<warning>         disable a warning\n"
  64            "  -Wall                  enable all warnings\n");
  65     printf("\n");
  66     printf("flags:\n"
  67            "  -fdarkplaces-string-table-bug\n"
  68            "            patch the string table to work with some bugged darkplaces versions\n"
  69            "  -fomit-nullbytes\n"
  70            "            omits certain null-bytes for a smaller output - requires a patched engine\n"
  71            );
  72     return -1;
  73 }
  74
  75 static bool options_setflag_all(const char *name, bool on, uint32_t *flags, const opts_flag_def *list, size_t listsize) {
  76     size_t i;
  77
  78     for (i = 0; i < listsize; ++i) {
  79         if (!strcmp(name, list[i].name)) {
  80             longbit lb = list[i].bit;
  81 #if 0
  82             if (on)
  83                 flags[lb.idx] |= (1<<(lb.bit));
  84             else
  85                 flags[lb.idx] &= ~(1<<(lb.bit));
  86 #else
  87             if (on)
  88                 flags[0] |= (1<<lb);
  89             else
  90                 flags[0] &= ~(1<<(lb));
  91 #endif
  92             return true;
  93         }
  94     }
  95     return false;
  96 }
  97 static bool options_setflag(const char *name, bool on) {
  98     return options_setflag_all(name, on, opts_flags, opts_flag_list, COUNT_FLAGS);
  99 }
 100 static bool options_setwarn(const char *name, bool on) {
 101     return options_setflag_all(name, on, opts_warn, opts_warn_list, COUNT_WARNINGS);
 102 }
 103
 104 static bool options_witharg(int *argc_, char ***argv_, char **out) {
 105     int  argc   = *argc_;
 106     char **argv = *argv_;
 107
 108     if (argv[0][2]) {
 109         *out = argv[0]+2;
 110         return true;
 111     }
 112     /* eat up the next */
 113     if (argc < 2) /* no parameter was provided */
 114         return false;
 115
 116     *out = argv[1];
 117     --*argc_;
 118     ++*argv_;
 119     return true;
 120 }
 121
 122 static bool options_long_witharg_all(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
 123     int  argc   = *argc_;
 124     char **argv = *argv_;
 125
 126     size_t len = strlen(optname);
 127
 128     if (strncmp(argv[0]+ds, optname, len))
 129         return false;
 130
 131     /* it's --optname, check how the parameter is supplied */
 132     if (argv[0][ds+len] == '=') {
 133         /* using --opt=param */
 134         *out = argv[0]+ds+len+1;
 135         return true;
 136     }
 137
 138     if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
 139         return false;
 140
 141     /* using --opt param */
 142     *out = argv[1];
 143     --*argc_;
 144     ++*argv_;
 145     return true;
 146 }
 147 static bool options_long_witharg(const char *optname, int *argc_, char ***argv_, char **out) {
 148     return options_long_witharg_all(optname, argc_, argv_, out, 2, true);
 149 }
 150 static bool options_long_gcc(const char *optname, int *argc_, char ***argv_, char **out) {
 151     return options_long_witharg_all(optname, argc_, argv_, out, 1, false);
 152 }
 153
 154 static bool options_parse(int argc, char **argv) {
 155     bool argend = false;
 156     size_t itr;
 157     char buffer[1024];
 158     while (!argend && argc > 1) {
 159         char *argarg;
 160         argitem item;
 161
 162         ++argv;
 163         --argc;
 164
 165         if (argv[0][0] == '-') {
 166     /* All gcc-type long options */
 167             if (options_long_gcc("std", &argc, &argv, &argarg)) {
 168                 if      (!strcmp(argarg, "gmqcc") || !strcmp(argarg, "default"))
 169                     opts_standard = COMPILER_GMQCC;
 170                 else if (!strcmp(argarg, "qcc"))
 171                     opts_standard = COMPILER_QCC;
 172                 else if (!strcmp(argarg, "fte") || !strcmp(argarg, "fteqcc"))
 173                     opts_standard = COMPILER_FTEQCC;
 174                 else if (!strcmp(argarg, "qccx"))
 175                     opts_standard = COMPILER_QCCX;
 176                 else {
 177                     printf("Unknown standard: %s\n", argarg);
 178                     return false;
 179                 }
 180                 continue;
 181             }
 182             if (!strcmp(argv[0]+1, "debug")) {
 183                 opts_debug = true;
 184                 continue;
 185             }
 186             if (!strcmp(argv[0]+1, "dump")) {
 187                 opts_dump = true;
 188                 continue;
 189             }
 190             if (!strcmp(argv[0]+1, "memchk")) {
 191                 opts_memchk = true;
 192                 continue;
 193             }
 194
 195             switch (argv[0][1]) {
 196                 /* -h, show usage but exit with 0 */
 197                 case 'h':
 198                     usage();
 199                     exit(0);
 200                     break;
 201
 202                 /* handle all -fflags */
 203                 case 'f':
 204                     util_strtocmd(argv[0]+2, argv[0]+2, strlen(argv[0]+2)+1);
 205                     if (!strcmp(argv[0]+2, "HELP")) {
 206                         printf("Possible flags:\n");
 207                         for (itr = 0; itr < COUNT_FLAGS; ++itr) {
 208                             util_strtononcmd(opts_flag_list[itr].name, buffer, sizeof(buffer));
 209                             printf(" -f%s\n", buffer);
 210                         }
 211                         exit(0);
 212                     }
 213                     else if (!strncmp(argv[0]+2, "NO_", 3)) {
 214                         if (!options_setflag(argv[0]+5, false)) {
 215                             printf("unknown flag: %s\n", argv[0]+2);
 216                             return false;
 217                         }
 218                     }
 219                     else if (!options_setflag(argv[0]+2, true)) {
 220                         printf("unknown flag: %s\n", argv[0]+2);
 221                         return false;
 222                     }
 223                     break;
 224                 case 'W':
 225                     util_strtocmd(argv[0]+2, argv[0]+2, strlen(argv[0]+2)+1);
 226                     if (!strcmp(argv[0]+2, "HELP")) {
 227                         printf("Possible warnings:\n");
 228                         for (itr = 0; itr < COUNT_WARNINGS; ++itr) {
 229                             util_strtononcmd(opts_warn_list[itr].name, buffer, sizeof(buffer));
 230                             printf(" -W%s\n", buffer);
 231                         }
 232                         exit(0);
 233                     }
 234                     else if (!strcmp(argv[0]+2, "NO_ERROR")) {
 235                         opts_werror = false;
 236                         break;
 237                     }
 238                     else if (!strcmp(argv[0]+2, "ERROR")) {
 239                         opts_werror = true;
 240                         break;
 241                     }
 242                     else if (!strcmp(argv[0]+2, "ALL")) {
 243                         for (itr = 0; itr < sizeof(opts_warn)/sizeof(opts_warn[0]); ++itr)
 244                             opts_warn[itr] = 0xFFFFFFFFL;
 245                         break;
 246                     }
 247                     if (!strncmp(argv[0]+2, "NO_", 3)) {
 248                         if (!options_setwarn(argv[0]+5, false)) {
 249                             printf("unknown warning: %s\n", argv[0]+2);
 250                             return false;
 251                         }
 252                     }
 253                     else if (!options_setwarn(argv[0]+2, true)) {
 254                         printf("unknown warning: %s\n", argv[0]+2);
 255                         return false;
 256                     }
 257                     break;
 258
 259                 case 'O':
 260                     if (!options_witharg(&argc, &argv, &argarg)) {
 261                         printf("option -O requires a numerical argument\n");
 262                         return false;
 263                     }
 264                     opts_O = atoi(argarg);
 265                     break;
 266
 267                 case 'o':
 268                     if (!options_witharg(&argc, &argv, &argarg)) {
 269                         printf("option -o requires an argument: the output file name\n");
 270                         return false;
 271                     }
 272                     opts_output = argarg;
 273                     opts_output_wasset = true;
 274                     break;
 275
 276                 case 'a':
 277                 case 's':
 278                     item.type = argv[0][1] == 'a' ? TYPE_ASM : TYPE_SRC;
 279                     if (!options_witharg(&argc, &argv, &argarg)) {
 280                         printf("option -a requires a filename %s\n",
 281                                 (argv[0][1] == 'a' ? "containing QC-asm" : "containing a progs.src formatted list"));
 282                         return false;
 283                     }
 284                     item.filename = argarg;
 285                     items_add(item);
 286                     break;
 287
 288                 case '-':
 289                     if (!argv[0][2]) {
 290                         /* anything following -- is considered a non-option argument */
 291                         argend = true;
 292                         break;
 293                     }
 294             /* All long options without arguments */
 295                     else if (!strcmp(argv[0]+2, "help")) {
 296                         usage();
 297                         exit(0);
 298                     }
 299                     else {
 300             /* All long options with arguments */
 301                         if (options_long_witharg("output", &argc, &argv, &argarg)) {
 302                             opts_output = argarg;
 303                             opts_output_wasset = true;
 304                         } else {
 305                             printf("Unknown parameter: %s\n", argv[0]);
 306                             return false;
 307                         }
 308                     }
 309                     break;
 310
 311                 default:
 312                     printf("Unknown parameter: %s\n", argv[0]);
 313                     return false;
 314             }
 315         }
 316         else
 317         {
 318             /* it's a QC filename */
 319             argitem item;
 320             item.filename = argv[0];
 321             item.type     = TYPE_QC;
 322             items_add(item);
 323         }
 324     }
 325     return true;
 326 }
 327
 328 static void options_set(uint32_t *flags, size_t idx, bool on)
 329 {
 330     longbit lb = LONGBIT(idx);
 331 #if 0
 332     if (on)
 333         flags[lb.idx] |= (1<<(lb.bit));
 334     else
 335         flags[lb.idx] &= ~(1<<(lb.bit));
 336 #else
 337     if (on)
 338         flags[0] |= (1<<(lb));
 339     else
 340         flags[0] &= ~(1<<(lb));
 341 #endif
 342 }
 343
 344 /* returns the line number, or -1 on error */
 345 static bool progs_nextline(char **out, FILE *src)
 346 {
 347     size_t alen;
 348     int    len;
 349     char  *line;
 350     char  *start;
 351     char  *end;
 352
 353     line = *out;
 354     len = util_getline(&line, &alen, src);
 355     if (len == -1)
 356         return false;
 357
 358     /* start at first non-blank */
 359     for (start = line; isspace(*start); ++start) {}
 360     /* end at the first non-blank */
 361     for (end = start;  *end && !isspace(*end);  ++end)   {}
 362
 363     *out = line;
 364     /* move the actual filename to the beginning */
 365     while (start != end) {
 366         *line++ = *start++;
 367     }
 368     *line = 0;
 369     return true;
 370 }
 371
 372 int main(int argc, char **argv) {
 373     size_t itr;
 374     int retval = 0;
 375     bool opts_output_free = false;
 376
 377     app_name = argv[0];
 378
 379     /* default options / warn flags */
 380     options_set(opts_warn, WARN_UNKNOWN_CONTROL_SEQUENCE, true);
 381     options_set(opts_warn, WARN_EXTENSIONS, true);
 382     options_set(opts_warn, WARN_FIELD_REDECLARED, true);
 383
 384     if (!options_parse(argc, argv)) {
 385         return usage();
 386     }
 387
 388     if (opts_dump) {
 389         for (itr = 0; itr < COUNT_FLAGS; ++itr) {
 390             printf("Flag %s = %i\n", opts_flag_list[itr].name, OPTS_FLAG(itr));
 391         }
 392         for (itr = 0; itr < COUNT_WARNINGS; ++itr) {
 393             printf("Warning %s = %i\n", opts_warn_list[itr].name, OPTS_WARN(itr));
 394         }
 395         printf("output = %s\n", opts_output);
 396         printf("optimization level = %i\n", (int)opts_O);
 397         printf("standard = %i\n", opts_standard);
 398     }
 399
 400     if (!parser_init()) {
 401         printf("failed to initialize parser\n");
 402         retval = 1;
 403         goto cleanup;
 404     }
 405
 406     util_debug("COM", "starting ...\n");
 407
 408     if (items_elements) {
 409         printf("Mode: manual\n");
 410         printf("There are %lu items to compile:\n", (unsigned long)items_elements);
 411         for (itr = 0; itr < items_elements; ++itr) {
 412             printf("  item: %s (%s)\n",
 413                    items_data[itr].filename,
 414                    ( (items_data[itr].type == TYPE_QC ? "qc" :
 415                      (items_data[itr].type == TYPE_ASM ? "asm" :
 416                      (items_data[itr].type == TYPE_SRC ? "progs.src" :
 417                      ("unknown"))))));
 418
 419             if (!parser_compile(items_data[itr].filename)) {
 420                 retval = 1;
 421                 goto cleanup;
 422             }
 423         }
 424
 425         parser_finish(opts_output);
 426     } else {
 427         FILE *src;
 428         char *line;
 429
 430         printf("Mode: progs.src\n");
 431         src = util_fopen("progs.src", "rb");
 432         if (!src) {
 433             printf("failed to open `progs.src` for reading\n");
 434             retval = 1;
 435             goto cleanup;
 436         }
 437
 438         line = NULL;
 439         if (!progs_nextline(&line, src) || !line[0]) {
 440             printf("illformatted progs.src file: expected output filename in first line\n");
 441             retval = 1;
 442             goto srcdone;
 443         }
 444
 445         if (!opts_output_wasset) {
 446             opts_output = util_strdup(line);
 447             opts_output_free = true;
 448         }
 449
 450         while (progs_nextline(&line, src)) {
 451             if (!line[0] || (line[0] == '/' && line[1] == '/'))
 452                 continue;
 453             printf("  src: %s\n", line);
 454             if (!parser_compile(line)) {
 455                 retval = 1;
 456                 goto srcdone;
 457             }
 458         }
 459
 460         parser_finish(opts_output);
 461
 462 srcdone:
 463         fclose(src);
 464         mem_d(line);
 465     }
 466
 467     /* stuff */
 468
 469 cleanup:
 470     util_debug("COM", "cleaning ...\n");
 471
 472     parser_cleanup();
 473     if (opts_output_free)
 474         mem_d((char*)opts_output);
 475
 476     util_meminfo();
 477     return retval;
 478 }