src/getargs.c

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