src/getargs.c

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