src/getargs.c

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