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