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    Bison is free software; you can redistribute it and/or modify it
   9    under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2, or (at your option)
  11    any later version.
  12
  13    Bison is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with Bison; see the file COPYING.  If not, write to the Free
  20    Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.  */
  22
  23 #include <config.h>
  24 #include "system.h"
  25 #include "revision.h"
  26
  27 #include <argmatch.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 locations_flag;
  53 bool no_lines_flag;
  54 bool no_parser_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 pull_parser = true;
  63 bool pure_parser = false;
  64 bool push_parser = false;
  65
  66 int report_flag = report_none;
  67 int trace_flag = trace_none;
  68 int warnings_flag = warnings_none;
  69
  70 static struct bison_language const valid_languages[] = {
  71   { "c", "c-skel.m4", ".c", ".h", true },
  72   { "c++", "c++-skel.m4", ".cc", ".hh", true },
  73   { "java", "java-skel.m4", ".java", ".java", false },
  74   { "", "", "", "", false }
  75 };
  76
  77 static int skeleton_prio = 2;
  78 const char *skeleton = NULL;
  79 static int language_prio = 2;
  80 struct bison_language const *language = &valid_languages[0];
  81 const char *include = NULL;
  82
  83 char *program_name;
  84
  85
  86 /** Decode an option's set of keys.
  87  *
  88  *  \param option   option being decoded.
  89  *  \param keys     array of valid subarguments.
  90  *  \param values   array of corresponding (int) values.
  91  *  \param flags    the flags to update
  92  *  \param args     colon separated list of effective subarguments to decode.
  93  *                  If 0, then activate all the flags.
  94  *
  95  *  The special value 0 resets the flags to 0.
  96  */
  97 static void
  98 flags_argmatch (const char *option,
  99                 const char * const keys[], const int values[],
 100                 int *flags, char *args)
 101 {
 102   if (args)
 103     {
 104       args = strtok (args, ",");
 105       while (args)
 106         {
 107           int value = XARGMATCH (option, args, keys, values);
 108           if (value == 0)
 109             *flags = 0;
 110           else
 111             *flags |= value;
 112           args = strtok (NULL, ",");
 113         }
 114     }
 115   else
 116     *flags = ~0;
 117 }
 118
 119 /** Decode a set of sub arguments.
 120  *
 121  *  \param FlagName  the flag familly to update.
 122  *  \param Args      the effective sub arguments to decode.
 123  *
 124  *  \arg FlagName_args   the list of keys.
 125  *  \arg FlagName_types  the list of values.
 126  *  \arg FlagName_flag   the flag to update.
 127  */
 128 #define FLAGS_ARGMATCH(FlagName, Args)                                  \
 129   flags_argmatch ("--" #FlagName, FlagName ## _args, FlagName ## _types, \
 130                   &FlagName ## _flag, Args)
 131
 132
 133 /*----------------------.
 134 | --report's handling.  |
 135 `----------------------*/
 136
 137 static const char * const report_args[] =
 138 {
 139   /* In a series of synonyms, present the most meaningful first, so
 140      that argmatch_valid be more readable.  */
 141   "none",
 142   "state", "states",
 143   "itemset", "itemsets",
 144   "lookahead", "lookaheads", "look-ahead",
 145   "solved",
 146   "all",
 147   0
 148 };
 149
 150 static const int report_types[] =
 151 {
 152   report_none,
 153   report_states, report_states,
 154   report_states | report_itemsets, report_states | report_itemsets,
 155   report_states | report_lookahead_tokens,
 156   report_states | report_lookahead_tokens,
 157   report_states | report_lookahead_tokens,
 158   report_states | report_solved_conflicts,
 159   report_all
 160 };
 161
 162 ARGMATCH_VERIFY (report_args, report_types);
 163
 164
 165 /*---------------------.
 166 | --trace's handling.  |
 167 `---------------------*/
 168
 169 static const char * const trace_args[] =
 170 {
 171   /* In a series of synonyms, present the most meaningful first, so
 172      that argmatch_valid be more readable.  */
 173   "none       - no traces",
 174   "scan       - grammar scanner traces",
 175   "parse      - grammar parser traces",
 176   "automaton  - construction of the automaton",
 177   "bitsets    - use of bitsets",
 178   "grammar    - reading, reducing the grammar",
 179   "resource   - memory consumption (where available)",
 180   "sets       - grammar sets: firsts, nullable etc.",
 181   "tools      - m4 invocation",
 182   "m4         - m4 traces",
 183   "skeleton   - skeleton postprocessing",
 184   "time       - time consumption",
 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_tools,
 200   trace_m4,
 201   trace_skeleton,
 202   trace_time,
 203   trace_all
 204 };
 205
 206 ARGMATCH_VERIFY (trace_args, trace_types);
 207
 208
 209 /*------------------------.
 210 | --warnings's handling.  |
 211 `------------------------*/
 212
 213 static const char * const warnings_args[] =
 214 {
 215   /* In a series of synonyms, present the most meaningful first, so
 216      that argmatch_valid be more readable.  */
 217   "none            - no warnings",
 218   "midrule-values  - unset or unused midrule values",
 219   "yacc            - incompatibilities with POSIX YACC",
 220   "all             - all of the above",
 221   "error           - warnings are errors",
 222   0
 223 };
 224
 225 static const int warnings_types[] =
 226 {
 227   warnings_none,
 228   warnings_midrule_values,
 229   warnings_yacc,
 230   warnings_all,
 231   warnings_error
 232 };
 233
 234 ARGMATCH_VERIFY (warnings_args, warnings_types);
 235
 236
 237 /*-------------------------------------------.
 238 | Display the help message and exit STATUS.  |
 239 `-------------------------------------------*/
 240
 241 static void usage (int) ATTRIBUTE_NORETURN;
 242
 243 static void
 244 usage (int status)
 245 {
 246   if (status != 0)
 247     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 248              program_name);
 249   else
 250     {
 251       printf (_("Usage: %s [OPTION]... FILE\n"), program_name);
 252       fputs (_("\
 253 Generate LALR(1) and GLR parsers.\n\
 254 \n\
 255 "), stdout);
 256
 257       fputs (_("\
 258 Mandatory arguments to long options are mandatory for short options too.\n\
 259 "), stdout);
 260
 261       fputs (_("\
 262 \n\
 263 Operation modes:\n\
 264   -h, --help                 display this help and exit\n\
 265   -V, --version              output version information and exit\n\
 266       --print-localedir      output directory containing locale-dependent data\n\
 267   -y, --yacc                 emulate POSIX Yacc\n\
 268 \n\
 269 "), stdout);
 270
 271       fputs (_("\
 272 Parser:\n\
 273   -S, --skeleton=FILE        specify the skeleton to use\n\
 274   -t, --debug                instrument the parser for debugging\n\
 275       --locations            enable locations computation\n\
 276   -p, --name-prefix=PREFIX   prepend PREFIX to the external symbols\n\
 277   -l, --no-lines             don't generate `#line' directives\n\
 278   -n, --no-parser            generate the tables only\n\
 279   -k, --token-table          include a table of token names\n\
 280 \n\
 281 "), stdout);
 282
 283       fputs (_("\
 284 Output:\n\
 285   -d, --defines              also produce a header file\n\
 286   -r, --report=THINGS        also produce details on the automaton\n\
 287   -v, --verbose              same as `--report=state'\n\
 288   -b, --file-prefix=PREFIX   specify a PREFIX for output files\n\
 289   -o, --output=FILE          leave output to FILE\n\
 290   -g, --graph                also output a graph of the automaton\n\
 291 \n\
 292 "), stdout);
 293
 294       fputs (_("\
 295 THINGS is a list of comma separated words that can include:\n\
 296   `state'        describe the states\n\
 297   `itemset'      complete the core item sets with their closure\n\
 298   `lookahead'    explicitly associate lookahead tokens to items\n\
 299   `solved'       describe shift/reduce conflicts solving\n\
 300   `all'          include all the above information\n\
 301   `none'         disable the report\n\
 302 "), stdout);
 303
 304       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 305     }
 306
 307   exit (status);
 308 }
 309
 310
 311 /*------------------------------.
 312 | Display the version message.  |
 313 `------------------------------*/
 314
 315 static void
 316 version (void)
 317 {
 318   /* Some efforts were made to ease the translators' task, please
 319      continue.  */
 320   printf (_("bison (GNU Bison) %s"), VERSION);
 321   putc ('\n', stdout);
 322   printf ("%s", revision);
 323   fputs (_("Written by Robert Corbett and Richard Stallman.\n"), stdout);
 324   putc ('\n', stdout);
 325
 326   fprintf (stdout,
 327            _("Copyright (C) %d Free Software Foundation, Inc.\n"), 2006);
 328
 329   fputs (_("\
 330 This is free software; see the source for copying conditions.  There is NO\n\
 331 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
 332 "),
 333          stdout);
 334 }
 335
 336
 337 /*-------------------------------------.
 338 | --skeleton and --language handling.  |
 339 `--------------------------------------*/
 340
 341 void
 342 skeleton_arg (char const *arg, int prio, location const *loc)
 343 {
 344   if (prio < skeleton_prio)
 345     {
 346       skeleton_prio = prio;
 347       skeleton = arg;
 348     }
 349   else if (prio == skeleton_prio)
 350     {
 351       char const *msg =
 352         _("multiple skeleton declarations are invalid");
 353       if (loc)
 354         complain_at (*loc, msg);
 355       else
 356         complain (msg);
 357     }
 358 }
 359
 360 void
 361 language_argmatch (char const *arg, int prio, location const *loc)
 362 {
 363   char const *msg;
 364
 365   if (prio < language_prio)
 366     {
 367       int i;
 368       for (i = 0; valid_languages[i].language[0]; i++)
 369         if (strcasecmp (arg, valid_languages[i].language) == 0)
 370           {
 371             language_prio = prio;
 372             language = &valid_languages[i];
 373             return;
 374           }
 375       msg = _("invalid language `%s'");
 376     }
 377   else if (language_prio == prio)
 378     msg = _("multiple language declarations are invalid");
 379   else
 380     return;
 381
 382   if (loc)
 383     complain_at (*loc, msg, arg);
 384   else
 385     complain (msg, arg);
 386 }
 387
 388 /*----------------------.
 389 | Process the options.  |
 390 `----------------------*/
 391
 392 /* Shorts options.  */
 393 static char const short_options[] = "yvegdhr:L:ltknVo:b:p:S:T::W";
 394
 395 /* Values for long options that do not have single-letter equivalents.  */
 396 enum
 397 {
 398   LOCATIONS_OPTION = CHAR_MAX + 1,
 399   PRINT_LOCALEDIR_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   { "warnings",        optional_argument, 0,   'W' },
 409
 410   /* Parser. */
 411   { "name-prefix",   required_argument,   0,   'p' },
 412   { "include",       required_argument,   0,   'I' },
 413
 414   /* Output. */
 415   { "file-prefix", required_argument,   0,   'b' },
 416   { "output",      required_argument,   0,   'o' },
 417   { "output-file", required_argument,   0,   'o' },
 418   { "graph",       optional_argument,   0,   'g' },
 419   { "report",      required_argument,   0,   'r' },
 420   { "verbose",     no_argument,         0,   'v' },
 421
 422   /* Hidden. */
 423   { "trace",         optional_argument,   0,     'T' },
 424
 425   /* Output.  */
 426   { "defines",     optional_argument,   0,   'd' },
 427
 428   /* Operation modes.  */
 429   { "fixed-output-files", no_argument,  0,   'y' },
 430   { "yacc",               no_argument,  0,   'y' },
 431
 432   /* Parser.  */
 433   { "debug",          no_argument,               0,   't' },
 434   { "locations",      no_argument,               0, LOCATIONS_OPTION },
 435   { "no-lines",       no_argument,               0,   'l' },
 436   { "no-parser",      no_argument,               0,   'n' },
 437   { "raw",            no_argument,               0,     0 },
 438   { "skeleton",       required_argument,         0,   'S' },
 439   { "language",       required_argument,         0,   'L' },
 440   { "token-table",    no_argument,               0,   'k' },
 441
 442   {0, 0, 0, 0}
 443 };
 444
 445 /* Under DOS, there is no difference on the case.  This can be
 446    troublesome when looking for `.tab' etc.  */
 447 #ifdef MSDOS
 448 # define AS_FILE_NAME(File) (strlwr (File), (File))
 449 #else
 450 # define AS_FILE_NAME(File) (File)
 451 #endif
 452
 453 void
 454 getargs (int argc, char *argv[])
 455 {
 456   int c;
 457
 458   while ((c = getopt_long (argc, argv, short_options, long_options, NULL))
 459          != -1)
 460     switch (c)
 461       {
 462       case 0:
 463         /* Certain long options cause getopt_long to return 0.  */
 464         break;
 465
 466       case 'b':
 467         spec_file_prefix = AS_FILE_NAME (optarg);
 468         break;
 469
 470       case 'g':
 471         /* Here, the -g and --graph=FILE options are differentiated.  */
 472         graph_flag = true;
 473         if (optarg)
 474           spec_graph_file = xstrdup (AS_FILE_NAME (optarg));
 475         break;
 476
 477       case 'h':
 478         usage (EXIT_SUCCESS);
 479
 480       case 'L':
 481         language_argmatch (optarg, 0, NULL);
 482         break;
 483
 484       case 'S':
 485         skeleton_arg (AS_FILE_NAME (optarg), 0, NULL);
 486         break;
 487
 488       case 'I':
 489         include = AS_FILE_NAME (optarg);
 490         break;
 491
 492       case 'd':
 493         /* Here, the -d and --defines options are differentiated.  */
 494         defines_flag = true;
 495         if (optarg)
 496           spec_defines_file = xstrdup (AS_FILE_NAME (optarg));
 497         break;
 498
 499       case 'k':
 500         token_table_flag = true;
 501         break;
 502
 503       case 'l':
 504         no_lines_flag = true;
 505         break;
 506
 507       case 'n':
 508         no_parser_flag = true;
 509         break;
 510
 511       case 'o':
 512         spec_outfile = AS_FILE_NAME (optarg);
 513         break;
 514
 515       case 'p':
 516         spec_name_prefix = optarg;
 517         break;
 518
 519       case 'r':
 520         FLAGS_ARGMATCH (report, optarg);
 521         break;
 522
 523       case 'T':
 524         FLAGS_ARGMATCH (trace, optarg);
 525         break;
 526
 527       case 't':
 528         debug_flag = true;
 529         break;
 530
 531       case 'V':
 532         version ();
 533         exit (EXIT_SUCCESS);
 534
 535       case 'v':
 536         report_flag |= report_states;
 537         break;
 538
 539       case 'y':
 540         yacc_flag = true;
 541         break;
 542
 543       case 'W':
 544         if (optarg)
 545           FLAGS_ARGMATCH (warnings, optarg);
 546         else
 547           warnings_flag |= warnings_all;
 548         break;
 549
 550       case LOCATIONS_OPTION:
 551         locations_flag = true;
 552         break;
 553
 554       case PRINT_LOCALEDIR_OPTION:
 555         printf ("%s\n", LOCALEDIR);
 556         exit (EXIT_SUCCESS);
 557
 558       default:
 559         usage (EXIT_FAILURE);
 560       }
 561
 562   if (argc - optind != 1)
 563     {
 564       if (argc - optind < 1)
 565         error (0, 0, _("missing operand after `%s'"), argv[argc - 1]);
 566       else
 567         error (0, 0, _("extra operand `%s'"), argv[optind + 1]);
 568       usage (EXIT_FAILURE);
 569     }
 570
 571   current_file = grammar_file = uniqstr_new (argv[optind]);
 572 }