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
  25 #include <argmatch.h>
  26 #include <c-strcase.h>
  27 #include <configmake.h>
  28 #include <error.h>
  29
  30 /* Hack to get <getopt.h> to declare getopt with a prototype.  */
  31 #if lint && ! defined __GNU_LIBRARY__
  32 # define __GNU_LIBRARY__
  33 # define HACK_FOR___GNU_LIBRARY___PROTOTYPE 1
  34 #endif
  35
  36 #include <getopt.h>
  37
  38 #ifdef HACK_FOR___GNU_LIBRARY___PROTOTYPE
  39 # undef __GNU_LIBRARY__
  40 # undef HACK_FOR___GNU_LIBRARY___PROTOTYPE
  41 #endif
  42
  43 #include "complain.h"
  44 #include "files.h"
  45 #include "getargs.h"
  46 #include "uniqstr.h"
  47
  48 bool debug_flag;
  49 bool defines_flag;
  50 bool graph_flag;
  51 bool locations_flag;
  52 bool no_lines_flag;
  53 bool token_table_flag;
  54 bool yacc_flag; /* for -y */
  55
  56 bool error_verbose = false;
  57
  58 bool nondeterministic_parser = false;
  59 bool glr_parser = false;
  60 bool pull_parser = true;
  61 bool pure_parser = false;
  62 bool push_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   -y, --yacc                 emulate POSIX Yacc\n\
 266 \n\
 267 "), stdout);
 268
 269       fputs (_("\
 270 Parser:\n\
 271   -S, --skeleton=FILE        specify the skeleton to use\n\
 272   -t, --debug                instrument the parser for debugging\n\
 273       --locations            enable locations computation\n\
 274   -p, --name-prefix=PREFIX   prepend PREFIX to the external symbols\n\
 275   -l, --no-lines             don't generate `#line' directives\n\
 276   -k, --token-table          include a table of token names\n\
 277 \n\
 278 "), stdout);
 279
 280       fputs (_("\
 281 Output:\n\
 282   -d, --defines              also produce a header file\n\
 283   -r, --report=THINGS        also produce details on the automaton\n\
 284   -v, --verbose              same as `--report=state'\n\
 285   -b, --file-prefix=PREFIX   specify a PREFIX for output files\n\
 286   -o, --output=FILE          leave output to FILE\n\
 287   -g, --graph                also output a graph of the automaton\n\
 288 \n\
 289 "), stdout);
 290
 291       fputs (_("\
 292 THINGS is a list of comma separated words that can include:\n\
 293   `state'        describe the states\n\
 294   `itemset'      complete the core item sets with their closure\n\
 295   `lookahead'    explicitly associate lookahead tokens to items\n\
 296   `solved'       describe shift/reduce conflicts solving\n\
 297   `all'          include all the above information\n\
 298   `none'         disable the report\n\
 299 "), stdout);
 300
 301       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 302     }
 303
 304   exit (status);
 305 }
 306
 307
 308 /*------------------------------.
 309 | Display the version message.  |
 310 `------------------------------*/
 311
 312 static void
 313 version (void)
 314 {
 315   /* Some efforts were made to ease the translators' task, please
 316      continue.  */
 317   printf (_("bison (GNU Bison) %s"), VERSION);
 318   putc ('\n', stdout);
 319   printf ("%s", revision);
 320   fputs (_("Written by Robert Corbett and Richard Stallman.\n"), stdout);
 321   putc ('\n', stdout);
 322
 323   fprintf (stdout,
 324            _("Copyright (C) %d Free Software Foundation, Inc.\n"), 2006);
 325
 326   fputs (_("\
 327 This is free software; see the source for copying conditions.  There is NO\n\
 328 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
 329 "),
 330          stdout);
 331 }
 332
 333
 334 /*-------------------------------------.
 335 | --skeleton and --language handling.  |
 336 `--------------------------------------*/
 337
 338 void
 339 skeleton_arg (char const *arg, int prio, location const *loc)
 340 {
 341   if (prio < skeleton_prio)
 342     {
 343       skeleton_prio = prio;
 344       skeleton = arg;
 345     }
 346   else if (prio == skeleton_prio)
 347     {
 348       char const *msg =
 349         _("multiple skeleton declarations are invalid");
 350       if (loc)
 351         complain_at (*loc, msg);
 352       else
 353         complain (msg);
 354     }
 355 }
 356
 357 void
 358 language_argmatch (char const *arg, int prio, location const *loc)
 359 {
 360   char const *msg;
 361
 362   if (prio < language_prio)
 363     {
 364       int i;
 365       for (i = 0; valid_languages[i].language[0]; i++)
 366         if (c_strcasecmp (arg, valid_languages[i].language) == 0)
 367           {
 368             language_prio = prio;
 369             language = &valid_languages[i];
 370             return;
 371           }
 372       msg = _("invalid language `%s'");
 373     }
 374   else if (language_prio == prio)
 375     msg = _("multiple language declarations are invalid");
 376   else
 377     return;
 378
 379   if (loc)
 380     complain_at (*loc, msg, arg);
 381   else
 382     complain (msg, arg);
 383 }
 384
 385 /*----------------------.
 386 | Process the options.  |
 387 `----------------------*/
 388
 389 /* Shorts options.  */
 390 static char const short_options[] = "yvegdhr:L:ltknVo:b:p:S:T::W";
 391
 392 /* Values for long options that do not have single-letter equivalents.  */
 393 enum
 394 {
 395   LOCATIONS_OPTION = CHAR_MAX + 1,
 396   PRINT_LOCALEDIR_OPTION
 397 };
 398
 399 static struct option const long_options[] =
 400 {
 401   /* Operation modes. */
 402   { "help",            no_argument,       0,   'h' },
 403   { "version",         no_argument,       0,   'V' },
 404   { "print-localedir", no_argument,       0,   PRINT_LOCALEDIR_OPTION },
 405   { "warnings",        optional_argument, 0,   'W' },
 406
 407   /* Parser. */
 408   { "name-prefix",   required_argument,   0,   'p' },
 409   { "include",       required_argument,   0,   'I' },
 410
 411   /* Output. */
 412   { "file-prefix", required_argument,   0,   'b' },
 413   { "output",      required_argument,   0,   'o' },
 414   { "output-file", required_argument,   0,   'o' },
 415   { "graph",       optional_argument,   0,   'g' },
 416   { "report",      required_argument,   0,   'r' },
 417   { "verbose",     no_argument,         0,   'v' },
 418
 419   /* Hidden. */
 420   { "trace",         optional_argument,   0,     'T' },
 421
 422   /* Output.  */
 423   { "defines",     optional_argument,   0,   'd' },
 424
 425   /* Operation modes.  */
 426   { "fixed-output-files", no_argument,  0,   'y' },
 427   { "yacc",               no_argument,  0,   'y' },
 428
 429   /* Parser.  */
 430   { "debug",          no_argument,               0,   't' },
 431   { "locations",      no_argument,               0, LOCATIONS_OPTION },
 432   { "no-lines",       no_argument,               0,   'l' },
 433   { "raw",            no_argument,               0,     0 },
 434   { "skeleton",       required_argument,         0,   'S' },
 435   { "language",       required_argument,         0,   'L' },
 436   { "token-table",    no_argument,               0,   'k' },
 437
 438   {0, 0, 0, 0}
 439 };
 440
 441 /* Under DOS, there is no difference on the case.  This can be
 442    troublesome when looking for `.tab' etc.  */
 443 #ifdef MSDOS
 444 # define AS_FILE_NAME(File) (strlwr (File), (File))
 445 #else
 446 # define AS_FILE_NAME(File) (File)
 447 #endif
 448
 449 void
 450 getargs (int argc, char *argv[])
 451 {
 452   int c;
 453
 454   while ((c = getopt_long (argc, argv, short_options, long_options, NULL))
 455          != -1)
 456     switch (c)
 457       {
 458       case 0:
 459         /* Certain long options cause getopt_long to return 0.  */
 460         break;
 461
 462       case 'b':
 463         spec_file_prefix = AS_FILE_NAME (optarg);
 464         break;
 465
 466       case 'g':
 467         /* Here, the -g and --graph=FILE options are differentiated.  */
 468         graph_flag = true;
 469         if (optarg)
 470           spec_graph_file = xstrdup (AS_FILE_NAME (optarg));
 471         break;
 472
 473       case 'h':
 474         usage (EXIT_SUCCESS);
 475
 476       case 'L':
 477         language_argmatch (optarg, 0, NULL);
 478         break;
 479
 480       case 'S':
 481         skeleton_arg (AS_FILE_NAME (optarg), 0, NULL);
 482         break;
 483
 484       case 'I':
 485         include = AS_FILE_NAME (optarg);
 486         break;
 487
 488       case 'd':
 489         /* Here, the -d and --defines options are differentiated.  */
 490         defines_flag = true;
 491         if (optarg)
 492           spec_defines_file = xstrdup (AS_FILE_NAME (optarg));
 493         break;
 494
 495       case 'k':
 496         token_table_flag = true;
 497         break;
 498
 499       case 'l':
 500         no_lines_flag = true;
 501         break;
 502
 503       case 'o':
 504         spec_outfile = AS_FILE_NAME (optarg);
 505         break;
 506
 507       case 'p':
 508         spec_name_prefix = optarg;
 509         break;
 510
 511       case 'r':
 512         FLAGS_ARGMATCH (report, optarg);
 513         break;
 514
 515       case 'T':
 516         FLAGS_ARGMATCH (trace, optarg);
 517         break;
 518
 519       case 't':
 520         debug_flag = true;
 521         break;
 522
 523       case 'V':
 524         version ();
 525         exit (EXIT_SUCCESS);
 526
 527       case 'v':
 528         report_flag |= report_states;
 529         break;
 530
 531       case 'y':
 532         yacc_flag = true;
 533         break;
 534
 535       case 'W':
 536         if (optarg)
 537           FLAGS_ARGMATCH (warnings, optarg);
 538         else
 539           warnings_flag |= warnings_all;
 540         break;
 541
 542       case LOCATIONS_OPTION:
 543         locations_flag = true;
 544         break;
 545
 546       case PRINT_LOCALEDIR_OPTION:
 547         printf ("%s\n", LOCALEDIR);
 548         exit (EXIT_SUCCESS);
 549
 550       default:
 551         usage (EXIT_FAILURE);
 552       }
 553
 554   if (argc - optind != 1)
 555     {
 556       if (argc - optind < 1)
 557         error (0, 0, _("missing operand after `%s'"), argv[argc - 1]);
 558       else
 559         error (0, 0, _("extra operand `%s'"), argv[optind + 1]);
 560       usage (EXIT_FAILURE);
 561     }
 562
 563   current_file = grammar_file = uniqstr_new (argv[optind]);
 564 }