]> git.saurik.com Git - bison.git/blobdiff - src/getargs.c
Improves options in the manual.
[bison.git] / src / getargs.c
index 68a701648fe1656cb187f952e9bce7e56ec5cb8c..aebc240128ae485c005dbd528b35429419b681c9 100644 (file)
@@ -1,29 +1,32 @@
 /* Parse command line arguments for Bison.
 
-   Copyright (C) 1984, 1986, 1989, 1992, 2000, 2001, 2002, 2003
-   Free Software Foundation, Inc.
+   Copyright (C) 1984, 1986, 1989, 1992, 2000, 2001, 2002, 2003, 2004,
+   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
 
    This file is part of Bison, the GNU Compiler Compiler.
 
-   Bison is free software; you can redistribute it and/or modify it
-   under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2, or (at your option)
-   any later version.
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   Bison is distributed in the hope that it will be useful, but
-   WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   General Public License for more details.
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with Bison; see the file COPYING.  If not, write to the Free
-   Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-   02111-1307, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
+#include <config.h>
 #include "system.h"
+#include "output.h"
 
 #include <argmatch.h>
+#include <c-strcase.h>
+#include <configmake.h>
 #include <error.h>
+#include <quotearg.h>
 
 /* Hack to get <getopt.h> to declare getopt with a prototype.  */
 #if lint && ! defined __GNU_LIBRARY__
 #include "complain.h"
 #include "files.h"
 #include "getargs.h"
+#include "muscle_tab.h"
 #include "uniqstr.h"
 
 bool debug_flag;
 bool defines_flag;
+bool graph_flag;
+bool xml_flag;
 bool locations_flag;
 bool no_lines_flag;
-bool no_parser_flag;
-int report_flag = report_none;
 bool token_table_flag;
 bool yacc_flag;        /* for -y */
-bool graph_flag;
-int trace_flag = trace_none;
+
+bool error_verbose = false;
 
 bool nondeterministic_parser = false;
 bool glr_parser = false;
-bool pure_parser = false;
 
+int report_flag = report_none;
+int trace_flag = trace_none;
+int warnings_flag = warnings_none;
+
+static struct bison_language const valid_languages[] = {
+  { "c", "c-skel.m4", ".c", ".h", true },
+  { "c++", "c++-skel.m4", ".cc", ".hh", true },
+  { "java", "java-skel.m4", ".java", ".java", false },
+  { "", "", "", "", false }
+};
+
+int skeleton_prio = default_prio;
 const char *skeleton = NULL;
+int language_prio = default_prio;
+struct bison_language const *language = &valid_languages[0];
 const char *include = NULL;
 
-extern char *program_name;
+char *program_name;
+
+
+/** Decode an option's set of keys.
+ *
+ *  \param option   option being decoded.
+ *  \param keys     array of valid subarguments.
+ *  \param values   array of corresponding (int) values.
+ *  \param flags    the flags to update
+ *  \param args     colon separated list of effective subarguments to decode.
+ *                  If 0, then activate all the flags.
+ *
+ *  The special value 0 resets the flags to 0.
+ */
+static void
+flags_argmatch (const char *option,
+               const char * const keys[], const int values[],
+               int *flags, char *args)
+{
+  if (args)
+    {
+      args = strtok (args, ",");
+      while (args)
+       {
+         int value = XARGMATCH (option, args, keys, values);
+         if (value == 0)
+           *flags = 0;
+         else
+           *flags |= value;
+         args = strtok (NULL, ",");
+       }
+    }
+  else
+    *flags = ~0;
+}
+
+/** Decode a set of sub arguments.
+ *
+ *  \param FlagName  the flag familly to update.
+ *  \param Args      the effective sub arguments to decode.
+ *
+ *  \arg FlagName_args   the list of keys.
+ *  \arg FlagName_types  the list of values.
+ *  \arg FlagName_flag   the flag to update.
+ */
+#define FLAGS_ARGMATCH(FlagName, Args)                                 \
+  flags_argmatch ("--" #FlagName, FlagName ## _args, FlagName ## _types, \
+                 &FlagName ## _flag, Args)
+
+
+/*----------------------.
+| --report's handling.  |
+`----------------------*/
+
+static const char * const report_args[] =
+{
+  /* In a series of synonyms, present the most meaningful first, so
+     that argmatch_valid be more readable.  */
+  "none",
+  "state", "states",
+  "itemset", "itemsets",
+  "lookahead", "lookaheads", "look-ahead",
+  "solved",
+  "all",
+  0
+};
+
+static const int report_types[] =
+{
+  report_none,
+  report_states, report_states,
+  report_states | report_itemsets, report_states | report_itemsets,
+  report_states | report_lookahead_tokens,
+  report_states | report_lookahead_tokens,
+  report_states | report_lookahead_tokens,
+  report_states | report_solved_conflicts,
+  report_all
+};
+
+ARGMATCH_VERIFY (report_args, report_types);
 
 
 /*---------------------.
@@ -72,15 +168,17 @@ static const char * const trace_args[] =
 {
   /* In a series of synonyms, present the most meaningful first, so
      that argmatch_valid be more readable.  */
-  "none       - no report",
+  "none       - no traces",
   "scan       - grammar scanner traces",
   "parse      - grammar parser traces",
-  "automaton  - contruction of the automaton",
+  "automaton  - construction of the automaton",
   "bitsets    - use of bitsets",
-  "grammar    - reading, reducing of the grammar",
+  "grammar    - reading, reducing the grammar",
   "resource   - memory consumption (where available)",
   "sets       - grammar sets: firsts, nullable etc.",
-  "tools      - m4 invocation and preserve the temporary file",
+  "muscles    - m4 definitions passed to the skeleton",
+  "tools      - m4 invocation",
+  "m4         - m4 traces",
   "skeleton   - skeleton postprocessing",
   "time       - time consumption",
   "all        - all of the above",
@@ -97,80 +195,43 @@ static const int trace_types[] =
   trace_grammar,
   trace_resource,
   trace_sets,
+  trace_muscles,
   trace_tools,
+  trace_m4,
   trace_skeleton,
   trace_time,
   trace_all
 };
 
