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