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