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