src/getargs.c

   1 /* Parse command line arguments for Bison.
   2
   3    Copyright (C) 1984, 1986, 1989, 1992, 2000, 2001, 2002, 2003, 2004,
   4    2005, 2006 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 <config.h>
  24 #include "system.h"
  25 #include "revision.h"
  26
  27 #include <argmatch.h>
  28 #include <configmake.h>
  29 #include <error.h>
  30
  31 /* Hack to get <getopt.h> to declare getopt with a prototype.  */
  32 #if lint && ! defined __GNU_LIBRARY__
  33 # define __GNU_LIBRARY__
  34 # define HACK_FOR___GNU_LIBRARY___PROTOTYPE 1
  35 #endif
  36
  37 #include <getopt.h>
  38
  39 #ifdef HACK_FOR___GNU_LIBRARY___PROTOTYPE
  40 # undef __GNU_LIBRARY__
  41 # undef HACK_FOR___GNU_LIBRARY___PROTOTYPE
  42 #endif
  43
  44 #include "complain.h"
  45 #include "files.h"
  46 #include "getargs.h"
  47 #include "uniqstr.h"
  48
  49 bool debug_flag;
  50 bool defines_flag;
  51 bool graph_flag;
  52 bool locations_flag;
  53 bool no_lines_flag;
  54 bool no_parser_flag;
  55 bool token_table_flag;
  56 bool yacc_flag; /* for -y */
  57
  58 bool error_verbose = false;
  59
  60 bool nondeterministic_parser = false;
  61 bool glr_parser = false;
  62 bool pure_parser = false;
  63 bool push_parser = false;
  64
  65 int report_flag = report_none;
  66 int trace_flag = trace_none;
  67 int warnings_flag = warnings_none;
  68
  69 static struct bison_language const valid_languages[] = {
  70   { "c", "c-skel.m4", ".c", ".h", true },
  71   { "c++", "c++-skel.m4", ".cc", ".hh", true },
  72   { "", "", "", "", false }
  73 };
  74
  75 static int skeleton_prio = 2;
  76 const char *skeleton = NULL;
  77 static int language_prio = 2;
  78 struct bison_language const *language = &valid_languages[0];
  79 const char *include = NULL;
  80
  81 char *program_name;
  82
  83
  84 /** Decode an option's set of keys.
  85  *
  86  *  \param option   option being decoded.
  87  *  \param keys     array of valid subarguments.
  88  *  \param values   array of corresponding (int) values.
  89  *  \param flags    the flags to update
  90  *  \param args     colon separated list of effective subarguments to decode.
  91  *                  If 0, then activate all the flags.
  92  *
  93  *  The special value 0 resets the flags to 0.
  94  */
  95 static void
  96 flags_argmatch (const char *option,
  97                 const char * const keys[], const int values[],
  98                 int *flags, char *args)
  99 {
 100   if (args)
 101     {
 102       args = strtok (args, ",");
 103       while (args)
 104         {
 105           int value = XARGMATCH (option, args, keys, values);
 106           if (value == 0)
 107             *flags = 0;
 108           else
 109             *flags |= value;
 110           args = strtok (NULL, ",");
 111         }
 112     }
 113   else
 114     *flags = ~0;
 115 }
 116
 117 /** Decode a set of sub arguments.
 118  *
 119  *  \param FlagName  the flag familly to update.
 120  *  \param Args      the effective sub arguments to decode.
 121  *
 122  *  \arg FlagName_args   the list of keys.
 123  *  \arg FlagName_types  the list of values.
 124  *  \arg FlagName_flag   the flag to update.
 125  */
 126 #define FLAGS_ARGMATCH(FlagName, Args)                                  \
 127   flags_argmatch ("--" #FlagName, FlagName ## _args, FlagName ## _types, \
 128                   &FlagName ## _flag, Args)
 129
 130
 131 /*----------------------.
 132 | --report's handling.  |
 133 `----------------------*/
 134
 135 static const char * const report_args[] =
 136 {
 137   /* In a series of synonyms, present the most meaningful first, so
 138      that argmatch_valid be more readable.  */
 139   "none",
 140   "state", "states",
 141   "itemset", "itemsets",
 142   "lookahead", "lookaheads", "look-ahead",
 143   "solved",
 144   "all",
 145   0
 146 };
 147
 148 static const int report_types[] =
 149 {
 150   report_none,
 151   report_states, report_states,
 152   report_states | report_itemsets, report_states | report_itemsets,
 153   report_states | report_lookahead_tokens,
 154   report_states | report_lookahead_tokens,
 155   report_states | report_lookahead_tokens,
 156   report_states | report_solved_conflicts,
 157   report_all
 158 };
 159
 160 ARGMATCH_VERIFY (report_args, report_types);
 161
 162
 163 /*---------------------.
 164 | --trace's handling.  |
 165 `---------------------*/
 166
 167 static const char * const trace_args[] =
 168 {
 169   /* In a series of synonyms, present the most meaningful first, so
 170      that argmatch_valid be more readable.  */
 171   "none       - no traces",
 172   "scan       - grammar scanner traces",
 173   "parse      - grammar parser traces",
 174   "automaton  - construction of the automaton",
 175   "bitsets    - use of bitsets",
 176   "grammar    - reading, reducing the grammar",
 177   "resource   - memory consumption (where available)",
 178   "sets       - grammar sets: firsts, nullable etc.",
 179   "tools      - m4 invocation",
 180   "m4         - m4 traces",
 181   "skeleton   - skeleton postprocessing",
 182   "time       - time consumption",
 183   "all        - all of the above",
 184   0
 185 };
 186
 187 static const int trace_types[] =
 188 {
 189   trace_none,
 190   trace_scan,
 191   trace_parse,
 192   trace_automaton,
 193   trace_bitsets,
 194   trace_grammar,
 195   trace_resource,
 196   trace_sets,
 197   trace_tools,
 198   trace_m4,
 199   trace_skeleton,
 200   trace_time,
 201   trace_all
 202 };
 203
 204 ARGMATCH_VERIFY (trace_args, trace_types);
 205
 206
 207 /*------------------------.
 208 | --warnings's handling.  |
 209 `------------------------*/
 210
 211 static const char * const warnings_args[] =
 212 {
 213   /* In a series of synonyms, present the most meaningful first, so
 214      that argmatch_valid be more readable.  */
 215   "none            - no warnings",
 216   "midrule-values  - unset or unused midrule values",
 217   "yacc            - incompatibilities with POSIX YACC",
 218   "all             - all of the above",
 219   "error           - warnings are errors",
 220   0
 221 };
 222
 223 static const int warnings_types[] =
 224 {
 225   warnings_none,
 226   warnings_midrule_values,
 227   warnings_yacc,
 228   warnings_all,
 229   warnings_error
 230 };
 231
 232 ARGMATCH_VERIFY (warnings_args, warnings_types);
 233
 234
 235 /*-------------------------------------------.
 236 | Display the help message and exit STATUS.  |
 237 `-------------------------------------------*/
 238
 239 static void usage (int) ATTRIBUTE_NORETURN;
 240
 241 static void
 242 usage (int status)
 243 {
 244   if (status != 0)
 245     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 246              program_name);
 247   else
 248     {
 249       printf (_("Usage: %s [OPTION]... FILE\n"), program_name);
 250       fputs (_("\
 251 Generate LALR(1) and GLR parsers.\n\
 252 \n\
 253 "), stdout);
 254
 255       fputs (_("\
 256 Mandatory arguments to long options are mandatory for short options too.\n\
 257 "), stdout);
 258
 259       fputs (_("\
 260 \n\
 261 Operation modes:\n\
 262   -h, --help                 display this help and exit\n\
 263   -V, --version              output version information and exit\n\
 264       --print-localedir      output directory containing locale-dependent data\n\
 265   -y, --yacc                 emulate POSIX Yacc\n\
 266 \n\
 267 "), stdout);
 268
 269       fputs (_("\
 270 Parser:\n\
 271   -S, --skeleton=FILE        specify the skeleton to use\n\
 272   -t, --debug                instrument the parser for debugging\n\
 273       --locations            enable locations computation\n\
 274   -p, --name-prefix=PREFIX   prepend PREFIX to the external symbols\n\
 275   -l, --no-lines             don't generate `#line' directives\n\
 276   -n, --no-parser            generate the tables only\n\
 277   -k, --token-table          include a table of token names\n\
 278 \n\
 279 "), stdout);
 280
 281       fputs (_("\
 282 Output:\n\
 283   -d, --defines              also produce a header file\n\
 284   -r, --report=THINGS        also produce details on the automaton\n\
 285   -v, --verbose              same as `--report=state'\n\
 286   -b, --file-prefix=PREFIX   specify a PREFIX for output files\n\
 287   -o, --output=FILE          leave output to FILE\n\
 288   -g, --graph                also output a graph of the automaton\n\
 289 \n\
 290 "), stdout);
 291
 292       fputs (_("\
 293 THINGS is a list of comma separated words that can include:\n\
 294   `state'        describe the states\n\
 295   `itemset'      complete the core item sets with their closure\n\
 296   `lookahead'    explicitly associate lookahead tokens to items\n\
 297   `solved'       describe shift/reduce conflicts solving\n\
 298   `all'          include all the above information\n\
 299   `none'         disable the report\n\
 300 "), stdout);
 301
 302       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 303     }
 304
 305   exit (status);
 306 }
 307
 308
 309 /*------------------------------.
 310 | Display the version message.  |
 311 `------------------------------*/
 312
 313 static void
 314 version (void)
 315 {
 316   /* Some efforts were made to ease the translators' task, please
 317      continue.  */
 318   printf (_("bison (GNU Bison) %s"), VERSION);
 319   putc ('\n', stdout);
 320   printf ("%s", revision);
 321   fputs (_("Written by Robert Corbett and Richard Stallman.\n"), stdout);
 322   putc ('\n', stdout);
 323
 324   fprintf (stdout,
 325            _("Copyright (C) %d Free Software Foundation, Inc.\n"), 2006);
 326
 327   fputs (_("\
 328 This is free software; see the source for copying conditions.  There is NO\n\
 329 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
 330 "),
 331          stdout);
 332 }
 333
 334
 335 /*-------------------------------------.
 336 | --skeleton and --language handling.  |
 337 `--------------------------------------*/
 338
 339 void
 340 skeleton_arg (char const *arg, int prio, location const *loc)
 341 {
 342   if (prio < skeleton_prio)
 343     {
 344       skeleton_prio = prio;
 345       skeleton = arg;
 346     }
 347   else if (prio == skeleton_prio)
 348     {
 349       char const *msg =
 350         _("multiple skeleton declarations are invalid");
 351       if (loc)
 352         complain_at (*loc, msg);
 353       else
 354         complain (msg);
 355     }
 356 }
 357
 358 void
 359 language_argmatch (char const *arg, int prio, location const *loc)
 360 {
 361   char const *msg;
 362
 363   if (prio < language_prio)
 364     {
 365       int i;
 366       for (i = 0; valid_languages[i].language[0]; i++)
 367         if (strcasecmp (arg, valid_languages[i].language) == 0)
 368           {
 369             language_prio = prio;
 370             language = &valid_languages[i];
 371             return;
 372           }
 373       msg = _("invalid language `%s'");
 374     }
 375   else if (language_prio == prio)
 376     msg = _("multiple language declarations are invalid");
 377   else
 378     return;
 379
 380   if (loc)
 381     complain_at (*loc, msg, arg);
 382   else
 383     complain (msg, arg);
 384 }
 385
 386 /*----------------------.
 387 | Process the options.  |
 388 `----------------------*/
 389
 390 /* Shorts options.  */
 391 static char const short_options[] = "yvegdhr:L:ltknVo:b:p:S:T::W";
 392
 393 /* Values for long options that do not have single-letter equivalents.  */
 394 enum
 395 {
 396   LOCATIONS_OPTION = CHAR_MAX + 1,
 397   PRINT_LOCALEDIR_OPTION
 398 };
 399
 400 static struct option const long_options[] =
 401 {
 402   /* Operation modes. */
 403   { "help",            no_argument,       0,   'h' },
 404   { "version",         no_argument,       0,   'V' },
 405   { "print-localedir", no_argument,       0,   PRINT_LOCALEDIR_OPTION },
 406   { "warnings",        optional_argument, 0,   'W' },
 407
 408   /* Parser. */
 409   { "name-prefix",   required_argument,   0,   'p' },
 410   { "include",       required_argument,   0,   'I' },
 411
 412   /* Output. */
 413   { "file-prefix", required_argument,   0,   'b' },
 414   { "output",      required_argument,   0,   'o' },
 415   { "output-file", required_argument,   0,   'o' },
 416   { "graph",       optional_argument,   0,   'g' },
 417   { "report",      required_argument,   0,   'r' },
 418   { "verbose",     no_argument,         0,   'v' },
 419
 420   /* Hidden. */
 421   { "trace",         optional_argument,   0,     'T' },
 422
 423   /* Output.  */
 424   { "defines",     optional_argument,   0,   'd' },
 425
 426   /* Operation modes.  */
 427   { "fixed-output-files", no_argument,  0,   'y' },
 428   { "yacc",               no_argument,  0,   'y' },
 429
 430   /* Parser.  */
 431   { "debug",          no_argument,               0,   't' },
 432   { "locations",      no_argument,               0, LOCATIONS_OPTION },
 433   { "no-lines",       no_argument,               0,   'l' },
 434   { "no-parser",      no_argument,               0,   'n' },
 435   { "raw",            no_argument,               0,     0 },
 436   { "skeleton",       required_argument,         0,   'S' },
 437   { "language",       required_argument,         0,   'L' },
 438   { "token-table",    no_argument,               0,   'k' },
 439
 440   {0, 0, 0, 0}
 441 };
 442
 443 /* Under DOS, there is no difference on the case.  This can be
 444    troublesome when looking for `.tab' etc.  */
 445 #ifdef MSDOS
 446 # define AS_FILE_NAME(File) (strlwr (File), (File))
 447 #else
 448 # define AS_FILE_NAME(File) (File)
 449 #endif
 450
 451 void
 452 getargs (int argc, char *argv[])
 453 {
 454   int c;
 455
 456   while ((c = getopt_long (argc, argv, short_options, long_options, NULL))
 457          != -1)
 458     switch (c)
 459       {
 460       case 0:
 461         /* Certain long options cause getopt_long to return 0.  */
 462         break;
 463
 464       case 'b':
 465         spec_file_prefix = AS_FILE_NAME (optarg);
 466         break;
 467
 468       case 'g':
 469         /* Here, the -g and --graph=FILE options are differentiated.  */
 470         graph_flag = true;
 471         if (optarg)
 472           spec_graph_file = xstrdup (AS_FILE_NAME (optarg));
 473         break;
 474
 475       case 'h':
 476         usage (EXIT_SUCCESS);
 477
 478       case 'L':
 479         language_argmatch (optarg, 0, NULL);
 480         break;
 481
 482       case 'S':
 483         skeleton_arg (AS_FILE_NAME (optarg), 0, NULL);
 484         break;
 485
 486       case 'I':
 487         include = AS_FILE_NAME (optarg);
 488         break;
 489
 490       case 'd':
 491         /* Here, the -d and --defines options are differentiated.  */
 492         defines_flag = true;
 493         if (optarg)
 494           spec_defines_file = xstrdup (AS_FILE_NAME (optarg));
 495         break;
 496
 497       case 'k':
 498         token_table_flag = true;
 499         break;
 500
 501       case 'l':
 502         no_lines_flag = true;
 503         break;
 504
 505       case 'n':
 506         no_parser_flag = true;
 507         break;
 508
 509       case 'o':
 510         spec_outfile = AS_FILE_NAME (optarg);
 511         break;
 512
 513       case 'p':
 514         spec_name_prefix = optarg;
 515         break;
 516
 517       case 'r':
 518         FLAGS_ARGMATCH (report, optarg);
 519         break;
 520
 521       case 'T':
 522         FLAGS_ARGMATCH (trace, optarg);
 523         break;
 524
 525       case 't':
 526         debug_flag = true;
 527         break;
 528
 529       case 'V':
 530         version ();
 531         exit (EXIT_SUCCESS);
 532
 533       case 'v':
 534         report_flag |= report_states;
 535         break;
 536
 537       case 'y':
 538         yacc_flag = true;
 539         break;
 540
 541       case 'W':
 542         if (optarg)
 543           FLAGS_ARGMATCH (warnings, optarg);
 544         else
 545           warnings_flag |= warnings_all;
 546         break;
 547
 548       case LOCATIONS_OPTION:
 549         locations_flag = true;
 550         break;
 551
 552       case PRINT_LOCALEDIR_OPTION:
 553         printf ("%s\n", LOCALEDIR);
 554         exit (EXIT_SUCCESS);
 555
 556       default:
 557         usage (EXIT_FAILURE);
 558       }
 559
 560   if (argc - optind != 1)
 561     {
 562       if (argc - optind < 1)
 563         error (0, 0, _("missing operand after `%s'"), argv[argc - 1]);
 564       else
 565         error (0, 0, _("extra operand `%s'"), argv[optind + 1]);
 566       usage (EXIT_FAILURE);
 567     }
 568
 569   current_file = grammar_file = uniqstr_new (argv[optind]);
 570 }