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
 231             switch (argv[0][1]) {
 232                 /* -h, show usage but exit with 0 */
 233                 case 'h':
 234                     usage();
 235                     exit(0);
 236                     break;
 237
 238                 case 'E':
 239                     opts_pp_only = true;
 240                     break;
 241
 242                 /* handle all -fflags */
 243                 case 'f':
 244                     util_strtocmd(argv[0]+2, argv[0]+2, strlen(argv[0]+2)+1);
 245                     if (!strcmp(argv[0]+2, "HELP")) {
 246                         con_out("Possible flags:\n");
 247                         for (itr = 0; itr < COUNT_FLAGS; ++itr) {
 248                             util_strtononcmd(opts_flag_list[itr].name, buffer, sizeof(buffer));
 249                             con_out(" -f%s\n", buffer);
 250                         }
 251                         exit(0);
 252                     }
 253                     else if (!strncmp(argv[0]+2, "NO_", 3)) {
 254                         if (!options_setflag(argv[0]+5, false)) {
 255                             con_out("unknown flag: %s\n", argv[0]+2);
 256                             return false;
 257                         }
 258                     }
 259                     else if (!options_setflag(argv[0]+2, true)) {
 260                         con_out("unknown flag: %s\n", argv[0]+2);
 261                         return false;
 262                     }
 263                     break;
 264                 case 'W':
 265                     util_strtocmd(argv[0]+2, argv[0]+2, strlen(argv[0]+2)+1);
 266                     if (!strcmp(argv[0]+2, "HELP")) {
 267                         con_out("Possible warnings:\n");
 268                         for (itr = 0; itr < COUNT_WARNINGS; ++itr) {
 269                             util_strtononcmd(opts_warn_list[itr].name, buffer, sizeof(buffer));
 270                             con_out(" -W%s\n", buffer);
 271                         }
 272                         exit(0);
 273                     }
 274                     else if (!strcmp(argv[0]+2, "NO_ERROR")) {
 275                         opts_werror = false;
 276                         break;
 277                     }
 278                     else if (!strcmp(argv[0]+2, "ERROR")) {
 279                         opts_werror = true;
 280                         break;
 281                     }
 282                     else if (!strcmp(argv[0]+2, "NONE")) {
 283                         for (itr = 0; itr < sizeof(opts_warn)/sizeof(opts_warn[0]); ++itr)
 284                             opts_warn[itr] = 0;
 285                         break;
 286                     }
 287                     else if (!strcmp(argv[0]+2, "ALL")) {
 288                         for (itr = 0; itr < sizeof(opts_warn)/sizeof(opts_warn[0]); ++itr)
 289                             opts_warn[itr] = 0xFFFFFFFFL;
 290                         break;
 291                     }
 292                     if (!strncmp(argv[0]+2, "NO_", 3)) {
 293                         if (!options_setwarn(argv[0]+5, false)) {
 294                             con_out("unknown warning: %s\n", argv[0]+2);
 295                             return false;
 296                         }
 297                     }
 298                     else if (!options_setwarn(argv[0]+2, true)) {
 299                         con_out("unknown warning: %s\n", argv[0]+2);
 300                         return false;
 301                     }
 302                     break;
 303
 304                 case 'O':
 305                     if (!options_witharg(&argc, &argv, &argarg)) {
 306                         con_out("option -O requires a numerical argument\n");
 307                         return false;
 308                     }
 309                     opts_O = atoi(argarg);
 310                     break;
 311
 312                 case 'o':
 313                     if (!options_witharg(&argc, &argv, &argarg)) {
 314                         con_out("option -o requires an argument: the output file name\n");
 315                         return false;
 316                     }
 317                     opts_output = argarg;
 318                     opts_output_wasset = true;
 319                     break;
 320
 321                 case 'a':
 322                 case 's':
 323                     item.type = argv[0][1] == 'a' ? TYPE_ASM : TYPE_SRC;
 324                     if (!options_witharg(&argc, &argv, &argarg)) {
 325                         con_out("option -a requires a filename %s\n",
 326                                 (argv[0][1] == 'a' ? "containing QC-asm" : "containing a progs.src formatted list"));
 327                         return false;
 328                     }
 329                     item.filename = argarg;
 330                     items_add(item);
 331                     break;
 332
 333                 case '-':
 334                     if (!argv[0][2]) {
 335                         /* anything following -- is considered a non-option argument */
 336                         argend = true;
 337                         break;
 338                     }
 339             /* All long options without arguments */
 340                     else if (!strcmp(argv[0]+2, "help")) {
 341                         usage();
 342                         exit(0);
 343                     }
 344                     else {
 345             /* All long options with arguments */
 346                         if (options_long_witharg("output", &argc, &argv, &argarg)) {
 347                             opts_output = argarg;
 348                             opts_output_wasset = true;
 349                         } else {
 350                             con_out("Unknown parameter: %s\n", argv[0]);
 351                             return false;
 352                         }
 353                     }
 354                     break;
 355
 356                 default:
 357                     con_out("Unknown parameter: %s\n", argv[0]);
 358                     return false;
 359             }
 360         }
 361         else
 362         {
 363             /* it's a QC filename */
 364             argitem item;
 365             item.filename = argv[0];
 366             item.type     = TYPE_QC;
 367             items_add(item);
 368         }
 369     }
 370     return true;
 371 }
 372
 373 /* returns the line number, or -1 on error */
 374 static bool progs_nextline(char **out, size_t *alen,FILE *src)
 375 {
 376     int    len;
 377     char  *line;
 378     char  *start;
 379     char  *end;
 380
 381     line = *out;
 382     len = util_getline(&line, alen, src);
 383     if (len == -1)
 384         return false;
 385
 386     /* start at first non-blank */
 387     for (start = line; isspace(*start); ++start) {}
 388     /* end at the first non-blank */
 389     for (end = start;  *end && !isspace(*end);  ++end)   {}
 390
 391     *out = line;
 392     /* move the actual filename to the beginning */
 393     while (start != end) {
 394         *line++ = *start++;
 395     }
 396     *line = 0;
 397     return true;
 398 }
 399
 400 int main(int argc, char **argv) {
 401     size_t itr;
 402     int retval = 0;
 403     bool opts_output_free = false;
 404
 405     app_name = argv[0];
 406     con_init();
 407
 408     /* default options / warn flags */
 409     options_set(opts_warn, WARN_UNKNOWN_CONTROL_SEQUENCE, true);
 410     options_set(opts_warn, WARN_EXTENSIONS, true);
 411     options_set(opts_warn, WARN_FIELD_REDECLARED, true);
 412     options_set(opts_warn, WARN_TOO_FEW_PARAMETERS, true);
 413     options_set(opts_warn, WARN_MISSING_RETURN_VALUES, true);
 414     options_set(opts_warn, WARN_USED_UNINITIALIZED, true);
 415     options_set(opts_warn, WARN_LOCAL_CONSTANTS, true);
 416     options_set(opts_warn, WARN_VOID_VARIABLES, true);
 417     options_set(opts_warn, WARN_IMPLICIT_FUNCTION_POINTER, true);
 418     options_set(opts_warn, WARN_VARIADIC_FUNCTION, true);
 419     options_set(opts_warn, WARN_FRAME_MACROS, true);
 420     options_set(opts_warn, WARN_UNUSED_VARIABLE, true);
 421     options_set(opts_warn, WARN_EFFECTLESS_STATEMENT, true);
 422     options_set(opts_warn, WARN_END_SYS_FIELDS, true);
 423     options_set(opts_warn, WARN_ASSIGN_FUNCTION_TYPES, true);
 424
 425     options_set(opts_flags, ADJUST_VECTOR_FIELDS, true);
 426
 427     if (!options_parse(argc, argv)) {
 428         return usage();
 429     }
 430
 431     /* the standard decides which set of operators to use */
 432     if (opts_standard == COMPILER_GMQCC) {
 433         operators = c_operators;
 434         operator_count = c_operator_count;
 435     } else {
 436         operators = qcc_operators;
 437         operator_count = qcc_operator_count;
 438     }
 439
 440     if (opts_dump) {
 441         for (itr = 0; itr < COUNT_FLAGS; ++itr) {
 442             con_out("Flag %s = %i\n", opts_flag_list[itr].name, OPTS_FLAG(itr));
 443         }
 444         for (itr = 0; itr < COUNT_WARNINGS; ++itr) {
 445             con_out("Warning %s = %i\n", opts_warn_list[itr].name, OPTS_WARN(itr));
 446         }
 447         con_out("output = %s\n", opts_output);
 448         con_out("optimization level = %i\n", (int)opts_O);
 449         con_out("standard = %i\n", opts_standard);
 450     }
 451
 452     if (!parser_init()) {
 453         con_out("failed to initialize parser\n");
 454         retval = 1;
 455         goto cleanup;
 456     }
 457
 458     util_debug("COM", "starting ...\n");
 459
 460     if (items_elements) {
 461         con_out("Mode: manual\n");
 462         con_out("There are %lu items to compile:\n", (unsigned long)items_elements);
 463         for (itr = 0; itr < items_elements; ++itr) {
 464             con_out("  item: %s (%s)\n",
 465                    items_data[itr].filename,
 466                    ( (items_data[itr].type == TYPE_QC ? "qc" :
 467                      (items_data[itr].type == TYPE_ASM ? "asm" :
 468                      (items_data[itr].type == TYPE_SRC ? "progs.src" :
 469                      ("unknown"))))));
 470
 471         if (!parser_compile_file(items_data[itr].filename))
 472         {
 473                 retval = 1;
 474                 goto cleanup;
 475             }
 476         }
 477
 478         if (!parser_finish(opts_output)) {
 479             retval = 1;
 480             goto cleanup;
 481         }
 482
 483     } else {
 484         FILE *src;
 485         char *line;
 486         size_t linelen = 0;
 487
 488         con_out("Mode: progs.src\n");
 489         src = util_fopen("progs.src", "rb");
 490         if (!src) {
 491             con_out("failed to open `progs.src` for reading\n");
 492             retval = 1;
 493             goto cleanup;
 494         }
 495
 496         line = NULL;
 497         if (!progs_nextline(&line, &linelen, src) || !line[0]) {
 498             con_out("illformatted progs.src file: expected output filename in first line\n");
 499             retval = 1;
 500             goto srcdone;
 501         }
 502
 503         if (!opts_output_wasset) {
 504             opts_output = util_strdup(line);
 505             opts_output_free = true;
 506         }
 507
 508         while (progs_nextline(&line, &linelen, src)) {
 509             if (!line[0] || (line[0] == '/' && line[1] == '/'))
 510                 continue;
 511             con_out("  src: %s\n", line);
 512             if (!parser_compile_file(line)) {
 513                 retval = 1;
 514                 goto srcdone;
 515             }
 516         }
 517
 518         parser_finish(opts_output);
 519
 520 srcdone:
 521         fclose(src);
 522         mem_d(line);
 523     }
 524
 525     /* stuff */
 526
 527 cleanup:
 528     util_debug("COM", "cleaning ...\n");
 529
 530     mem_d(items_data);
 531
 532     parser_cleanup();
 533     if (opts_output_free)
 534         mem_d((char*)opts_output);
 535
 536     lex_cleanup();
 537     util_meminfo();
 538     return retval;
 539 }