src/getargs.c

   1 /* Parse command line arguments for Bison.
   2
   3    Copyright (C) 1984, 1986, 1989, 1992, 2000, 2001, 2002, 2003, 2004, 2005
   4    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 "system.h"
  24
  25 #include <argmatch.h>
  26 #include <error.h>
  27
  28 /* Hack to get <getopt.h> to declare getopt with a prototype.  */
  29 #if lint && ! defined __GNU_LIBRARY__
  30 # define __GNU_LIBRARY__
  31 # define HACK_FOR___GNU_LIBRARY___PROTOTYPE 1
  32 #endif
  33
  34 #include <getopt.h>
  35
  36 #ifdef HACK_FOR___GNU_LIBRARY___PROTOTYPE
  37 # undef __GNU_LIBRARY__
  38 # undef HACK_FOR___GNU_LIBRARY___PROTOTYPE
  39 #endif
  40
  41 #include "complain.h"
  42 #include "files.h"
  43 #include "getargs.h"
  44 #include "uniqstr.h"
  45
  46 bool debug_flag;
  47 bool defines_flag;
  48 bool locations_flag;
  49 bool no_lines_flag;
  50 bool no_parser_flag;
  51 int report_flag = report_none;
  52 bool token_table_flag;
  53 bool yacc_flag; /* for -y */
  54 bool graph_flag;
  55 int trace_flag = trace_none;
  56
  57 bool nondeterministic_parser = false;
  58 bool glr_parser = false;
  59 bool pure_parser = false;
  60
  61 const char *skeleton = NULL;
  62 const char *include = NULL;
  63
  64 extern char *program_name;
  65
  66
  67 /*---------------------.
  68 | --trace's handling.  |
  69 `---------------------*/
  70
  71 static const char * const trace_args[] =
  72 {
  73   /* In a series of synonyms, present the most meaningful first, so
  74      that argmatch_valid be more readable.  */
  75   "none       - no report",
  76   "scan       - grammar scanner traces",
  77   "parse      - grammar parser traces",
  78   "automaton  - contruction of the automaton",
  79   "bitsets    - use of bitsets",
  80   "grammar    - reading, reducing of the grammar",
  81   "resource   - memory consumption (where available)",
  82   "sets       - grammar sets: firsts, nullable etc.",
  83   "tools      - m4 invocation and preserve the temporary file",
  84   "skeleton   - skeleton postprocessing",
  85   "time       - time consumption",
  86   "all        - all of the above",
  87   0
  88 };
  89
  90 static const int trace_types[] =
  91 {
  92   trace_none,
  93   trace_scan,
  94   trace_parse,
  95   trace_automaton,
  96   trace_bitsets,
  97   trace_grammar,
  98   trace_resource,
  99   trace_sets,
 100   trace_tools,
 101   trace_skeleton,
 102   trace_time,
 103   trace_all
 104 };
 105
 106
 107 static void
 108 trace_argmatch (char *args)
 109 {
 110   verify (trace_constraint, ARGMATCH_CONSTRAINT (trace_args, trace_types));
 111   if (args)
 112     {
 113       args = strtok (args, ",");
 114       do
 115         {
 116           int trace = XARGMATCH ("--trace", args,
 117                                  trace_args, trace_types);
 118           if (trace == trace_none)
 119             trace_flag = trace_none;
 120           else
 121             trace_flag |= trace;
 122         }
 123       while ((args = strtok (NULL, ",")));
 124     }
 125   else
 126     trace_flag = trace_all;
 127 }
 128
 129
 130 /*----------------------.
 131 | --report's handling.  |
 132 `----------------------*/
 133
 134 static const char * const report_args[] =
 135 {
 136   /* In a series of synonyms, present the most meaningful first, so
 137      that argmatch_valid be more readable.  */
 138   "none",
 139   "state", "states",
 140   "itemset", "itemsets",
 141   "look-ahead", "lookahead", "lookaheads",
 142   "solved",
 143   "all",
 144   0
 145 };
 146
 147 static const int report_types[] =
 148 {
 149   report_none,
 150   report_states, report_states,
 151   report_states | report_itemsets, report_states | report_itemsets,
 152   report_states | report_look_ahead_tokens,
 153   report_states | report_look_ahead_tokens,
 154   report_states | report_look_ahead_tokens,
 155   report_states | report_solved_conflicts,
 156   report_all
 157 };
 158
 159
 160 static void
 161 report_argmatch (char *args)
 162 {
 163   verify (report_constraint, ARGMATCH_CONSTRAINT (report_args, report_types));
 164   args = strtok (args, ",");
 165   do
 166     {
 167       int report = XARGMATCH ("--report", args,
 168                               report_args, report_types);
 169       if (report == report_none)
 170         report_flag = report_none;
 171       else
 172         report_flag |= report;
 173     }
 174   while ((args = strtok (NULL, ",")));
 175 }
 176
 177
 178 /*-------------------------------------------.
 179 | Display the help message and exit STATUS.  |
 180 `-------------------------------------------*/
 181
 182 static void usage (int) ATTRIBUTE_NORETURN;
 183
 184 static void
 185 usage (int status)
 186 {
 187   if (status != 0)
 188     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 189              program_name);
 190   else
 191     {
 192       /* Some efforts were made to ease the translators' task, please
 193          continue.  */
 194       fputs (_("\
 195 GNU bison generates parsers for LALR(1) grammars.\n"), stdout);
 196       putc ('\n', stdout);
 197
 198       fprintf (stdout, _("\
 199 Usage: %s [OPTION]... FILE\n"), program_name);
 200       putc ('\n', stdout);
 201
 202       fputs (_("\
 203 If a long option shows an argument as mandatory, then it is mandatory\n\
 204 for the equivalent short option also.  Similarly for optional arguments.\n"),
 205              stdout);
 206       putc ('\n', stdout);
 207
 208       fputs (_("\
 209 Operation modes:\n\
 210   -h, --help      display this help and exit\n\
 211   -V, --version   output version information and exit\n\
 212   -y, --yacc      emulate POSIX yacc\n"), stdout);
 213       putc ('\n', stdout);
 214
 215       fputs (_("\
 216 Parser:\n\
 217   -S, --skeleton=FILE        specify the skeleton to use\n\
 218   -t, --debug                instrument the parser for debugging\n\
 219       --locations            enable locations computation\n\
 220   -p, --name-prefix=PREFIX   prepend PREFIX to the external symbols\n\
 221   -l, --no-lines             don't generate `#line' directives\n\
 222   -n, --no-parser            generate the tables only\n\
 223   -k, --token-table          include a table of token names\n\
 224 "), stdout);
 225       putc ('\n', stdout);
 226
 227       fputs (_("\
 228 Output:\n\
 229   -d, --defines              also produce a header file\n\
 230   -r, --report=THINGS        also produce details on the automaton\n\
 231   -v, --verbose              same as `--report=state'\n\
 232   -b, --file-prefix=PREFIX   specify a PREFIX for output files\n\
 233   -o, --output=FILE          leave output to FILE\n\
 234   -g, --graph                also produce a VCG description of the automaton\n\
 235 "), stdout);
 236       putc ('\n', stdout);
 237
 238       fputs (_("\
 239 THINGS is a list of comma separated words that can include:\n\
 240   `state'        describe the states\n\
 241   `itemset'      complete the core item sets with their closure\n\
 242   `look-ahead'   explicitly associate look-ahead tokens to items\n\
 243   `solved'       describe shift/reduce conflicts solving\n\
 244   `all'          include all the above information\n\
 245   `none'         disable the report\n\
 246 "), stdout);
 247       putc ('\n', stdout);
 248
 249       fputs (_("\
 250 Report bugs to <bug-bison@gnu.org>.\n"), stdout);
 251     }
 252
 253   exit (status);
 254 }
 255
 256
 257 /*------------------------------.
 258 | Display the version message.  |
 259 `------------------------------*/
 260
 261 static void
 262 version (void)
 263 {
 264   /* Some efforts were made to ease the translators' task, please
 265      continue.  */
 266   printf (_("bison (GNU Bison) %s"), VERSION);
 267   putc ('\n', stdout);
 268   fputs (_("Written by Robert Corbett and Richard Stallman.\n"), stdout);
 269   putc ('\n', stdout);
 270
 271   fprintf (stdout,
 272            _("Copyright (C) %d Free Software Foundation, Inc.\n"), 2005);
 273
 274   fputs (_("\
 275 This is free software; see the source for copying conditions.  There is NO\n\
 276 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
 277 "),
 278          stdout);
 279 }
 280
 281
 282 /*----------------------.
 283 | Process the options.  |
 284 `----------------------*/
 285
 286 /* Shorts options.  */
 287 const char *short_options = "yvegdhr:ltknVo:b:p:S:T::";
 288
 289 /* Values for long options that do not have single-letter equivalents.  */
 290 enum
 291 {
 292   LOCATIONS_OPTION = CHAR_MAX + 1
 293 };
 294
 295 static struct option const long_options[] =
 296 {
 297   /* Operation modes. */
 298   { "help",          no_argument,               0,   'h' },
 299   { "version",       no_argument,               0,   'V' },
 300
 301   /* Parser. */
 302   { "name-prefix",   required_argument,   0,   'p' },
 303   { "include",       required_argument,   0,   'I' },
 304
 305   /* Output. */
 306   { "file-prefix", required_argument,   0,   'b' },
 307   { "output",      required_argument,   0,   'o' },
 308   { "output-file", required_argument,   0,   'o' },
 309   { "graph",       optional_argument,   0,   'g' },
 310   { "report",      required_argument,   0,   'r' },
 311   { "verbose",     no_argument,         0,   'v' },
 312
 313   /* Hidden. */
 314   { "trace",         optional_argument,   0,     'T' },
 315
 316   /* Output.  */
 317   { "defines",     optional_argument,   0,   'd' },
 318
 319   /* Operation modes.  */
 320   { "fixed-output-files", no_argument,  0,   'y' },
 321   { "yacc",               no_argument,  0,   'y' },
 322
 323   /* Parser.  */
 324   { "debug",          no_argument,               0,   't' },
 325   { "locations",      no_argument,               0, LOCATIONS_OPTION },
 326   { "no-lines",       no_argument,               0,   'l' },
 327   { "no-parser",      no_argument,               0,   'n' },
 328   { "raw",            no_argument,               0,     0 },
 329   { "skeleton",       required_argument,         0,   'S' },
 330   { "token-table",    no_argument,               0,   'k' },
 331
 332   {0, 0, 0, 0}
 333 };
 334
 335 /* Under DOS, there is no difference on the case.  This can be
 336    troublesome when looking for `.tab' etc.  */
 337 #ifdef MSDOS
 338 # define AS_FILE_NAME(File) (strlwr (File), (File))
 339 #else
 340 # define AS_FILE_NAME(File) (File)
 341 #endif
 342
 343 void
 344 getargs (int argc, char *argv[])
 345 {
 346   int c;
 347
 348   while ((c = getopt_long (argc, argv, short_options, long_options, NULL))
 349          != -1)
 350     switch (c)
 351       {
 352       case 0:
 353         /* Certain long options cause getopt_long to return 0.  */
 354         break;
 355
 356       case 'y':
 357         yacc_flag = true;
 358         break;
 359
 360       case 'h':
 361         usage (EXIT_SUCCESS);
 362
 363       case 'V':
 364         version ();
 365         exit (EXIT_SUCCESS);
 366
 367       case 'g':
 368         /* Here, the -g and --graph=FILE options are differentiated.  */
 369         graph_flag = true;
 370         if (optarg)
 371           spec_graph_file = AS_FILE_NAME (optarg);
 372         break;
 373
 374       case 'v':
 375         report_flag |= report_states;
 376         break;
 377
 378       case 'S':
 379         skeleton = AS_FILE_NAME (optarg);
 380         break;
 381
 382       case 'I':
 383         include = AS_FILE_NAME (optarg);
 384         break;
 385
 386       case 'd':
 387         /* Here, the -d and --defines options are differentiated.  */
 388         defines_flag = true;
 389         if (optarg)
 390           spec_defines_file = AS_FILE_NAME (optarg);
 391         break;
 392
 393       case 'l':
 394         no_lines_flag = true;
 395         break;
 396
 397       case LOCATIONS_OPTION:
 398         locations_flag = true;
 399         break;
 400
 401       case 'k':
 402         token_table_flag = true;
 403         break;
 404
 405       case 'n':
 406         no_parser_flag = true;
 407         break;
 408
 409       case 't':
 410         debug_flag = true;
 411         break;
 412
 413       case 'o':
 414         spec_outfile = AS_FILE_NAME (optarg);
 415         break;
 416
 417       case 'b':
 418         spec_file_prefix = AS_FILE_NAME (optarg);
 419         break;
 420
 421       case 'p':
 422         spec_name_prefix = optarg;
 423         break;
 424
 425       case 'r':
 426         report_argmatch (optarg);
 427         break;
 428
 429       case 'T':
 430         trace_argmatch (optarg);
 431         break;
 432
 433       default:
 434         usage (EXIT_FAILURE);
 435       }
 436
 437   if (argc - optind != 1)
 438     {
 439       if (argc - optind < 1)
 440         error (0, 0, _("missing operand after `%s'"), argv[argc - 1]);
 441       else
 442         error (0, 0, _("extra operand `%s'"), argv[optind + 1]);
 443       usage (EXIT_FAILURE);
 444     }
 445
 446   current_file = grammar_file = uniqstr_new (argv[optind]);
 447 }