src/getargs.c

   1 /* Parse command line arguments for Bison.
   2
   3    Copyright (C) 1984, 1986, 1989, 1992, 2000-2012 Free Software
   4    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 "output.h"
  24
  25 #include <argmatch.h>
  26 #include <c-strcase.h>
  27 #include <configmake.h>
  28 #include <error.h>
  29 #include <getopt.h>
  30 #include <progname.h>
  31
  32 #include "complain.h"
  33 #include "files.h"
  34 #include "getargs.h"
  35 #include "muscle-tab.h"
  36 #include "quote.h"
  37 #include "uniqstr.h"
  38
  39 bool defines_flag;
  40 bool graph_flag;
  41 bool xml_flag;
  42 bool no_lines_flag;
  43 bool token_table_flag;
  44 bool yacc_flag; /* for -y */
  45
  46 bool nondeterministic_parser = false;
  47 bool glr_parser = false;
  48
  49 int report_flag = report_none;
  50 int trace_flag = trace_none;
  51
  52 static struct bison_language const valid_languages[] = {
  53   { "c", "c-skel.m4", ".c", ".h", true },
  54   { "c++", "c++-skel.m4", ".cc", ".hh", true },
  55   { "java", "java-skel.m4", ".java", ".java", false },
  56   { "", "", "", "", false }
  57 };
  58
  59 int skeleton_prio = default_prio;
  60 const char *skeleton = NULL;
  61 int language_prio = default_prio;
  62 struct bison_language const *language = &valid_languages[0];
  63 const char *include = NULL;
  64
  65
  66 /** Decode an option's set of keys.
  67  *
  68  *  \param option   option being decoded.
  69  *  \param keys     array of valid subarguments.
  70  *  \param values   array of corresponding (int) values.
  71  *  \param all      the all value.
  72  *  \param flags    the flags to update
  73  *  \param args     comma separated list of effective subarguments to decode.
  74  *                  If 0, then activate all the flags.
  75  *
  76  *  If VALUE != 0 then KEY sets flags and no-KEY clears them.
  77  *  If VALUE == 0 then KEY clears all flags from \c all and no-KEY sets all
  78  *  flags from \c all.  Thus no-none = all and no-all = none.
  79  */
  80 static void
  81 flags_argmatch (const char *option,
  82                 const char * const keys[], const int values[],
  83                 int all, int *flags, char *args)
  84 {
  85   if (args)
  86   {
  87     args = strtok (args, ",");
  88     while (args)
  89     {
  90       int value = all;
  91       int *save_flags = flags;
  92       int no = STRPREFIX_LIT ("no-", args) ? 3 : 0;
  93       int err = STRPREFIX_LIT ("error", args + no) ? 5 : 0;
  94
  95       if (err)
  96         flags = &errors_flag;
  97       if (!err || args[no + err++] != '\0')
  98         value = XARGMATCH (option, args + no + err, keys, values);
  99
 100         if (!value)
 101         {
 102           if (no)
 103             *flags |= all;
 104           else
 105              *flags &= ~all;
 106         }
 107         else
 108         {
 109           if (no)
 110             *flags &= ~value;
 111           else
 112           {
 113             if (err)
 114               warnings_flag |= value;
 115            *flags |= value;
 116           }
 117         }
 118       flags = save_flags;
 119       args = strtok (NULL, ",");
 120     }
 121   }
 122   else
 123     *flags |= all;
 124 }
 125
 126 /** Decode a set of sub arguments.
 127  *
 128  *  \param FlagName  the flag familly to update.
 129  *  \param Args      the effective sub arguments to decode.
 130  *  \param All       the "all" value.
 131  *
 132  *  \arg FlagName_args   the list of keys.
 133  *  \arg FlagName_types  the list of values.
 134  *  \arg FlagName_flag   the flag to update.
 135  */
 136 #define FLAGS_ARGMATCH(FlagName, Args, All)                             \
 137   flags_argmatch ("--" #FlagName, FlagName ## _args, FlagName ## _types, \
 138                   All, &FlagName ## _flag, Args)
 139
 140
 141 /*----------------------.
 142 | --report's handling.  |
 143 `----------------------*/
 144
 145 static const char * const report_args[] =
 146 {
 147   /* In a series of synonyms, present the most meaningful first, so
 148      that argmatch_valid be more readable.  */
 149   "none",
 150   "state", "states",
 151   "itemset", "itemsets",
 152   "lookahead", "lookaheads", "look-ahead",
 153   "solved",
 154   "all",
 155   0
 156 };
 157
 158 static const int report_types[] =
 159 {
 160   report_none,
 161   report_states, report_states,
 162   report_states | report_itemsets, report_states | report_itemsets,
 163   report_states | report_lookahead_tokens,
 164   report_states | report_lookahead_tokens,
 165   report_states | report_lookahead_tokens,
 166   report_states | report_solved_conflicts,
 167   report_all
 168 };
 169
 170 ARGMATCH_VERIFY (report_args, report_types);
 171
 172
 173 /*---------------------.
 174 | --trace's handling.  |
 175 `---------------------*/
 176
 177 static const char * const trace_args[] =
 178 {
 179   /* In a series of synonyms, present the most meaningful first, so
 180      that argmatch_valid be more readable.  */
 181   "none       - no traces",
 182   "scan       - grammar scanner traces",
 183   "parse      - grammar parser traces",
 184   "automaton  - construction of the automaton",
 185   "bitsets    - use of bitsets",
 186   "grammar    - reading, reducing the grammar",
 187   "resource   - memory consumption (where available)",
 188   "sets       - grammar sets: firsts, nullable etc.",
 189   "muscles    - m4 definitions passed to the skeleton",
 190   "tools      - m4 invocation",
 191   "m4         - m4 traces",
 192   "skeleton   - skeleton postprocessing",
 193   "time       - time consumption",
 194   "ielr       - IELR conversion",
 195   "all        - all of the above",
 196   0
 197 };
 198
 199 static const int trace_types[] =
 200 {
 201   trace_none,
 202   trace_scan,
 203   trace_parse,
 204   trace_automaton,
 205   trace_bitsets,
 206   trace_grammar,
 207   trace_resource,
 208   trace_sets,
 209   trace_muscles,
 210   trace_tools,
 211   trace_m4,
 212   trace_skeleton,
 213   trace_time,
 214   trace_ielr,
 215   trace_all
 216 };
 217
 218 ARGMATCH_VERIFY (trace_args, trace_types);
 219
 220
 221 /*------------------------.
 222 | --warnings's handling.  |
 223 `------------------------*/
 224
 225 static const char * const warnings_args[] =
 226 {
 227   /* In a series of synonyms, present the most meaningful first, so
 228      that argmatch_valid be more readable.  */
 229   "none            - no warnings",
 230   "midrule-values  - unset or unused midrule values",
 231   "yacc            - incompatibilities with POSIX Yacc",
 232   "conflicts-sr    - S/R conflicts",
 233   "conflicts-rr    - R/R conflicts",
 234   "deprecated      - obsolete constructs",
 235   "other           - all other warnings",
 236   "all             - all of the above",
 237   "error           - warnings are errors",
 238   0
 239 };
 240
 241 static const int warnings_types[] =
 242 {
 243   Wnone,
 244   Wmidrule_values,
 245   Wyacc,
 246   Wconflicts_sr,
 247   Wconflicts_rr,
 248   Wdeprecated,
 249   Wother,
 250   Wall,
 251   Werror
 252 };
 253
 254 ARGMATCH_VERIFY (warnings_args, warnings_types);
 255
 256 /*-------------------------------------------.
 257 | Display the help message and exit STATUS.  |
 258 `-------------------------------------------*/
 259
 260 static void usage (int) ATTRIBUTE_NORETURN;
 261
 262 static void
 263 usage (int status)
 264 {
 265   if (status != 0)
 266     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 267              program_name);
 268   else
 269     {
 270       /* For ../build-aux/cross-options.pl to work, use the format:
 271                 ^  -S, --long[=ARGS] (whitespace)
 272          A --long option is required.
 273          Otherwise, add exceptions to ../build-aux/cross-options.pl.  */
 274
 275       printf (_("Usage: %s [OPTION]... FILE\n"), program_name);
 276       fputs (_("\
 277 Generate a deterministic LR or generalized LR (GLR) parser employing\n\
 278 LALR(1), IELR(1), or canonical LR(1) parser tables.  IELR(1) and\n\
 279 canonical LR(1) support is experimental.\n\
 280 \n\
 281 "), stdout);
 282
 283       fputs (_("\
 284 Mandatory arguments to long options are mandatory for short options too.\n\
 285 "), stdout);
 286       fputs (_("\
 287 The same is true for optional arguments.\n\
 288 "), stdout);
 289
 290       fputs (_("\
 291 \n\
 292 Operation modes:\n\
 293   -h, --help                 display this help and exit\n\
 294   -V, --version              output version information and exit\n\
 295       --print-localedir      output directory containing locale-dependent data\n\
 296       --print-datadir        output directory containing skeletons and XSLT\n\
 297   -y, --yacc                 emulate POSIX Yacc\n\
 298   -W, --warnings[=CATEGORY]  report the warnings falling in CATEGORY\n\
 299 \n\
 300 "), stdout);
 301
 302       fputs (_("\
 303 Parser:\n\
 304   -L, --language=LANGUAGE          specify the output programming language\n\
 305                                    (this is an experimental feature)\n\
 306   -S, --skeleton=FILE              specify the skeleton to use\n\
 307   -t, --debug                      instrument the parser for tracing\n\
 308                                    same as `-Dparse.trace'\n\
 309       --locations                  enable location support\n\
 310   -D, --define=NAME[=VALUE]        similar to '%define NAME \"VALUE\"'\n\
 311   -F, --force-define=NAME[=VALUE]  override '%define NAME \"VALUE\"'\n\
 312   -p, --name-prefix=PREFIX         prepend PREFIX to the external symbols\n\
 313                                    deprecated by '-Dapi.prefix=PREFIX'\n\
 314   -l, --no-lines                   don't generate '#line' directives\n\
 315   -k, --token-table                include a table of token names\n\
 316 \n\
 317 "), stdout);
 318
 319       /* Keep -d and --defines separate so that ../build-aux/cross-options.pl
 320        * won't assume that -d also takes an argument.  */
 321       fputs (_("\
 322 Output:\n\
 323       --defines[=FILE]       also produce a header file\n\
 324   -d                         likewise but cannot specify FILE (for POSIX Yacc)\n\
 325   -r, --report=THINGS        also produce details on the automaton\n\
 326       --report-file=FILE     write report to FILE\n\
 327   -v, --verbose              same as `--report=state'\n\
 328   -b, --file-prefix=PREFIX   specify a PREFIX for output files\n\
 329   -o, --output=FILE          leave output to FILE\n\
 330   -g, --graph[=FILE]         also output a graph of the automaton\n\
 331   -x, --xml[=FILE]           also output an XML report of the automaton\n\
 332                              (the XML schema is experimental)\n\
 333 \n\
 334 "), stdout);
 335
 336       fputs (_("\
 337 Warning categories include:\n\
 338   `midrule-values'  unset or unused midrule values\n\
 339   `yacc'            incompatibilities with POSIX Yacc\n\
 340   `conflicts-sr'    S/R conflicts (enabled by default)\n\
 341   `conflicts-rr'    R/R conflicts (enabled by default)\n\
 342   `other'           all other warnings (enabled by default)\n\
 343   `all'             all the warnings\n\
 344   `no-CATEGORY'     turn off warnings in CATEGORY\n\
 345   `none'            turn off all the warnings\n\
 346   `error'           treat warnings as errors\n\
 347 \n\
 348 "), stdout);
 349
 350       fputs (_("\
 351 THINGS is a list of comma separated words that can include:\n\
 352   `state'        describe the states\n\
 353   `itemset'      complete the core item sets with their closure\n\
 354   `lookahead'    explicitly associate lookahead tokens to items\n\
 355   `solved'       describe shift/reduce conflicts solving\n\
 356   `all'          include all the above information\n\
 357   `none'         disable the report\n\
 358 "), stdout);
 359
 360       putc ('\n', stdout);
 361       printf (_("Report bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 362       printf (_("%s home page: <%s>.\n"), PACKAGE_NAME, PACKAGE_URL);
 363       fputs (_("General help using GNU software: "
 364                "<http://www.gnu.org/gethelp/>.\n"),
 365              stdout);
 366       /* Don't output this redundant message for English locales.
 367          Note we still output for 'C' so that it gets included in the
 368          man page.  */
 369       const char *lc_messages = setlocale (LC_MESSAGES, NULL);
 370       if (lc_messages && !STREQ (lc_messages, "en_"))
 371         /* TRANSLATORS: Replace LANG_CODE in this URL with your language
 372            code <http://translationproject.org/team/LANG_CODE.html> to
 373            form one of the URLs at http://translationproject.org/team/.
 374            Otherwise, replace the entire URL with your translation team's
 375            email address.  */
 376         fputs (_("Report translation bugs to "
 377                  "<http://translationproject.org/team/>.\n"), stdout);
 378       fputs (_("For complete documentation, run: info bison.\n"), stdout);
 379     }
 380
 381   exit (status);
 382 }
 383
 384
 385 /*------------------------------.
 386 | Display the version message.  |
 387 `------------------------------*/
 388
 389 static void
 390 version (void)
 391 {
 392   /* Some efforts were made to ease the translators' task, please
 393      continue.  */
 394   printf (_("bison (GNU Bison) %s"), VERSION);
 395   putc ('\n', stdout);
 396   fputs (_("Written by Robert Corbett and Richard Stallman.\n"), stdout);
 397   putc ('\n', stdout);
 398
 399   fprintf (stdout,
 400            _("Copyright (C) %d Free Software Foundation, Inc.\n"),
 401            PACKAGE_COPYRIGHT_YEAR);
 402
 403   fputs (_("\
 404 This is free software; see the source for copying conditions.  There is NO\n\
 405 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
 406 "),
 407          stdout);
 408 }
 409
 410
 411 /*-------------------------------------.
 412 | --skeleton and --language handling.  |
 413 `--------------------------------------*/
 414
 415 void
 416 skeleton_arg (char const *arg, int prio, location loc)
 417 {
 418   if (prio < skeleton_prio)
 419     {
 420       skeleton_prio = prio;
 421       skeleton = arg;
 422     }
 423   else if (prio == skeleton_prio)
 424     complain_at (loc, complaint,
 425                  _("multiple skeleton declarations are invalid"));
 426 }
 427
 428 void
 429 language_argmatch (char const *arg, int prio, location loc)
 430 {
 431   char const *msg;
 432
 433   if (prio < language_prio)
 434     {
 435       int i;
 436       for (i = 0; valid_languages[i].language[0]; i++)
 437         if (c_strcasecmp (arg, valid_languages[i].language) == 0)
 438           {
 439             language_prio = prio;
 440             language = &valid_languages[i];
 441             return;
 442           }
 443       msg = _("%s: invalid language");
 444     }
 445   else if (language_prio == prio)
 446     msg = _("multiple language declarations are invalid");
 447   else
 448     return;
 449
 450   complain_at (loc, complaint, msg, quotearg_colon (arg));
 451 }
 452
 453 /*----------------------.
 454 | Process the options.  |
 455 `----------------------*/
 456
 457 /* Shorts options.
 458    Should be computed from long_options.  */
 459 static char const short_options[] =
 460   "D:"
 461   "F:"
 462   "L:"
 463   "S:"
 464   "T::"
 465   "V"
 466   "W::"
 467   "b:"
 468   "d"
 469   "e"
 470   "g::"
 471   "h"
 472   "k"
 473   "l"
 474   "n"
 475   "o:"
 476   "p:"
 477   "r:"
 478   "t"
 479   "v"
 480   "x::"
 481   "y"
 482   ;
 483
 484 /* Values for long options that do not have single-letter equivalents.  */
 485 enum
 486 {
 487   LOCATIONS_OPTION = CHAR_MAX + 1,
 488   PRINT_LOCALEDIR_OPTION,
 489   PRINT_DATADIR_OPTION,
 490   REPORT_FILE_OPTION
 491 };
 492
 493 static struct option const long_options[] =
 494 {
 495   /* Operation modes. */
 496   { "help",            no_argument,       0,   'h' },
 497   { "version",         no_argument,       0,   'V' },
 498   { "print-localedir", no_argument,       0,   PRINT_LOCALEDIR_OPTION },
 499   { "print-datadir",   no_argument,       0,   PRINT_DATADIR_OPTION   },
 500   { "warnings",        optional_argument, 0,   'W' },
 501
 502   /* Parser. */
 503   { "name-prefix",   required_argument,   0,   'p' },
 504   { "include",       required_argument,   0,   'I' },
 505
 506   /* Output. */
 507   { "file-prefix", required_argument,   0,   'b' },
 508   { "output",      required_argument,   0,   'o' },
 509   { "output-file", required_argument,   0,   'o' },
 510   { "graph",       optional_argument,   0,   'g' },
 511   { "xml",         optional_argument,   0,   'x' },
 512   { "report",      required_argument,   0,   'r' },
 513   { "report-file", required_argument,   0,   REPORT_FILE_OPTION },
 514   { "verbose",     no_argument,         0,   'v' },
 515
 516   /* Hidden. */
 517   { "trace",         optional_argument,   0,     'T' },
 518
 519   /* Output.  */
 520   { "defines",     optional_argument,   0,   'd' },
 521
 522   /* Operation modes.  */
 523   { "fixed-output-files", no_argument,  0,   'y' },
 524   { "yacc",               no_argument,  0,   'y' },
 525
 526   /* Parser.  */
 527   { "debug",          no_argument,               0,   't' },
 528   { "define",         required_argument,         0,   'D' },
 529   { "force-define",   required_argument,         0,   'F' },
 530   { "locations",      no_argument,               0, LOCATIONS_OPTION },
 531   { "no-lines",       no_argument,               0,   'l' },
 532   { "raw",            no_argument,               0,     0 },
 533   { "skeleton",       required_argument,         0,   'S' },
 534   { "language",       required_argument,         0,   'L' },
 535   { "token-table",    no_argument,               0,   'k' },
 536
 537   {0, 0, 0, 0}
 538 };
 539
 540 /* Under DOS, there is no difference on the case.  This can be
 541    troublesome when looking for `.tab' etc.  */
 542 #ifdef MSDOS
 543 # define AS_FILE_NAME(File) (strlwr (File), (File))
 544 #else
 545 # define AS_FILE_NAME(File) (File)
 546 #endif
 547
 548 /* Build a location for the current command line argument. */
 549 static
 550 location
 551 command_line_location (void)
 552 {
 553   location res;
 554   /* "<command line>" is used in GCC's messages about -D. */
 555   boundary_set (&res.start, uniqstr_new ("<command line>"), optind, -1);
 556   res.end = res.start;
 557   return res;
 558 }
 559
 560
 561 void
 562 getargs (int argc, char *argv[])
 563 {
 564   int c;
 565
 566   while ((c = getopt_long (argc, argv, short_options, long_options, NULL))
 567          != -1)
 568     switch (c)
 569       {
 570         /* ASCII Sorting for short options (i.e., upper case then
 571            lower case), and then long-only options.  */
 572
 573       case 0:
 574         /* Certain long options cause getopt_long to return 0.  */
 575         break;
 576
 577       case 'D': /* -DNAME[=VALUE]. */
 578       case 'F': /* -FNAME[=VALUE]. */
 579         {
 580           char* name = optarg;
 581           char* value = strchr (optarg, '=');
 582           if (value)
 583             *value++ = 0;
 584           muscle_percent_define_insert (name, command_line_location (),
 585                                         value ? value : "",
 586                                         c == 'D' ? MUSCLE_PERCENT_DEFINE_D
 587                                                  : MUSCLE_PERCENT_DEFINE_F);
 588         }
 589         break;
 590
 591       case 'I':
 592         include = AS_FILE_NAME (optarg);
 593         break;
 594
 595       case 'L':
 596         language_argmatch (optarg, command_line_prio,
 597                            command_line_location ());
 598         break;
 599
 600       case 'S':
 601         skeleton_arg (AS_FILE_NAME (optarg), command_line_prio,
 602                       command_line_location ());
 603         break;
 604
 605       case 'T':
 606         FLAGS_ARGMATCH (trace, optarg, trace_all);
 607         break;
 608
 609       case 'V':
 610         version ();
 611         exit (EXIT_SUCCESS);
 612
 613       case 'W':
 614         FLAGS_ARGMATCH (warnings, optarg, Wall);
 615         break;
 616
 617       case 'b':
 618         spec_file_prefix = AS_FILE_NAME (optarg);
 619         break;
 620
 621       case 'd':
 622         /* Here, the -d and --defines options are differentiated.  */
 623         defines_flag = true;
 624         if (optarg)
 625           {
 626             free (spec_defines_file);
 627             spec_defines_file = xstrdup (AS_FILE_NAME (optarg));
 628           }
 629         break;
 630
 631       case 'g':
 632         graph_flag = true;
 633         if (optarg)
 634           {
 635             free (spec_graph_file);
 636             spec_graph_file = xstrdup (AS_FILE_NAME (optarg));
 637           }
 638         break;
 639
 640       case 'h':
 641         usage (EXIT_SUCCESS);
 642
 643       case 'k':
 644         token_table_flag = true;
 645         break;
 646
 647       case 'l':
 648         no_lines_flag = true;
 649         break;
 650
 651       case 'o':
 652         spec_outfile = AS_FILE_NAME (optarg);
 653         break;
 654
 655       case 'p':
 656         spec_name_prefix = optarg;
 657         break;
 658
 659       case 'r':
 660         FLAGS_ARGMATCH (report, optarg, report_all);
 661         break;
 662
 663       case 't':
 664         muscle_percent_define_insert ("parse.trace",
 665                                       command_line_location (), "",
 666                                       MUSCLE_PERCENT_DEFINE_D);
 667         break;
 668
 669       case 'v':
 670         report_flag |= report_states;
 671         break;
 672
 673       case 'x':
 674         xml_flag = true;
 675         if (optarg)
 676           {
 677             free (spec_xml_file);
 678             spec_xml_file = xstrdup (AS_FILE_NAME (optarg));
 679           }
 680         break;
 681
 682       case 'y':
 683         yacc_flag = true;
 684         break;
 685
 686       case LOCATIONS_OPTION:
 687         muscle_percent_define_ensure ("locations",
 688                                       command_line_location (), true);
 689         break;
 690
 691       case PRINT_LOCALEDIR_OPTION:
 692         printf ("%s\n", LOCALEDIR);
 693         exit (EXIT_SUCCESS);
 694
 695       case PRINT_DATADIR_OPTION:
 696         printf ("%s\n", pkgdatadir ());
 697         exit (EXIT_SUCCESS);
 698
 699       case REPORT_FILE_OPTION:
 700         free (spec_verbose_file);
 701         spec_verbose_file = xstrdup (AS_FILE_NAME (optarg));
 702         break;
 703
 704       default:
 705         usage (EXIT_FAILURE);
 706       }
 707
 708   if (argc - optind != 1)
 709     {
 710       if (argc - optind < 1)
 711         error (0, 0, _("%s: missing operand"), quotearg_colon (argv[argc - 1]));
 712       else
 713         error (0, 0, _("extra operand %s"), quote (argv[optind + 1]));
 714       usage (EXIT_FAILURE);
 715     }
 716
 717   current_file = grammar_file = uniqstr_new (argv[optind]);
 718   MUSCLE_INSERT_C_STRING ("file_name", grammar_file);
 719 }
 720
 721 void
 722 tr (char *s, char from, char to)
 723 {
 724   for (; *s; s++)
 725     if (*s == from)
 726       *s = to;
 727 }