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