Improves options in the manual.

[bison.git] / src / getargs.c

diff --git a/src/getargs.c b/src/getargs.c
index 94d24329d716cdd0ea167be3135f96f30a20a2ec..aebc240128ae485c005dbd528b35429419b681c9 100644 (file)
--- a/src/getargs.c
+++ b/src/getargs.c
@@ -1,32 +1,32 @@
 /* Parse command line arguments for Bison.
 
    Copyright (C) 1984, 1986, 1989, 1992, 2000, 2001, 2002, 2003, 2004,
 /* Parse command line arguments for Bison.
 
    Copyright (C) 1984, 1986, 1989, 1992, 2000, 2001, 2002, 2003, 2004,

-   2005, 2006 Free Software Foundation, Inc.
+   2005, 2006, 2007, 2008 Free Software Foundation, Inc.

 
    This file is part of Bison, the GNU Compiler Compiler.
 
 
    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
 
    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., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

 
 #include <config.h>
 #include "system.h"
 
 #include <config.h>
 #include "system.h"

-#include "revision.h"
+#include "output.h"

 
 #include <argmatch.h>
 
 #include <argmatch.h>

+#include <c-strcase.h>

 #include <configmake.h>
 #include <error.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__
 
 /* Hack to get <getopt.h> to declare getopt with a prototype.  */
 #if lint && ! defined __GNU_LIBRARY__


@@ -44,14 +44,15 @@
 #include "complain.h"
 #include "files.h"
 #include "getargs.h"
 #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;
 #include "uniqstr.h"
 
 bool debug_flag;
 bool defines_flag;
 bool graph_flag;

+bool xml_flag;

 bool locations_flag;
 bool no_lines_flag;
 bool locations_flag;
 bool no_lines_flag;

-bool no_parser_flag;

 bool token_table_flag;
 bool yacc_flag;        /* for -y */
 
 bool token_table_flag;
 bool yacc_flag;        /* for -y */
 


@@ -59,25 +60,33 @@ bool error_verbose = false;
 
 bool nondeterministic_parser = false;
 bool glr_parser = false;
 
 bool nondeterministic_parser = false;
 bool glr_parser = false;

-bool pure_parser = false;
-bool push_parser = false;

 
 int report_flag = report_none;
 int trace_flag = trace_none;
 int warnings_flag = warnings_none;
 
 
 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;
 const char *skeleton = NULL;

+int language_prio = default_prio;
+struct bison_language const *language = &valid_languages[0];

 const char *include = NULL;
 
 const char *include = NULL;
 

-extern char *program_name;
+char *program_name;

 
 
 /** Decode an option's set of keys.
  *
  *  \param option   option being decoded.
 
 
 /** Decode an option's set of keys.
  *
  *  \param option   option being decoded.

- *  \paran keys     array of valid subarguments.
+ *  \param keys     array of valid subarguments.

  *  \param values   array of corresponding (int) values.
  *  \param values   array of corresponding (int) values.

- *  \param flag     the flags to update
+ *  \param flags    the flags to update

  *  \param args     colon separated list of effective subarguments to decode.
  *                  If 0, then activate all the flags.
  *
  *  \param args     colon separated list of effective subarguments to decode.
  *                  If 0, then activate all the flags.
  *


@@ -98,7 +107,7 @@ flags_argmatch (const char *option,
            *flags = 0;
          else
            *flags |= value;
            *flags = 0;
          else
            *flags |= value;

-          args = strtok (NULL, ",");
+         args = strtok (NULL, ",");

        }
     }
   else
        }
     }
   else


@@ -108,7 +117,7 @@ flags_argmatch (const char *option,
 /** Decode a set of sub arguments.
  *
  *  \param FlagName  the flag familly to update.
 /** Decode a set of sub arguments.
  *
  *  \param FlagName  the flag familly to update.

- *  \param args      the effective sub arguments to decode.
+ *  \param Args      the effective sub arguments to decode.

  *
  *  \arg FlagName_args   the list of keys.
  *  \arg FlagName_types  the list of values.
  *
  *  \arg FlagName_args   the list of keys.
  *  \arg FlagName_types  the list of values.


@@ -167,6 +176,7 @@ static const char * const trace_args[] =
   "grammar    - reading, reducing the grammar",
   "resource   - memory consumption (where available)",
   "sets       - grammar sets: firsts, nullable etc.",
   "grammar    - reading, reducing the grammar",
   "resource   - memory consumption (where available)",
   "sets       - grammar sets: firsts, nullable etc.",

+  "muscles    - m4 definitions passed to the skeleton",

   "tools      - m4 invocation",
   "m4         - m4 traces",
   "skeleton   - skeleton postprocessing",
   "tools      - m4 invocation",
   "m4         - m4 traces",
   "skeleton   - skeleton postprocessing",


@@ -185,6 +195,7 @@ static const int trace_types[] =
   trace_grammar,
   trace_resource,
   trace_sets,
   trace_grammar,
   trace_resource,
   trace_sets,

+  trace_muscles,

   trace_tools,
   trace_m4,
   trace_skeleton,
   trace_tools,
   trace_m4,
   trace_skeleton,


@@ -203,19 +214,21 @@ static const char * const warnings_args[] =
 {
   /* In a series of synonyms, present the most meaningful first, so
      that argmatch_valid be more readable.  */
 {
   /* In a series of synonyms, present the most meaningful first, so
      that argmatch_valid be more readable.  */

-  "none       - no warnings",
-  "error      - warnings are errors",
-  "yacc       - incompatibilities with POSIX YACC",
-  "all        - all of the above",
+  "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 warnings_types[] =
 {
   warnings_none,
   0
 };
 
 static const int warnings_types[] =
 {
   warnings_none,

-  warnings_error,
+  warnings_midrule_values,

   warnings_yacc,
   warnings_yacc,

-  warnings_all
+  warnings_all,
+  warnings_error

 };
 
 ARGMATCH_VERIFY (warnings_args, warnings_types);
 };
 
 ARGMATCH_VERIFY (warnings_args, warnings_types);


