src/getargs.c

   1 /* Parse command line arguments for Bison.
   2
   3    Copyright (C) 1984, 1986, 1989, 1992, 2000-2011 Free Software
   4    Foundation, Inc.
   5
   6    This file is part of Bison, the GNU Compiler Compiler.
   7
   8    This program is free software: you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation, either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #include <config.h>
  22 #include "system.h"
  23 #include "output.h"
  24
  25 #include <argmatch.h>
  26 #include <c-strcase.h>
  27 #include <configmake.h>
  28 #include <error.h>
  29 #include <quotearg.h>
  30
  31 /* Hack to get <getopt.h> to declare getopt with a prototype.  */
  32 #if lint && ! defined __GNU_LIBRARY__
  33 # define __GNU_LIBRARY__
  34 # define HACK_FOR___GNU_LIBRARY___PROTOTYPE 1
  35 #endif
  36
  37 #include <getopt.h>
  38
  39 #ifdef HACK_FOR___GNU_LIBRARY___PROTOTYPE
  40 # undef __GNU_LIBRARY__
  41 # undef HACK_FOR___GNU_LIBRARY___PROTOTYPE
  42 #endif
  43
  44 #include "complain.h"
  45 #include "files.h"
  46 #include "getargs.h"
  47 #include "muscle-tab.h"
  48 #include "uniqstr.h"
  49
  50 bool debug_flag;
  51 bool defines_flag;
  52 bool graph_flag;
  53 bool xml_flag;
  54 bool locations_flag;
  55 bool no_lines_flag;
  56 bool token_table_flag;
  57 bool yacc_flag; /* for -y */
  58
  59 bool error_verbose = false;
  60
  61 bool nondeterministic_parser = false;
  62 bool glr_parser = false;
  63
  64 int report_flag = report_none;
  65 int trace_flag = trace_none;
  66 int warnings_flag = warnings_none;
  67
  68 static struct bison_language const valid_languages[] = {
  69   { "c", "c-skel.m4", ".c", ".h", true },
  70   { "c++", "c++-skel.m4", ".cc", ".hh", true },
  71   { "java", "java-skel.m4", ".java", ".java", false },
  72   { "", "", "", "", false }
  73 };
  74
  75 int skeleton_prio = default_prio;
  76 const char *skeleton = NULL;
  77 int language_prio = default_prio;
  78 struct bison_language const *language = &valid_languages[0];
  79 const char *include = NULL;
  80
  81 char *program_name;
  82
  83
  84 /** Decode an option's set of keys.
  85  *
  86  *  \param option   option being decoded.
  87  *  \param keys     array of valid subarguments.
  88  *  \param values   array of corresponding (int) values.
  89  *  \param all      the all value.
  90  *  \param flags    the flags to update
  91  *  \param args     comma separated list of effective subarguments to decode.
  92  *                  If 0, then activate all the flags.
  93  *
  94  *  If VALUE != 0 then KEY sets flags and no-KEY clears them.
  95  *  If VALUE == 0 then KEY clears all flags from \c all and no-KEY sets all
  96  *  flags from \c all.  Thus no-none = all and no-all = none.
  97  */
  98 static void
  99 flags_argmatch (const char *option,
 100                 const char * const keys[], const int values[],
 101                 int all, int *flags, char *args)
 102 {
 103   if (args)
 104     {
 105       args = strtok (args, ",");
 106       while (args)
 107         {
 108           int no = strncmp (args, "no-", 3) == 0 ? 3 : 0;
 109           int value = XARGMATCH (option, args + no, keys, values);
 110           if (value == 0)
 111             {
 112               if (no)
 113                 *flags |= all;
 114               else
 115                 *flags &= ~all;
 116             }
 117           else
 118             {
 119               if (no)
 120                 *flags &= ~value;
 121               else
 122                 *flags |= value;
 123             }
 124           args = strtok (NULL, ",");
 125         }
 126     }
 127   else
 128     *flags |= all;
 129 }
 130
 131 /** Decode a set of sub arguments.
 132  *
 133  *  \param FlagName  the flag familly to update.
 134  *  \param Args      the effective sub arguments to decode.
 135  *
 136  *  \arg FlagName_args   the list of keys.
 137  *  \arg FlagName_types  the list of values.
 138  *  \arg FlagName_all    the all value.
 139  *  \arg FlagName_flag   the flag to update.
 140  */
 141 #define FLAGS_ARGMATCH(FlagName, Args)                                  \
 142   flags_argmatch ("--" #FlagName, FlagName ## _args, FlagName ## _types, \
 143                   FlagName ## _all, &FlagName ## _flag, Args)
 144
 145
 146 /*----------------------.
 147 | --report's handling.  |
 148 `----------------------*/
 149
 150 static const char * const report_args[] =
 151 {
 152   /* In a series of synonyms, present the most meaningful first, so
 153      that argmatch_valid be more readable.  */
 154   "none",
 155   "state", "states",
 156   "itemset", "itemsets",
 157   "lookahead", "lookaheads", "look-ahead",
 158   "solved",
 159   "all",
 160   0
 161 };
 162
 163 static const int report_types[] =
 164 {
 165   report_none,
 166   report_states, report_states,
 167   report_states | report_itemsets, report_states | report_itemsets,
 168   report_states | report_lookahead_tokens,
 169   report_states | report_lookahead_tokens,
 170   report_states | report_lookahead_tokens,
 171   report_states | report_solved_conflicts,
 172   report_all
 173 };
 174
 175 ARGMATCH_VERIFY (report_args, report_types);
 176
 177
 178 /*---------------------.
 179 | --trace's handling.  |
 180 `---------------------*/
 181
 182 static const char * const trace_args[] =
 183 {
 184   /* In a series of synonyms, present the most meaningful first, so
 185      that argmatch_valid be more readable.  */
 186   "none       - no traces",
 187   "scan       - grammar scanner traces",
 188   "parse      - grammar parser traces",
 189   "automaton  - construction of the automaton",
 190   "bitsets    - use of bitsets",
 191   "grammar    - reading, reducing the grammar",
 192   "resource   - memory consumption (where available)",
 193   "sets       - grammar sets: firsts, nullable etc.",
 194   "muscles    - m4 definitions passed to the skeleton",
 195   "tools      - m4 invocation",
 196   "m4         - m4 traces",
 197   "skeleton   - skeleton postprocessing",
 198   "time       - time consumption",
 199   "ielr       - IELR conversion",
 200   "all        - all of the above",
 201   0
 202 };
 203
 204 static const int trace_types[] =
 205 {
 206   trace_none,
 207   trace_scan,
 208   trace_parse,
 209   trace_automaton,
 210   trace_bitsets,
 211   trace_grammar,
 212   trace_resource,
 213   trace_sets,
 214   trace_muscles,
 215   trace_tools,
 216   trace_m4,
 217   trace_skeleton,
 218   trace_time,
 219   trace_ielr,
 220   trace_all
 221 };
 222
 223 ARGMATCH_VERIFY (trace_args, trace_types);
 224
 225
 226 /*------------------------.
 227 | --warnings's handling.  |
 228 `------------------------*/
 229
 230 static const char * const warnings_args[] =
 231 {
 232   /* In a series of synonyms, present the most meaningful first, so
 233      that argmatch_valid be more readable.  */
 234   "none            - no warnings",
 235   "midrule-values  - unset or unused midrule values",
 236   "yacc            - incompatibilities with POSIX Yacc",
 237   "all             - all of the above",
 238   "error           - warnings are errors",
 239   0
 240 };
 241
 242 static const int warnings_types[] =
 243 {
 244   warnings_none,
 245   warnings_midrule_values,
 246   warnings_yacc,
 247   warnings_all,
 248   warnings_error
 249 };
 250
 251 ARGMATCH_VERIFY (warnings_args, warnings_types);
 252
 253
 254 /*-------------------------------------------.
 255 | Display the help message and exit STATUS.  |
 256 `-------------------------------------------*/
 257
 258 static void usage (int) ATTRIBUTE_NORETURN;
 259
 260 static void
 261 usage (int status)
 262 {
 263   if (status != 0)
 264     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 265              program_name);
 266   else
 267     {
 268       /* For ../build-aux/cross-options.pl to work, use the format:
 269                 ^  -S, --long[=ARGS] (whitespace)
 270          A --long option is required.
 271          Otherwise, add exceptions to ../build-aux/cross-options.pl.  */
 272
 273       printf (_("Usage: %s [OPTION]... FILE\n"), program_name);
 274       fputs (_("\
 275 Generate a deterministic LR or generalized LR (GLR) parser employing\n\
 276 LALR(1), IELR(1), or canonical LR(1) parser tables.  IELR(1) and\n\
 277 canonical LR(1) support is experimental.\n\
 278 \n\
 279 "), stdout);
 280
 281       fputs (_("\
 282 Mandatory arguments to long options are mandatory for short options too.\n\
 283 "), stdout);
 284       fputs (_("\
 285 The same is true for optional arguments.\n\
 286 "), stdout);
 287
 288       fputs (_("\
 289 \n\
 290 Operation modes:\n\
 291   -h, --help                 display this help and exit\n\
 292   -V, --version              output version information and exit\n\
 293       --print-localedir      output directory containing locale-dependent data\n\
 294       --print-datadir        output directory containing skeletons and XSLT\n\
 295   -y, --yacc                 emulate POSIX Yacc\n\
 296   -W, --warnings[=CATEGORY]  report the warnings falling in CATEGORY\n\
 297 \n\
 298 "), stdout);
 299
 300       fputs (_("\
 301 Parser:\n\
 302   -L, --language=LANGUAGE          specify the output programming language\n\
 303                                    (this is an experimental feature)\n\
 304   -S, --skeleton=FILE              specify the skeleton to use\n\
 305   -t, --debug                      instrument the parser for debugging\n\
 306       --locations                  enable location support\n\
 307   -D, --define=NAME[=VALUE]        similar to `%define NAME \"VALUE\"'\n\
 308   -F, --force-define=NAME[=VALUE]  override `%define NAME \"VALUE\"'\n\
 309   -p, --name-prefix=PREFIX         prepend PREFIX to the external symbols\n\
 310   -l, --no-lines                   don't generate `#line' directives\n\
 311   -k, --token-table                include a table of token names\n\
 312 \n\
 313 "), stdout);
 314
 315       /* Keep -d and --defines separate so that ../build-aux/cross-options.pl
 316        * won't assume that -d also takes an argument.  */
 317       fputs (_("\
 318 Output:\n\
 319       --defines[=FILE]       also produce a header file\n\
 320   -d                         likewise but cannot specify FILE (for POSIX Yacc)\n\
 321   -r, --report=THINGS        also produce details on the automaton\n\
 322       --report-file=FILE     write report to FILE\n\
 323   -v, --verbose              same as `--report=state'\n\
 324   -b, --file-prefix=PREFIX   specify a PREFIX for output files\n\
 325   -o, --output=FILE          leave output to FILE\n\
 326   -g, --graph[=FILE]         also output a graph of the automaton\n\
 327   -x, --xml[=FILE]           also output an XML report of the automaton\n\
 328                              (the XML schema is experimental)\n\
 329 \n\
 330 "), stdout);
 331
 332       fputs (_("\
 333 Warning categories include:\n\
 334   `midrule-values'  unset or unused midrule values\n\
 335   `yacc'            incompatibilities with POSIX Yacc\n\
 336   `all'             all the warnings\n\
 337   `no-CATEGORY'     turn off warnings in CATEGORY\n\
 338   `none'            turn off all the warnings\n\
 339   `error'           treat warnings as errors\n\
 340 \n\
 341 "), stdout);
 342
 343       fputs (_("\
 344 THINGS is a list of comma separated words that can include:\n\
 345   `state'        describe the states\n\
 346   `itemset'      complete the core item sets with their closure\n\
 347   `lookahead'    explicitly associate lookahead tokens to items\n\
 348   `solved'       describe shift/reduce conflicts solving\n\
 349   `all'          include all the above information\n\
 350   `none'         disable the report\n\
 351 "), stdout);
 352
 353       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 354     }
 355
 356   exit (status);
 357 }
 358
 359
 360 /*------------------------------.
 361 | Display the version message.  |
 362 `------------------------------*/
 363
 364 static void
 365 version (void)
 366 {
 367   /* Some efforts were made to ease the translators' task, please
 368      continue.  */
 369   printf (_("bison (GNU Bison) %s"), VERSION);
 370   putc ('\n', stdout);
 371   fputs (_("Written by Robert Corbett and Richard Stallman.\n"), stdout);
 372   putc ('\n', stdout);
 373
 374   fprintf (stdout,
 375            _("Copyright (C) %d Free Software Foundation, Inc.\n"),
 376            PACKAGE_COPYRIGHT_YEAR);
 377
 378   fputs (_("\
 379 This is free software; see the source for copying conditions.  There is NO\n\
 380 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
 381 "),
 382          stdout);
 383 }
 384
 385
 386 /*-------------------------------------.
 387 | --skeleton and --language handling.  |
 388 `--------------------------------------*/
 389
 390 void
 391 skeleton_arg (char const *arg, int prio, location loc)
 392 {
 393   if (prio < skeleton_prio)
 394     {
 395       skeleton_prio = prio;
 396       skeleton = arg;
 397     }
 398   else if (prio == skeleton_prio)
 399     complain_at (loc, _("multiple skeleton declarations are invalid"));
 400 }
 401
 402 void
 403 language_argmatch (char const *arg, int prio, location loc)
 404 {
 405   char const *msg;
 406
 407   if (prio < language_prio)
 408     {
 409       int i;
 410       for (i = 0; valid_languages[i].language[0]; i++)
 411         if (c_strcasecmp (arg, valid_languages[i].language) == 0)
 412           {
 413             language_prio = prio;
 414             language = &valid_languages[i];
 415             return;
 416           }
 417       msg = _("invalid language `%s'");
 418     }
 419   else if (language_prio == prio)
 420     msg = _("multiple language declarations are invalid");
 421   else
 422     return;
 423
 424   complain_at (loc, msg, arg);
 425 }
 426
 427 /*----------------------.
 428 | Process the options.  |
 429 `----------------------*/
 430
 431 /* Shorts options.
 432    Should be computed from long_options.  */
 433 static char const short_options[] =
 434   "D:"
 435   "F:"
 436   "L:"
 437   "S:"
 438   "T::"
 439   "V"
 440   "W::"
 441   "b:"
 442   "d"
 443   "e"
 444   "g::"
 445   "h"
 446   "k"
 447   "l"
 448   "n"
 449   "o:"
 450   "p:"
 451   "r:"
 452   "t"
 453   "v"
 454   "x::"
 455   "y"
 456   ;
 457
 458 /* Values for long options that do not have single-letter equivalents.  */
 459 enum
 460 {
 461   LOCATIONS_OPTION = CHAR_MAX + 1,
 462   PRINT_LOCALEDIR_OPTION,
 463   PRINT_DATADIR_OPTION,
 464   REPORT_FILE_OPTION
 465 };
 466
 467 static struct option const long_options[] =
 468 {
 469   /* Operation modes. */
 470   { "help",            no_argument,       0,   'h' },
 471   { "version",         no_argument,       0,   'V' },
 472   { "print-localedir", no_argument,       0,   PRINT_LOCALEDIR_OPTION },
 473   { "print-datadir",   no_argument,       0,   PRINT_DATADIR_OPTION   },
 474   { "warnings",        optional_argument, 0,   'W' },
 475
 476   /* Parser. */
 477   { "name-prefix",   required_argument,   0,   'p' },
 478   { "include",       required_argument,   0,   'I' },
 479
 480   /* Output. */
 481   { "file-prefix", required_argument,   0,   'b' },
 482   { "output",      required_argument,   0,   'o' },
 483   { "output-file", required_argument,   0,   'o' },
 484   { "graph",       optional_argument,   0,   'g' },
 485   { "xml",         optional_argument,   0,   'x' },
 486   { "report",      required_argument,   0,   'r' },
 487   { "report-file", required_argument,   0,   REPORT_FILE_OPTION },
 488   { "verbose",     no_argument,         0,   'v' },
 489
 490   /* Hidden. */
 491   { "trace",         optional_argument,   0,     'T' },
 492
 493   /* Output.  */
 494   { "defines",     optional_argument,   0,   'd' },
 495
 496   /* Operation modes.  */
 497   { "fixed-output-files", no_argument,  0,   'y' },
 498   { "yacc",               no_argument,  0,   'y' },
 499
 500   /* Parser.  */
 501   { "debug",          no_argument,               0,   't' },
 502   { "define",         required_argument,         0,   'D' },
 503   { "force-define",   required_argument,         0,   'F' },
 504   { "locations",      no_argument,               0, LOCATIONS_OPTION },
 505   { "no-lines",       no_argument,               0,   'l' },
 506   { "raw",            no_argument,               0,     0 },
 507   { "skeleton",       required_argument,         0,   'S' },
 508   { "language",       required_argument,         0,   'L' },
 509   { "token-table",    no_argument,               0,   'k' },
 510
 511   {0, 0, 0, 0}
 512 };
 513
 514 /* Under DOS, there is no difference on the case.  This can be
 515    troublesome when looking for `.tab' etc.  */
 516 #ifdef MSDOS
 517 # define AS_FILE_NAME(File) (strlwr (File), (File))
 518 #else
 519 # define AS_FILE_NAME(File) (File)
 520 #endif
 521
 522 /* Build a location for the current command line argument. */
 523 static
 524 location
 525 command_line_location (void)
 526 {
 527   location res;
 528   /* "<command line>" is used in GCC's messages about -D. */
 529   boundary_set (&res.start, uniqstr_new ("<command line>"), optind, -1);
 530   res.end = res.start;
 531   return res;
 532 }
 533
 534
 535 void
 536 getargs (int argc, char *argv[])
 537 {
 538   int c;
 539
 540   while ((c = getopt_long (argc, argv, short_options, long_options, NULL))
 541          != -1)
 542     switch (c)
 543       {
 544         /* ASCII Sorting for short options (i.e., upper case then
 545            lower case), and then long-only options.  */
 546
 547       case 0:
 548         /* Certain long options cause getopt_long to return 0.  */
 549         break;
 550
 551       case 'D': /* -DNAME[=VALUE]. */
 552       case 'F': /* -FNAME[=VALUE]. */
 553         {
 554           char* name = optarg;
 555           char* value = strchr (optarg, '=');
 556           if (value)
 557             *value++ = 0;
 558           muscle_percent_define_insert (name, command_line_location (),
 559                                         value ? value : "",
 560                                         c == 'D' ? MUSCLE_PERCENT_DEFINE_D
 561                                                  : MUSCLE_PERCENT_DEFINE_F);
 562         }
 563         break;
 564
 565       case 'I':
 566         include = AS_FILE_NAME (optarg);
 567         break;
 568
 569       case 'L':
 570         language_argmatch (optarg, command_line_prio,
 571                            command_line_location ());
 572         break;
 573
 574       case 'S':
 575         skeleton_arg (AS_FILE_NAME (optarg), command_line_prio,
 576                       command_line_location ());
 577         break;
 578
 579       case 'T':
 580         FLAGS_ARGMATCH (trace, optarg);
 581         break;
 582
 583       case 'V':
 584         version ();
 585         exit (EXIT_SUCCESS);
 586
 587       case 'W':
 588         FLAGS_ARGMATCH (warnings, optarg);
 589         break;
 590
 591       case 'b':
 592         spec_file_prefix = AS_FILE_NAME (optarg);
 593         break;
 594
 595       case 'd':
 596         /* Here, the -d and --defines options are differentiated.  */
 597         defines_flag = true;
 598         if (optarg)
 599           spec_defines_file = xstrdup (AS_FILE_NAME (optarg));
 600         break;
 601
 602       case 'g':
 603         graph_flag = true;
 604         if (optarg)
 605           spec_graph_file = xstrdup (AS_FILE_NAME (optarg));
 606         break;
 607
 608       case 'h':
 609         usage (EXIT_SUCCESS);
 610
 611       case 'k':
 612         token_table_flag = true;
 613         break;
 614
 615       case 'l':
 616         no_lines_flag = true;
 617         break;
 618
 619       case 'o':
 620         spec_outfile = AS_FILE_NAME (optarg);
 621         break;
 622
 623       case 'p':
 624         spec_name_prefix = optarg;
 625         break;
 626
 627       case 'r':
 628         FLAGS_ARGMATCH (report, optarg);
 629         break;
 630
 631       case 't':
 632         debug_flag = true;
 633         break;
 634
 635       case 'v':
 636         report_flag |= report_states;
 637         break;
 638
 639       case 'x':
 640         xml_flag = true;
 641         if (optarg)
 642           spec_xml_file = xstrdup (AS_FILE_NAME (optarg));
 643         break;
 644
 645       case 'y':
 646         yacc_flag = true;
 647         break;
 648
 649       case LOCATIONS_OPTION:
 650         locations_flag = true;
 651         break;
 652
 653       case PRINT_LOCALEDIR_OPTION:
 654         printf ("%s\n", LOCALEDIR);
 655         exit (EXIT_SUCCESS);
 656
 657       case PRINT_DATADIR_OPTION:
 658         printf ("%s\n", compute_pkgdatadir ());
 659         exit (EXIT_SUCCESS);
 660
 661       case REPORT_FILE_OPTION:
 662         spec_verbose_file = xstrdup (AS_FILE_NAME (optarg));
 663         break;
 664
 665       default:
 666         usage (EXIT_FAILURE);
 667       }
 668
 669   if (argc - optind != 1)
 670     {
 671       if (argc - optind < 1)
 672         error (0, 0, _("missing operand after `%s'"), argv[argc - 1]);
 673       else
 674         error (0, 0, _("extra operand `%s'"), argv[optind + 1]);
 675       usage (EXIT_FAILURE);
 676     }
 677
 678   current_file = grammar_file = uniqstr_new (argv[optind]);
 679   MUSCLE_INSERT_C_STRING ("file_name", grammar_file);
 680 }
 681
 682 void
 683 tr (char *s, char from, char to)
 684 {
 685   for (; *s; s++)
 686     if (*s == from)
 687       *s = to;
 688 }