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