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