@@ -235,6 +248,11 @@ usage (int status)
             program_name);
   else
     {
             program_name);
   else
     {

+      /* 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.  */
+

       printf (_("Usage: %s [OPTION]... FILE\n"), program_name);
       fputs (_("\
 Generate LALR(1) and GLR parsers.\n\
       printf (_("Usage: %s [OPTION]... FILE\n"), program_name);
       fputs (_("\
 Generate LALR(1) and GLR parsers.\n\


@@ -243,6 +261,9 @@ Generate LALR(1) and GLR parsers.\n\
 
       fputs (_("\
 Mandatory arguments to long options are mandatory for short options too.\n\
 
       fputs (_("\
 Mandatory arguments to long options are mandatory for short options too.\n\

+"), stdout);
+      fputs (_("\
+The same is true for optional arguments.\n\

 "), stdout);
 
       fputs (_("\
 "), stdout);
 
       fputs (_("\


@@ -251,30 +272,51 @@ Operation modes:\n\
   -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\
   -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\
   -y, --yacc                 emulate POSIX Yacc\n\

+  -W, --warnings[=CATEGORY]  report the warnings falling in CATEGORY\n\

 \n\
 "), stdout);
 
       fputs (_("\
 Parser:\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\
   -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\
   -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);
 
   -k, --token-table          include a table of token names\n\
 \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\
       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\
   -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\
   -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 output a graph 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);
 
 \n\
 "), stdout);
 


@@ -306,12 +348,12 @@ version (void)
      continue.  */
   printf (_("bison (GNU Bison) %s"), VERSION);
   putc ('\n', stdout);
      continue.  */
   printf (_("bison (GNU Bison) %s"), VERSION);
   putc ('\n', stdout);

-  printf ("%s", revision);

   fputs (_("Written by Robert Corbett and Richard Stallman.\n"), stdout);
   putc ('\n', stdout);
 
   fprintf (stdout,
   fputs (_("Written by Robert Corbett and Richard Stallman.\n"), stdout);
   putc ('\n', stdout);
 
   fprintf (stdout,

-          _("Copyright (C) %d Free Software Foundation, Inc.\n"), 2006);
+          _("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\
 
   fputs (_("\
 This is free software; see the source for copying conditions.  There is NO\n\


@@ -321,18 +363,88 @@ 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.  |
 `----------------------*/
 
 /*----------------------.
 | Process the options.  |
 `----------------------*/
 

-/* Shorts options.  */
-static char const short_options[] = "yvegdhr:ltknVo:b:p:S:T::W";
+/* 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,
 
 /* Values for long options that do not have single-letter equivalents.  */
 enum
 {
   LOCATIONS_OPTION = CHAR_MAX + 1,

-  PRINT_LOCALEDIR_OPTION
+  PRINT_LOCALEDIR_OPTION,
+  PRINT_DATADIR_OPTION,
+  REPORT_FILE_OPTION

 };
 
 static struct option const long_options[] =
 };
 
 static struct option const long_options[] =


@@ -341,6 +453,7 @@ static struct option const long_options[] =
   { "help",            no_argument,      0,   'h' },
   { "version",         no_argument,      0,   'V' },
   { "print-localedir", no_argument,      0,   PRINT_LOCALEDIR_OPTION },
   { "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. */
   { "warnings",        optional_argument, 0,   'W' },
 
   /* Parser. */


@@ -352,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' },
   { "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",     required_argument,   0,   'r' },

+  { "report-file", required_argument,   0,   REPORT_FILE_OPTION },

   { "verbose",    no_argument,         0,   'v' },
 
   /* Hidden. */
   { "verbose",    no_argument,         0,   'v' },
 
   /* Hidden. */


@@ -367,11 +482,12 @@ static struct option const long_options[] =
 
   /* Parser.  */
   { "debug",         no_argument,               0,   't' },
 
   /* Parser.  */
   { "debug",         no_argument,               0,   't' },

+  { "define",        required_argument,         0,   'D' },

   { "locations",      no_argument,              0, LOCATIONS_OPTION },
   { "no-lines",       no_argument,               0,   'l' },
   { "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' },
   { "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}
   { "token-table",    no_argument,               0,   'k' },
 
   {0, 0, 0, 0}


@@ -385,6 +501,19 @@ static struct option const long_options[] =
 # define AS_FILE_NAME(File) (File)
 #endif
 
 # 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[])
 {
 void
 getargs (int argc, char *argv[])
 {


@@ -394,39 +523,73 @@ getargs (int argc, char *argv[])
         != -1)
     switch (c)
       {
         != -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 0:
        /* Certain long options cause getopt_long to return 0.  */
        break;
 

-      case 'b':
-       spec_file_prefix = AS_FILE_NAME (optarg);
+      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;
 
        break;
 

-      case 'g':
-       /* Here, the -g and --graph=FILE options are differentiated.  */
-       graph_flag = true;
-       if (optarg)
-         spec_graph_file = AS_FILE_NAME (optarg);
+      case 'I':
+       include = AS_FILE_NAME (optarg);

        break;
 
        break;
 

-      case 'h':
-       usage (EXIT_SUCCESS);
+      case 'L':
+       language_argmatch (optarg, command_line_prio,
+                          command_line_location ());
+       break;

 
       case 'S':
 
       case 'S':

-       skeleton = AS_FILE_NAME (optarg);
+       skeleton_arg (AS_FILE_NAME (optarg), command_line_prio,
+                     command_line_location ());

        break;
 
        break;
 

-      case 'I':
-       include = AS_FILE_NAME (optarg);
+      case 'T':
+       FLAGS_ARGMATCH (trace, optarg);
+       break;
+
+      case 'V':
+       version ();
+       exit (EXIT_SUCCESS);
+
+      case 'W':
+       if (optarg)
+         FLAGS_ARGMATCH (warnings, optarg);
+       else
+         warnings_flag |= warnings_all;
+       break;
+
+      case 'b':
+       spec_file_prefix = AS_FILE_NAME (optarg);

        break;
 
       case 'd':
        break;
 
       case 'd':

-       /* Here, the -d and --defines options are differentiated.  */
-       defines_flag = true;
+        /* Here, the -d and --defines options are differentiated.  */
+        defines_flag = true;
+        if (optarg)
+          spec_defines_file = xstrdup (AS_FILE_NAME (optarg));
+        break;
+
+      case 'g':
+       graph_flag = true;

        if (optarg)
        if (optarg)

-         spec_defines_file = AS_FILE_NAME (optarg);
+         spec_graph_file = xstrdup (AS_FILE_NAME (optarg));

        break;
 
        break;
 

+      case 'h':
+       usage (EXIT_SUCCESS);
+

       case 'k':
        token_table_flag = true;
        break;
       case 'k':
        token_table_flag = true;
        break;


@@ -435,10 +598,6 @@ getargs (int argc, char *argv[])
        no_lines_flag = true;
        break;
 
        no_lines_flag = true;
        break;
 

-      case 'n':
-       no_parser_flag = true;
-       break;
-

       case 'o':
        spec_outfile = AS_FILE_NAME (optarg);
        break;
       case 'o':
        spec_outfile = AS_FILE_NAME (optarg);
        break;


@@ -451,28 +610,22 @@ getargs (int argc, char *argv[])
        FLAGS_ARGMATCH (report, optarg);
        break;
 
        FLAGS_ARGMATCH (report, optarg);
        break;
 

-      case 'T':
-       FLAGS_ARGMATCH (trace, optarg);
-       break;
-

       case 't':
        debug_flag = true;
        break;
 
       case 't':
        debug_flag = true;
        break;
 

-      case 'V':
-       version ();
-       exit (EXIT_SUCCESS);
-

       case 'v':
        report_flag |= report_states;
        break;
 
       case 'v':
        report_flag |= report_states;
        break;
 

-      case 'y':
-       yacc_flag = true;
+      case 'x':
+       xml_flag = true;
+       if (optarg)
+         spec_xml_file = xstrdup (AS_FILE_NAME (optarg));

        break;
 
        break;
 

-      case 'W':
-       FLAGS_ARGMATCH (warnings, optarg);
+      case 'y':
+       yacc_flag = true;

        break;
 
       case LOCATIONS_OPTION:
        break;
 
       case LOCATIONS_OPTION:


@@ -483,6 +636,14 @@ getargs (int argc, char *argv[])
        printf ("%s\n", LOCALEDIR);
        exit (EXIT_SUCCESS);
 
        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:
        usage (EXIT_FAILURE);
       }
       default:
        usage (EXIT_FAILURE);
       }


@@ -497,4 +658,5 @@ getargs (int argc, char *argv[])
     }
 
   current_file = grammar_file = uniqstr_new (argv[optind]);
     }
 
   current_file = grammar_file = uniqstr_new (argv[optind]);

+  MUSCLE_INSERT_C_STRING ("file_name", grammar_file);

 }
 }