+ARGMATCH_VERIFY (trace_args, trace_types);
 
-static void
-trace_argmatch (char *args)
-{
-  verify (trace_constraint, ARGMATCH_CONSTRAINT (trace_args, trace_types));
-  if (args)
-    {
-      args = strtok (args, ",");
-      do
-       {
-         int trace = XARGMATCH ("--trace", args,
-                                trace_args, trace_types);
-         if (trace == trace_none)
-           trace_flag = trace_none;
-         else
-           trace_flag |= trace;
-       }
-      while ((args = strtok (NULL, ",")));
-    }
-  else
-    trace_flag = trace_all;
-}
 
+/*------------------------.
+| --warnings's handling.  |
+`------------------------*/
 
-/*----------------------.
-| --report's handling.  |
-`----------------------*/
-
-static const char * const report_args[] =
+static const char * const warnings_args[] =
 {
   /* In a series of synonyms, present the most meaningful first, so
      that argmatch_valid be more readable.  */
-  "none",
-  "state", "states",
-  "itemset", "itemsets",
-  "lookahead", "lookaheads",
-  "solved",
-  "all",
+  "none            - no warnings",
+  "midrule-values  - unset or unused midrule values",
+  "yacc            - incompatibilities with POSIX YACC",
+  "all             - all of the above",
+  "error           - warnings are errors",
   0
 };
 
-static const int report_types[] =
+static const int warnings_types[] =
 {
-  report_none,
-  report_states, report_states,
-  report_states | report_itemsets, report_states | report_itemsets,
-  report_states | report_lookaheads, report_states | report_lookaheads,
-  report_states | report_solved_conflicts,
-  report_all
+  warnings_none,
+  warnings_midrule_values,
+  warnings_yacc,
+  warnings_all,
+  warnings_error
 };
 
-
-static void
-report_argmatch (char *args)
-{
-  verify (report_constraint, ARGMATCH_CONSTRAINT (report_args, report_types));
-  args = strtok (args, ",");
-  do
-    {
-      int report = XARGMATCH ("--report", args,
-                             report_args, report_types);
-      if (report == report_none)
-       report_flag = report_none;
-      else
-       report_flag |= report;
-    }
-  while ((args = strtok (NULL, ",")));
-}
+ARGMATCH_VERIFY (warnings_args, warnings_types);
 
 
 /*-------------------------------------------.
@@ -187,65 +248,89 @@ usage (int status)
             program_name);
   else
     {
-      /* Some efforts were made to ease the translators' task, please
-        continue.  */
-      fputs (_("\
-GNU bison generates parsers for LALR(1) grammars.\n"), stdout);
-      putc ('\n', stdout);
+      /* For ../build-aux/cross-options.pl to work, use the format:
+               ^  -S, --long[=ARGS] (whitespace)
+        A --long option is required.
+        Otherwise, add exceptions to ../build-aux/cross-options.pl.  */
 
