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