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