src/getargs.c

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