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
 258       fputs (_("\
 259 \n\
 260 Operation modes:\n\
 261   -h, --help                 display this help and exit\n\
 262   -V, --version              output version information and exit\n\
 263       --print-localedir      output directory containing locale-dependent data\n\
 264       --print-datadir        output directory containing skeletons and XSLT\n\
 265   -y, --yacc                 emulate POSIX Yacc\n\
 266   -W, --warnings=[CATEGORY]  report the warnings falling in CATEGORY\n\
 267 \n\
 268 "), stdout);
 269
 270       fputs (_("\
 271 Parser:\n\
 272   -L, --language=LANGUAGE    specify the output programming language\n\
 273   -S, --skeleton=FILE        specify the skeleton to use\n\
 274   -t, --debug                instrument the parser for debugging\n\
 275       --locations            enable locations computation\n\
 276   -p, --name-prefix=PREFIX   prepend PREFIX to the external symbols\n\
 277   -l, --no-lines             don't generate `#line' directives\n\
 278   -k, --token-table          include a table of token names\n\
 279 \n\
 280 "), stdout);
 281
 282       fputs (_("\
 283 Output:\n\
 284   -d, --defines[=FILE]       also produce a header file\n\
 285   -r, --report=THINGS        also produce details on the automaton\n\
 286       --report-file=FILE     write report to FILE\n\
 287   -v, --verbose              same as `--report=state'\n\
 288   -b, --file-prefix=PREFIX   specify a PREFIX for output files\n\
 289   -o, --output=FILE          leave output to FILE\n\
 290   -g, --graph[=FILE]         also output a graph of the automaton\n\
 291   -x, --xml[=FILE]           also output an XML report of the automaton\n\
 292                              (the XML schema is experimental)\n\
 293 \n\
 294 "), stdout);
 295
 296       fputs (_("\
 297 Warning categories include:\n\
 298   `midrule-values'  unset or unused midrule values\n\
 299   `yacc'            incompatibilities with POSIX YACC\n\
 300   `all'             all the warnings\n\
 301   `no-CATEGORY'     turn off warnings in CATEGORY\n\
 302   `none'            turn off all the warnings\n\
 303   `error'           treat warnings as errors\n\
 304 \n\
 305 "), stdout);
 306
 307       fputs (_("\
 308 THINGS is a list of comma separated words that can include:\n\
 309   `state'        describe the states\n\
 310   `itemset'      complete the core item sets with their closure\n\
 311   `lookahead'    explicitly associate lookahead tokens to items\n\
 312   `solved'       describe shift/reduce conflicts solving\n\
 313   `all'          include all the above information\n\
 314   `none'         disable the report\n\
 315 "), stdout);
 316
 317       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 318     }
 319
 320   exit (status);
 321 }
 322
 323
 324 /*------------------------------.
 325 | Display the version message.  |
 326 `------------------------------*/
 327
 328 static void
 329 version (void)
 330 {
 331   /* Some efforts were made to ease the translators' task, please
 332      continue.  */
 333   printf (_("bison (GNU Bison) %s"), VERSION);
 334   putc ('\n', stdout);
 335   printf ("%s", revision);
 336   fputs (_("Written by Robert Corbett and Richard Stallman.\n"), stdout);
 337   putc ('\n', stdout);
 338
 339   fprintf (stdout,
 340            _("Copyright (C) %d Free Software Foundation, Inc.\n"),
 341            PACKAGE_COPYRIGHT_YEAR);
 342
 343   fputs (_("\
 344 This is free software; see the source for copying conditions.  There is NO\n\
 345 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
 346 "),
 347          stdout);
 348 }
 349
 350
 351 /*-------------------------------------.
 352 | --skeleton and --language handling.  |
 353 `--------------------------------------*/
 354
 355 void
 356 skeleton_arg (char const *arg, int prio, location const *loc)
 357 {
 358   if (prio < skeleton_prio)
 359     {
 360       skeleton_prio = prio;
 361       skeleton = arg;
 362     }
 363   else if (prio == skeleton_prio)
 364     {
 365       char const *msg =
 366         _("multiple skeleton declarations are invalid");
 367       if (loc)
 368         complain_at (*loc, msg);
 369       else
 370         complain (msg);
 371     }
 372 }
 373
 374 void
 375 language_argmatch (char const *arg, int prio, location const *loc)
 376 {
 377   char const *msg;
 378
 379   if (prio < language_prio)
 380     {
 381       int i;
 382       for (i = 0; valid_languages[i].language[0]; i++)
 383         if (c_strcasecmp (arg, valid_languages[i].language) == 0)
 384           {
 385             language_prio = prio;
 386             language = &valid_languages[i];
 387             return;
 388           }
 389       msg = _("invalid language `%s'");
 390     }
 391   else if (language_prio == prio)
 392     msg = _("multiple language declarations are invalid");
 393   else
 394     return;
 395
 396   if (loc)
 397     complain_at (*loc, msg, arg);
 398   else
 399     complain (msg, arg);
 400 }
 401
 402 /*----------------------.
 403 | Process the options.  |
 404 `----------------------*/
 405
 406 /* Shorts options.
 407    Should be computed from long_options.  */
 408 static char const short_options[] =
 409   "L:"
 410   "S:"
 411   "T::"
 412   "V"
 413   "W"
 414   "b:"
 415   "d"
 416   "e"
 417   "g::"
 418   "h"
 419   "k"
 420   "l"
 421   "n"
 422   "o:"
 423   "p:"
 424   "r:"
 425   "t"
 426   "v"
 427   "x::"
 428   "y"
 429   ;
 430
 431 /* Values for long options that do not have single-letter equivalents.  */
 432 enum
 433 {
 434   LOCATIONS_OPTION = CHAR_MAX + 1,
 435   PRINT_LOCALEDIR_OPTION,
 436   PRINT_DATADIR_OPTION,
 437   REPORT_FILE_OPTION
 438 };
 439
 440 static struct option const long_options[] =
 441 {
 442   /* Operation modes. */
 443   { "help",            no_argument,       0,   'h' },
 444   { "version",         no_argument,       0,   'V' },
 445   { "print-localedir", no_argument,       0,   PRINT_LOCALEDIR_OPTION },
 446   { "print-datadir",   no_argument,       0,   PRINT_DATADIR_OPTION   },
 447   { "warnings",        optional_argument, 0,   'W' },
 448
 449   /* Parser. */
 450   { "name-prefix",   required_argument,   0,   'p' },
 451   { "include",       required_argument,   0,   'I' },
 452
 453   /* Output. */
 454   { "file-prefix", required_argument,   0,   'b' },
 455   { "output",      required_argument,   0,   'o' },
 456   { "output-file", required_argument,   0,   'o' },
 457   { "graph",       optional_argument,   0,   'g' },
 458   { "xml",         optional_argument,   0,   'x' },
 459   { "report",      required_argument,   0,   'r' },
 460   { "report-file", required_argument,   0,   REPORT_FILE_OPTION },
 461   { "verbose",     no_argument,         0,   'v' },
 462
 463   /* Hidden. */
 464   { "trace",         optional_argument,   0,     'T' },
 465
 466   /* Output.  */
 467   { "defines",     optional_argument,   0,   'd' },
 468
 469   /* Operation modes.  */
 470   { "fixed-output-files", no_argument,  0,   'y' },
 471   { "yacc",               no_argument,  0,   'y' },
 472
 473   /* Parser.  */
 474   { "debug",          no_argument,               0,   't' },
 475   { "locations",      no_argument,               0, LOCATIONS_OPTION },
 476   { "no-lines",       no_argument,               0,   'l' },
 477   { "raw",            no_argument,               0,     0 },
 478   { "skeleton",       required_argument,         0,   'S' },
 479   { "language",       required_argument,         0,   'L' },
 480   { "token-table",    no_argument,               0,   'k' },
 481
 482   {0, 0, 0, 0}
 483 };
 484
 485 /* Under DOS, there is no difference on the case.  This can be
 486    troublesome when looking for `.tab' etc.  */
 487 #ifdef MSDOS
 488 # define AS_FILE_NAME(File) (strlwr (File), (File))
 489 #else
 490 # define AS_FILE_NAME(File) (File)
 491 #endif
 492
 493 void
 494 getargs (int argc, char *argv[])
 495 {
 496   int c;
 497
 498   while ((c = getopt_long (argc, argv, short_options, long_options, NULL))
 499          != -1)
 500     switch (c)
 501       {
 502       case 0:
 503         /* Certain long options cause getopt_long to return 0.  */
 504         break;
 505
 506       case 'b':
 507         spec_file_prefix = AS_FILE_NAME (optarg);
 508         break;
 509
 510       case 'g':
 511         /* Here, the -g and --graph=FILE options are differentiated.  */
 512         graph_flag = true;
 513         if (optarg)
 514           spec_graph_file = xstrdup (AS_FILE_NAME (optarg));
 515         break;
 516
 517       case 'x':
 518         /* Here, the -x and --xml=FILE options are differentiated.  */
 519         xml_flag = true;
 520         if (optarg)
 521           spec_xml_file = xstrdup (AS_FILE_NAME (optarg));
 522         break;
 523
 524       case 'h':
 525         usage (EXIT_SUCCESS);
 526
 527       case 'L':
 528         language_argmatch (optarg, 0, NULL);
 529         break;
 530
 531       case 'S':
 532         skeleton_arg (AS_FILE_NAME (optarg), 0, NULL);
 533         break;
 534
 535       case 'I':
 536         include = AS_FILE_NAME (optarg);
 537         break;
 538
 539       case 'd':
 540         /* Here, the -d and --defines options are differentiated.  */
 541         defines_flag = true;
 542         if (optarg)
 543           spec_defines_file = xstrdup (AS_FILE_NAME (optarg));
 544         break;
 545
 546       case 'k':
 547         token_table_flag = true;
 548         break;
 549
 550       case 'l':
 551         no_lines_flag = true;
 552         break;
 553
 554       case 'o':
 555         spec_outfile = AS_FILE_NAME (optarg);
 556         break;
 557
 558       case 'p':
 559         spec_name_prefix = optarg;
 560         break;
 561
 562       case 'r':
 563         FLAGS_ARGMATCH (report, optarg);
 564         break;
 565
 566       case REPORT_FILE_OPTION:
 567         spec_verbose_file = xstrdup (AS_FILE_NAME (optarg));
 568         break;
 569
 570       case 'T':
 571         FLAGS_ARGMATCH (trace, optarg);
 572         break;
 573
 574       case 't':
 575         debug_flag = true;
 576         break;
 577
 578       case 'V':
 579         version ();
 580         exit (EXIT_SUCCESS);
 581
 582       case 'v':
 583         report_flag |= report_states;
 584         break;
 585
 586       case 'y':
 587         yacc_flag = true;
 588         break;
 589
 590       case 'W':
 591         if (optarg)
 592           FLAGS_ARGMATCH (warnings, optarg);
 593         else
 594           warnings_flag |= warnings_all;
 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       default:
 610         usage (EXIT_FAILURE);
 611       }
 612
 613   if (argc - optind != 1)
 614     {
 615       if (argc - optind < 1)
 616         error (0, 0, _("missing operand after `%s'"), argv[argc - 1]);
 617       else
 618         error (0, 0, _("extra operand `%s'"), argv[optind + 1]);
 619       usage (EXIT_FAILURE);
 620     }
 621
 622   current_file = grammar_file = uniqstr_new (argv[optind]);
 623 }