src/getargs.c

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