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 <c-strcase.h>
  29 #include <configmake.h>
  30 #include <error.h>
  31
  32 /* Hack to get <getopt.h> to declare getopt with a prototype.  */
  33 #if lint && ! defined __GNU_LIBRARY__
  34 # define __GNU_LIBRARY__
  35 # define HACK_FOR___GNU_LIBRARY___PROTOTYPE 1
  36 #endif
  37
  38 #include <getopt.h>
  39
  40 #ifdef HACK_FOR___GNU_LIBRARY___PROTOTYPE
  41 # undef __GNU_LIBRARY__
  42 # undef HACK_FOR___GNU_LIBRARY___PROTOTYPE
  43 #endif
  44
  45 #include "complain.h"
  46 #include "files.h"
  47 #include "getargs.h"
  48 #include "uniqstr.h"
  49
  50 bool debug_flag;
  51 bool defines_flag;
  52 bool graph_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 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   -k, --token-table          include a table of token names\n\
 279 \n\
 280 "), stdout);
 281
 282       fputs (_("\
 283 Output:\n\
 284   -d, --defines              also produce a header file\n\
 285   -r, --report=THINGS        also produce details on the automaton\n\
 286   -v, --verbose              same as `--report=state'\n\
 287   -b, --file-prefix=PREFIX   specify a PREFIX for output files\n\
 288   -o, --output=FILE          leave output to FILE\n\
 289   -g, --graph                also output a graph 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"), 2006);
 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[] = "yvegdhr: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 };
 400
 401 static struct option const long_options[] =
 402 {
 403   /* Operation modes. */
 404   { "help",            no_argument,       0,   'h' },
 405   { "version",         no_argument,       0,   'V' },
 406   { "print-localedir", no_argument,       0,   PRINT_LOCALEDIR_OPTION },
 407   { "warnings",        optional_argument, 0,   'W' },
 408
 409   /* Parser. */
 410   { "name-prefix",   required_argument,   0,   'p' },
 411   { "include",       required_argument,   0,   'I' },
 412
 413   /* Output. */
 414   { "file-prefix", required_argument,   0,   'b' },
 415   { "output",      required_argument,   0,   'o' },
 416   { "output-file", required_argument,   0,   'o' },
 417   { "graph",       optional_argument,   0,   'g' },
 418   { "report",      required_argument,   0,   'r' },
 419   { "verbose",     no_argument,         0,   'v' },
 420
 421   /* Hidden. */
 422   { "trace",         optional_argument,   0,     'T' },
 423
 424   /* Output.  */
 425   { "defines",     optional_argument,   0,   'd' },
 426
 427   /* Operation modes.  */
 428   { "fixed-output-files", no_argument,  0,   'y' },
 429   { "yacc",               no_argument,  0,   'y' },
 430
 431   /* Parser.  */
 432   { "debug",          no_argument,               0,   't' },
 433   { "locations",      no_argument,               0, LOCATIONS_OPTION },
 434   { "no-lines",       no_argument,               0,   'l' },
 435   { "raw",            no_argument,               0,     0 },
 436   { "skeleton",       required_argument,         0,   'S' },
 437   { "language",       required_argument,         0,   'L' },
 438   { "token-table",    no_argument,               0,   'k' },
 439
 440   {0, 0, 0, 0}
 441 };
 442
 443 /* Under DOS, there is no difference on the case.  This can be
 444    troublesome when looking for `.tab' etc.  */
 445 #ifdef MSDOS
 446 # define AS_FILE_NAME(File) (strlwr (File), (File))
 447 #else
 448 # define AS_FILE_NAME(File) (File)
 449 #endif
 450
 451 void
 452 getargs (int argc, char *argv[])
 453 {
 454   int c;
 455
 456   while ((c = getopt_long (argc, argv, short_options, long_options, NULL))
 457          != -1)
 458     switch (c)
 459       {
 460       case 0:
 461         /* Certain long options cause getopt_long to return 0.  */
 462         break;
 463
 464       case 'b':
 465         spec_file_prefix = AS_FILE_NAME (optarg);
 466         break;
 467
 468       case 'g':
 469         /* Here, the -g and --graph=FILE options are differentiated.  */
 470         graph_flag = true;
 471         if (optarg)
 472           spec_graph_file = xstrdup (AS_FILE_NAME (optarg));
 473         break;
 474
 475       case 'h':
 476         usage (EXIT_SUCCESS);
 477
 478       case 'L':
 479         language_argmatch (optarg, 0, NULL);
 480         break;
 481
 482       case 'S':
 483         skeleton_arg (AS_FILE_NAME (optarg), 0, NULL);
 484         break;
 485
 486       case 'I':
 487         include = AS_FILE_NAME (optarg);
 488         break;
 489
 490       case 'd':
 491         /* Here, the -d and --defines options are differentiated.  */
 492         defines_flag = true;
 493         if (optarg)
 494           spec_defines_file = xstrdup (AS_FILE_NAME (optarg));
 495         break;
 496
 497       case 'k':
 498         token_table_flag = true;
 499         break;
 500
 501       case 'l':
 502         no_lines_flag = true;
 503         break;
 504
 505       case 'o':
 506         spec_outfile = AS_FILE_NAME (optarg);
 507         break;
 508
 509       case 'p':
 510         spec_name_prefix = optarg;
 511         break;
 512
 513       case 'r':
 514         FLAGS_ARGMATCH (report, optarg);
 515         break;
 516
 517       case 'T':
 518         FLAGS_ARGMATCH (trace, optarg);
 519         break;
 520
 521       case 't':
 522         debug_flag = true;
 523         break;
 524
 525       case 'V':
 526         version ();
 527         exit (EXIT_SUCCESS);
 528
 529       case 'v':
 530         report_flag |= report_states;
 531         break;
 532
 533       case 'y':
 534         yacc_flag = true;
 535         break;
 536
 537       case 'W':
 538         if (optarg)
 539           FLAGS_ARGMATCH (warnings, optarg);
 540         else
 541           warnings_flag |= warnings_all;
 542         break;
 543
 544       case LOCATIONS_OPTION:
 545         locations_flag = true;
 546         break;
 547
 548       case PRINT_LOCALEDIR_OPTION:
 549         printf ("%s\n", LOCALEDIR);
 550         exit (EXIT_SUCCESS);
 551
 552       default:
 553         usage (EXIT_FAILURE);
 554       }
 555
 556   if (argc - optind != 1)
 557     {
 558       if (argc - optind < 1)
 559         error (0, 0, _("missing operand after `%s'"), argv[argc - 1]);
 560       else
 561         error (0, 0, _("extra operand `%s'"), argv[optind + 1]);
 562       usage (EXIT_FAILURE);
 563     }
 564
 565   current_file = grammar_file = uniqstr_new (argv[optind]);
 566 }