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