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