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