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