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