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