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 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 "revision.h"
  24 #include "output.h"
  25
  26 #include <argmatch.h>
  27 #include <c-strcase.h>
  28 #include <configmake.h>
  29 #include <error.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 "uniqstr.h"
  48
  49 bool debug_flag;
  50 bool defines_flag;
  51 bool graph_flag;
  52 bool xml_flag;
  53 bool locations_flag;
  54 bool no_lines_flag;
  55 bool token_table_flag;
  56 bool yacc_flag; /* for -y */
  57
  58 bool error_verbose = false;
  59
  60 bool nondeterministic_parser = false;
  61 bool glr_parser = false;
  62 bool pure_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 static int skeleton_prio = 2;
  76 const char *skeleton = NULL;
  77 static int language_prio = 2;
  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   "tools      - m4 invocation",
 180   "m4         - m4 traces",
 181   "skeleton   - skeleton postprocessing",
 182   "time       - time consumption",
 183   "all        - all of the above",
 184   0
 185 };
 186
 187 static const int trace_types[] =
 188 {
 189   trace_none,
 190   trace_scan,
 191   trace_parse,
 192   trace_automaton,
 193   trace_bitsets,
 194   trace_grammar,
 195   trace_resource,
 196   trace_sets,
 197   trace_tools,
 198   trace_m4,
 199   trace_skeleton,
 200   trace_time,
 201   trace_all
 202 };
 203
 204 ARGMATCH_VERIFY (trace_args, trace_types);
 205
 206
 207 /*------------------------.
 208 | --warnings's handling.  |
 209 `------------------------*/
 210
 211 static const char * const warnings_args[] =
 212 {
 213   /* In a series of synonyms, present the most meaningful first, so
 214      that argmatch_valid be more readable.  */
 215   "none            - no warnings",
 216   "midrule-values  - unset or unused midrule values",
 217   "yacc            - incompatibilities with POSIX YACC",
 218   "all             - all of the above",
 219   "error           - warnings are errors",
 220   0
 221 };
 222
 223 static const int warnings_types[] =
 224 {
 225   warnings_none,
 226   warnings_midrule_values,
 227   warnings_yacc,
 228   warnings_all,
 229   warnings_error
 230 };
 231
 232 ARGMATCH_VERIFY (warnings_args, warnings_types);
 233
 234
 235 /*-------------------------------------------.
 236 | Display the help message and exit STATUS.  |
 237 `-------------------------------------------*/
 238
 239 static void usage (int) ATTRIBUTE_NORETURN;
 240
 241 static void
 242 usage (int status)
 243 {
 244   if (status != 0)
 245     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 246              program_name);
 247   else
 248     {
 249       printf (_("Usage: %s [OPTION]... FILE\n"), program_name);
 250       fputs (_("\
 251 Generate LALR(1) and GLR parsers.\n\
 252 \n\
 253 "), stdout);
 254
 255       fputs (_("\
 256 Mandatory arguments to long options are mandatory for short options too.\n\
 257 "), stdout);
 258
 259       fputs (_("\
 260 \n\
 261 Operation modes:\n\
 262   -h, --help                 display this help and exit\n\
 263   -V, --version              output version information and exit\n\
 264       --print-localedir      output directory containing locale-dependent data\n\
 265       --print-datadir        output directory containing skeletons and XSLT\n\
 266   -y, --yacc                 emulate POSIX Yacc\n\
 267 \n\
 268 "), stdout);
 269
 270       fputs (_("\
 271 Parser:\n\
 272   -S, --skeleton=FILE        specify the skeleton to use\n\
 273   -t, --debug                instrument the parser for debugging\n\
 274       --locations            enable locations computation\n\
 275   -p, --name-prefix=PREFIX   prepend PREFIX to the external symbols\n\
 276   -l, --no-lines             don't generate `#line' directives\n\
 277   -k, --token-table          include a table of token names\n\
 278 \n\
 279 "), stdout);
 280
 281       fputs (_("\
 282 Output:\n\
 283   -d, --defines              also produce a header file\n\
 284   -r, --report=THINGS        also produce details on the automaton\n\
 285   -v, --verbose              same as `--report=state'\n\
 286   -b, --file-prefix=PREFIX   specify a PREFIX for output files\n\
 287   -o, --output=FILE          leave output to FILE\n\
 288   -g, --graph                also output a graph of the automaton\n\
 289   -x, --xml                  also output an xml of the automaton\n\
 290 \n\
 291 "), stdout);
 292
 293       fputs (_("\
 294 THINGS is a list of comma separated words that can include:\n\
 295   `state'        describe the states\n\
 296   `itemset'      complete the core item sets with their closure\n\
 297   `lookahead'    explicitly associate lookahead tokens to items\n\
 298   `solved'       describe shift/reduce conflicts solving\n\
 299   `all'          include all the above information\n\
 300   `none'         disable the report\n\
 301 "), stdout);
 302
 303       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 304     }
 305
 306   exit (status);
 307 }
 308
 309
 310 /*------------------------------.
 311 | Display the version message.  |
 312 `------------------------------*/
 313
 314 static void
 315 version (void)
 316 {
 317   /* Some efforts were made to ease the translators' task, please
 318      continue.  */
 319   printf (_("bison (GNU Bison) %s"), VERSION);
 320   putc ('\n', stdout);
 321   printf ("%s", revision);
 322   fputs (_("Written by Robert Corbett and Richard Stallman.\n"), stdout);
 323   putc ('\n', stdout);
 324
 325   fprintf (stdout,
 326            _("Copyright (C) %d Free Software Foundation, Inc.\n"), 2007);
 327
 328   fputs (_("\
 329 This is free software; see the source for copying conditions.  There is NO\n\
 330 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
 331 "),
 332          stdout);
 333 }
 334
 335
 336 /*-------------------------------------.
 337 | --skeleton and --language handling.  |
 338 `--------------------------------------*/
 339
 340 void
 341 skeleton_arg (char const *arg, int prio, location const *loc)
 342 {
 343   if (prio < skeleton_prio)
 344     {
 345       skeleton_prio = prio;
 346       skeleton = arg;
 347     }
 348   else if (prio == skeleton_prio)
 349     {
 350       char const *msg =
 351         _("multiple skeleton declarations are invalid");
 352       if (loc)
 353         complain_at (*loc, msg);
 354       else
 355         complain (msg);
 356     }
 357 }
 358
 359 void
 360 language_argmatch (char const *arg, int prio, location const *loc)
 361 {
 362   char const *msg;
 363
 364   if (prio < language_prio)
 365     {
 366       int i;
 367       for (i = 0; valid_languages[i].language[0]; i++)
 368         if (c_strcasecmp (arg, valid_languages[i].language) == 0)
 369           {
 370             language_prio = prio;
 371             language = &valid_languages[i];
 372             return;
 373           }
 374       msg = _("invalid language `%s'");
 375     }
 376   else if (language_prio == prio)
 377     msg = _("multiple language declarations are invalid");
 378   else
 379     return;
 380
 381   if (loc)
 382     complain_at (*loc, msg, arg);
 383   else
 384     complain (msg, arg);
 385 }
 386
 387 /*----------------------.
 388 | Process the options.  |
 389 `----------------------*/
 390
 391 /* Shorts options.  */
 392 static char const short_options[] = "yvegxdhr:L:ltknVo:b:p:S:T::W";
 393
 394 /* Values for long options that do not have single-letter equivalents.  */
 395 enum
 396 {
 397   LOCATIONS_OPTION = CHAR_MAX + 1,
 398   PRINT_LOCALEDIR_OPTION,
 399   PRINT_DATADIR_OPTION
 400 };
 401
 402 static struct option const long_options[] =
 403 {
 404   /* Operation modes. */
 405   { "help",            no_argument,       0,   'h' },
 406   { "version",         no_argument,       0,   'V' },
 407   { "print-localedir", no_argument,       0,   PRINT_LOCALEDIR_OPTION },
 408   { "print-datadir",   no_argument,       0,   PRINT_DATADIR_OPTION   },
 409   { "warnings",        optional_argument, 0,   'W' },
 410
 411   /* Parser. */
 412   { "name-prefix",   required_argument,   0,   'p' },
 413   { "include",       required_argument,   0,   'I' },
 414
 415   /* Output. */
 416   { "file-prefix", required_argument,   0,   'b' },
 417   { "output",      required_argument,   0,   'o' },
 418   { "output-file", required_argument,   0,   'o' },
 419   { "graph",       optional_argument,   0,   'g' },
 420   { "xml",         optional_argument,   0,   'x' },
 421   { "report",      required_argument,   0,   'r' },
 422   { "verbose",     no_argument,         0,   'v' },
 423
 424   /* Hidden. */
 425   { "trace",         optional_argument,   0,     'T' },
 426
 427   /* Output.  */
 428   { "defines",     optional_argument,   0,   'd' },
 429
 430   /* Operation modes.  */
 431   { "fixed-output-files", no_argument,  0,   'y' },
 432   { "yacc",               no_argument,  0,   'y' },
 433
 434   /* Parser.  */
 435   { "debug",          no_argument,               0,   't' },
 436   { "locations",      no_argument,               0, LOCATIONS_OPTION },
 437   { "no-lines",       no_argument,               0,   'l' },
 438   { "raw",            no_argument,               0,     0 },
 439   { "skeleton",       required_argument,         0,   'S' },
 440   { "language",       required_argument,         0,   'L' },
 441   { "token-table",    no_argument,               0,   'k' },
 442
 443   {0, 0, 0, 0}
 444 };
 445
 446 /* Under DOS, there is no difference on the case.  This can be
 447    troublesome when looking for `.tab' etc.  */
 448 #ifdef MSDOS
 449 # define AS_FILE_NAME(File) (strlwr (File), (File))
 450 #else
 451 # define AS_FILE_NAME(File) (File)
 452 #endif
 453
 454 void
 455 getargs (int argc, char *argv[])
 456 {
 457   int c;
 458
 459   while ((c = getopt_long (argc, argv, short_options, long_options, NULL))
 460          != -1)
 461     switch (c)
 462       {
 463       case 0:
 464         /* Certain long options cause getopt_long to return 0.  */
 465         break;
 466
 467       case 'b':
 468         spec_file_prefix = AS_FILE_NAME (optarg);
 469         break;
 470
 471       case 'g':
 472         /* Here, the -g and --graph=FILE options are differentiated.  */
 473         graph_flag = true;
 474         if (optarg)
 475           spec_graph_file = xstrdup (AS_FILE_NAME (optarg));
 476         break;
 477
 478       case 'x':
 479         /* Here, the -x and --xml=FILE options are differentiated.  */
 480         xml_flag = true;
 481         if (optarg)
 482           spec_xml_file = xstrdup (AS_FILE_NAME (optarg));
 483         break;
 484
 485       case 'h':
 486         usage (EXIT_SUCCESS);
 487
 488       case 'L':
 489         language_argmatch (optarg, 0, NULL);
 490         break;
 491
 492       case 'S':
 493         skeleton_arg (AS_FILE_NAME (optarg), 0, NULL);
 494         break;
 495
 496       case 'I':
 497         include = AS_FILE_NAME (optarg);
 498         break;
 499
 500       case 'd':
 501         /* Here, the -d and --defines options are differentiated.  */
 502         defines_flag = true;
 503         if (optarg)
 504           spec_defines_file = xstrdup (AS_FILE_NAME (optarg));
 505         break;
 506
 507       case 'k':
 508         token_table_flag = true;
 509         break;
 510
 511       case 'l':
 512         no_lines_flag = true;
 513         break;
 514
 515       case 'o':
 516         spec_outfile = AS_FILE_NAME (optarg);
 517         break;
 518
 519       case 'p':
 520         spec_name_prefix = optarg;
 521         break;
 522
 523       case 'r':
 524         FLAGS_ARGMATCH (report, optarg);
 525         break;
 526
 527       case 'T':
 528         FLAGS_ARGMATCH (trace, optarg);
 529         break;
 530
 531       case 't':
 532         debug_flag = true;
 533         break;
 534
 535       case 'V':
 536         version ();
 537         exit (EXIT_SUCCESS);
 538
 539       case 'v':
 540         report_flag |= report_states;
 541         break;
 542
 543       case 'y':
 544         yacc_flag = true;
 545         break;
 546
 547       case 'W':
 548         if (optarg)
 549           FLAGS_ARGMATCH (warnings, optarg);
 550         else
 551           warnings_flag |= warnings_all;
 552         break;
 553
 554       case LOCATIONS_OPTION:
 555         locations_flag = true;
 556         break;
 557
 558       case PRINT_LOCALEDIR_OPTION:
 559         printf ("%s\n", LOCALEDIR);
 560         exit (EXIT_SUCCESS);
 561
 562       case PRINT_DATADIR_OPTION:
 563         printf ("%s\n", compute_pkgdatadir ());
 564         exit (EXIT_SUCCESS);
 565
 566       default:
 567         usage (EXIT_FAILURE);
 568       }
 569
 570   if (argc - optind != 1)
 571     {
 572       if (argc - optind < 1)
 573         error (0, 0, _("missing operand after `%s'"), argv[argc - 1]);
 574       else
 575         error (0, 0, _("extra operand `%s'"), argv[optind + 1]);
 576       usage (EXIT_FAILURE);
 577     }
 578
 579   current_file = grammar_file = uniqstr_new (argv[optind]);
 580 }