-      fprintf (stdout, _("\
-Usage: %s [OPTION]... FILE\n"), program_name);
-      putc ('\n', stdout);
+      printf (_("Usage: %s [OPTION]... FILE\n"), program_name);
+      fputs (_("\
+Generate LALR(1) and GLR parsers.\n\
+\n\
+"), stdout);
 
       fputs (_("\
-If a long option shows an argument as mandatory, then it is mandatory\n\
-for the equivalent short option also.  Similarly for optional arguments.\n"),
-            stdout);
-      putc ('\n', stdout);
+Mandatory arguments to long options are mandatory for short options too.\n\
+"), stdout);
+      fputs (_("\
+The same is true for optional arguments.\n\
+"), stdout);
 
       fputs (_("\
+\n\
 Operation modes:\n\
-  -h, --help      display this help and exit\n\
-  -V, --version   output version information and exit\n\
-  -y, --yacc      emulate POSIX yacc\n"), stdout);
-      putc ('\n', stdout);
+  -h, --help                 display this help and exit\n\
+  -V, --version              output version information and exit\n\
+      --print-localedir      output directory containing locale-dependent data\n\
+      --print-datadir        output directory containing skeletons and XSLT\n\
+  -y, --yacc                 emulate POSIX Yacc\n\
+  -W, --warnings[=CATEGORY]  report the warnings falling in CATEGORY\n\
+\n\
+"), stdout);
 
       fputs (_("\
 Parser:\n\
+  -L, --language=LANGUAGE    specify the output programming language\n\
+                             (this is an experimental feature)\n\
   -S, --skeleton=FILE        specify the skeleton to use\n\
   -t, --debug                instrument the parser for debugging\n\
-      --locations            enable locations computation\n\
+      --locations            enable location support\n\
+  -D, --define=NAME[=VALUE]  same as `%define NAME \"VALUE\"'\n\
   -p, --name-prefix=PREFIX   prepend PREFIX to the external symbols\n\
   -l, --no-lines             don't generate `#line' directives\n\
-  -n, --no-parser            generate the tables only\n\
   -k, --token-table          include a table of token names\n\
+\n\
 "), stdout);
-      putc ('\n', stdout);
 
+      /* Keep -d and --defines separate so that ../build-aux/cross-options.pl
+       * won't assume that -d also takes an argument.  */
       fputs (_("\
 Output:\n\
-  -d, --defines              also produce a header file\n\
+      --defines[=FILE]       also produce a header file\n\
+  -d                         likewise but cannot specify FILE (for POSIX Yacc)\n\
   -r, --report=THINGS        also produce details on the automaton\n\
+      --report-file=FILE     write report to FILE\n\
   -v, --verbose              same as `--report=state'\n\
   -b, --file-prefix=PREFIX   specify a PREFIX for output files\n\
   -o, --output=FILE          leave output to FILE\n\
-  -g, --graph                also produce a VCG description of the automaton\n\
+  -g, --graph[=FILE]         also output a graph of the automaton\n\
+  -x, --xml[=FILE]           also output an XML report of the automaton\n\
+                             (the XML schema is experimental)\n\
+\n\
+"), stdout);
+
+      fputs (_("\
+Warning categories include:\n\
+  `midrule-values'  unset or unused midrule values\n\
+  `yacc'            incompatibilities with POSIX YACC\n\
+  `all'             all the warnings\n\
+  `no-CATEGORY'     turn off warnings in CATEGORY\n\
+  `none'            turn off all the warnings\n\
+  `error'           treat warnings as errors\n\
+\n\
 "), stdout);
-      putc ('\n', stdout);
 
       fputs (_("\
 THINGS is a list of comma separated words that can include:\n\
   `state'        describe the states\n\
   `itemset'      complete the core item sets with their closure\n\
-  `lookahead'    explicitly associate lookaheads to items\n\
+  `lookahead'    explicitly associate lookahead tokens to items\n\
   `solved'       describe shift/reduce conflicts solving\n\
   `all'          include all the above information\n\
   `none'         disable the report\n\
 "), stdout);
-      putc ('\n', stdout);
 
-      fputs (_("\
-Report bugs to <bug-bison@gnu.org>.\n"), stdout);
+      printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
     }
 
   exit (status);
