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