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