@@ -267,7 +352,8 @@ version (void)
   putc ('\n', stdout);
 
   fprintf (stdout,
-          _("Copyright (C) %d Free Software Foundation, Inc.\n"), 2003);
+          _("Copyright (C) %d Free Software Foundation, Inc.\n"),
+          PACKAGE_COPYRIGHT_YEAR);
 
   fputs (_("\
 This is free software; see the source for copying conditions.  There is NO\n\
@@ -277,24 +363,98 @@ warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
 }
 
 
+/*-------------------------------------.
+| --skeleton and --language handling.  |
+`--------------------------------------*/
+
+void
+skeleton_arg (char const *arg, int prio, location loc)
+{
+  if (prio < skeleton_prio)
+    {
+      skeleton_prio = prio;
+      skeleton = arg;
+    }
+  else if (prio == skeleton_prio)
+    {
+      char const *msg =
+       _("multiple skeleton declarations are invalid");
+      complain_at (loc, msg);
+    }
+}
+
+void
+language_argmatch (char const *arg, int prio, location loc)
+{
+  char const *msg;
+
+  if (prio < language_prio)
+    {
+      int i;
+      for (i = 0; valid_languages[i].language[0]; i++)
+       if (c_strcasecmp (arg, valid_languages[i].language) == 0)
+         {
+           language_prio = prio;
+           language = &valid_languages[i];
+           return;
+         }
+      msg = _("invalid language `%s'");
+    }
+  else if (language_prio == prio)
+    msg = _("multiple language declarations are invalid");
+  else
+    return;
+
+  complain_at (loc, msg, arg);
+}
+
 /*----------------------.
 | Process the options.  |
 `----------------------*/
 
-/* Shorts options.  */
-const char *short_options = "yvegdhr:ltknVo:b:p:S:T::";
+/* Shorts options.
+   Should be computed from long_options.  */
+static char const short_options[] =
+  "D:"
+  "L:"
+  "S:"
+  "T::"
+  "V"
+  "W::"
+  "b:"
+  "d"
+  "e"
+  "g::"
+  "h"
+  "k"
+  "l"
+  "n"
+  "o:"
+  "p:"
+  "r:"
+  "t"
+  "v"
+  "x::"
+  "y"
+  ;
 
 /* Values for long options that do not have single-letter equivalents.  */
 enum
 {
-  LOCATIONS_OPTION = CHAR_MAX + 1
+  LOCATIONS_OPTION = CHAR_MAX + 1,
+  PRINT_LOCALEDIR_OPTION,
+  PRINT_DATADIR_OPTION,
+  REPORT_FILE_OPTION
 };
 
 static struct option const long_options[] =
 {
   /* Operation modes. */
-  { "help",          no_argument,              0,   'h' },
-  { "version",       no_argument,              0,   'V' },
+  { "help",            no_argument,      0,   'h' },
+  { "version",         no_argument,      0,   'V' },
+  { "print-localedir", no_argument,      0,   PRINT_LOCALEDIR_OPTION },
+  { "print-datadir",   no_argument,      0,   PRINT_DATADIR_OPTION   },
+  { "warnings",        optional_argument, 0,   'W' },
 
   /* Parser. */
   { "name-prefix",   required_argument,          0,   'p' },
@@ -305,7 +465,9 @@ static struct option const long_options[] =
   { "output",     required_argument,   0,   'o' },
   { "output-file", required_argument,  0,   'o' },
   { "graph",      optional_argument,   0,   'g' },
+  { "xml",         optional_argument,   0,   'x' },
   { "report",     required_argument,   0,   'r' },
+  { "report-file", required_argument,   0,   REPORT_FILE_OPTION },
   { "verbose",    no_argument,         0,   'v' },
 
   /* Hidden. */
@@ -320,11 +482,12 @@ static struct option const long_options[] =
 
   /* Parser.  */
   { "debug",         no_argument,               0,   't' },
+  { "define",        required_argument,         0,   'D' },
   { "locations",      no_argument,              0, LOCATIONS_OPTION },
   { "no-lines",       no_argument,               0,   'l' },
-  { "no-parser",      no_argument,               0,   'n' },
   { "raw",            no_argument,               0,     0 },
   { "skeleton",       required_argument,         0,   'S' },
+  { "language",       required_argument,         0,   'L' },
   { "token-table",    no_argument,               0,   'k' },
 
   {0, 0, 0, 0}
@@ -338,6 +501,19 @@ static struct option const long_options[] =
 # define AS_FILE_NAME(File) (File)
 #endif
 
+/* Build a location for the current command line argument. */
+static
+location
+command_line_location (void)
+{
+  location res;
+  /* "<command line>" is used in GCC's messages about -D. */
+  boundary_set (&res.start, uniqstr_new ("<command line>"), optind, -1);
+  res.end = res.start;
+  return res;
+}
+
+
 void
 getargs (int argc, char *argv[])
 {
@@ -347,85 +523,125 @@ getargs (int argc, char *argv[])
         != -1)
     switch (c)
       {
+        /* ASCII Sorting for short options (i.e., upper case then
+           lower case), and then long-only options.  */
+
       case 0:
        /* Certain long options cause getopt_long to return 0.  */
        break;
 
-      case 'y':
-       yacc_flag = true;
+      case 'D': /* -DNAME[=VALUE]. */
+        {
+          char* name = optarg;
+          char* value = strchr (optarg, '=');
+          if (value)
+            *value++ = 0;
+          muscle_percent_define_insert (name, command_line_location (),
+                                        value ? value : "");
+        }
        break;
 
-      case 'h':
-       usage (EXIT_SUCCESS);
+      case 'I':
+       include = AS_FILE_NAME (optarg);
+       break;
+
+      case 'L':
+       language_argmatch (optarg, command_line_prio,
+                          command_line_location ());
+       break;
+
+      case 'S':
+       skeleton_arg (AS_FILE_NAME (optarg), command_line_prio,
+                     command_line_location ());
+       break;
+
+      case 'T':
+       FLAGS_ARGMATCH (trace, optarg);
+       break;
 
       case 'V':
        version ();
        exit (EXIT_SUCCESS);
 
-      case 'g':
-       /* Here, the -g and --graph=FILE options are differentiated.  */
-       graph_flag = true;
+      case 'W':
        if (optarg)
-         spec_graph_file = AS_FILE_NAME (optarg);
+         FLAGS_ARGMATCH (warnings, optarg);
+       else
+         warnings_flag |= warnings_all;
        break;
 
-      case 'v':
-       report_flag |= report_states;
+      case 'b':
+       spec_file_prefix = AS_FILE_NAME (optarg);
        break;
 
-      case 'S':
-       skeleton = AS_FILE_NAME (optarg);
-       break;
+      case 'd':
+        /* Here, the -d and --defines options are differentiated.  */
+        defines_flag = true;
+        if (optarg)
+          spec_defines_file = xstrdup (AS_FILE_NAME (optarg));
+        break;
 
-      case 'I':
-       include = AS_FILE_NAME (optarg);
+      case 'g':
+       graph_flag = true;
+       if (optarg)
+         spec_graph_file = xstrdup (AS_FILE_NAME (optarg));
        break;
 
-      case 'd':
-       /* Here, the -d and --defines options are differentiated.  */
-       defines_flag = true;
-       if (optarg)
-         spec_defines_file = AS_FILE_NAME (optarg);
+      case 'h':
+       usage (EXIT_SUCCESS);
+
+      case 'k':
+       token_table_flag = true;
        break;
 
       case 'l':
        no_lines_flag = true;
        break;
 
-      case LOCATIONS_OPTION:
-       locations_flag = true;
+      case 'o':
+       spec_outfile = AS_FILE_NAME (optarg);
        break;
 
-      case 'k':
-       token_table_flag = true;
+      case 'p':
+       spec_name_prefix = optarg;
        break;
 
-      case 'n':
-       no_parser_flag = true;
+      case 'r':
+       FLAGS_ARGMATCH (report, optarg);
        break;
 
       case 't':
        debug_flag = true;
        break;
 
-      case 'o':
-       spec_outfile = AS_FILE_NAME (optarg);
+      case 'v':
+       report_flag |= report_states;
        break;
 
-      case 'b':
-       spec_file_prefix = AS_FILE_NAME (optarg);
+      case 'x':
+       xml_flag = true;
+       if (optarg)
+         spec_xml_file = xstrdup (AS_FILE_NAME (optarg));
        break;
 
-      case 'p':
-       spec_name_prefix = optarg;
+      case 'y':
+       yacc_flag = true;
        break;
 
-      case 'r':
-       report_argmatch (optarg);
+      case LOCATIONS_OPTION:
+       locations_flag = true;
        break;
 
-      case 'T':
-       trace_argmatch (optarg);
+      case PRINT_LOCALEDIR_OPTION:
+       printf ("%s\n", LOCALEDIR);
+       exit (EXIT_SUCCESS);
+
+      case PRINT_DATADIR_OPTION:
+       printf ("%s\n", compute_pkgdatadir ());
+       exit (EXIT_SUCCESS);
+
+      case REPORT_FILE_OPTION:
+       spec_verbose_file = xstrdup (AS_FILE_NAME (optarg));
        break;
 
       default:
@@ -442,4 +658,5 @@ getargs (int argc, char *argv[])
     }
 
   current_file = grammar_file = uniqstr_new (argv[optind]);
+  MUSCLE_INSERT_C_STRING ("file_name", grammar_file);
 }