maint: use *.texi.
[bison.git] / src / files.c
index b2f84a2ab94c4875e0772e5f7c2118da6881cd85..f698c7e9c6aeea80182affd0a68541c47e987876 100644 (file)
-/* Open and close files for bison,
-   Copyright 1984, 1986, 1989, 1992, 2000 Free Software Foundation, Inc.
+/* Open and close files for Bison.
+
+   Copyright (C) 1984, 1986, 1989, 1992, 2000-2012 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., 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 "system.h"
-#include "getargs.h"
-#include "files.h"
-#include "xalloc.h"
-#include "gram.h"
-#include "complain.h"
-
-FILE *finput = NULL;
-FILE *foutput = NULL;
 
 
-struct obstack action_obstack;
-struct obstack attrs_obstack;
-struct obstack table_obstack;
-struct obstack defines_obstack;
-struct obstack guard_obstack;
+#include <error.h>
+#include <dirname.h>
+#include <get-errno.h>
+#include <quote.h>
+#include <quotearg.h>
+#include <stdio-safer.h>
+#include <xstrndup.h>
 
 
-char *spec_outfile;    /* for -o. */
-char *spec_file_prefix; /* for -b. */
-char *spec_name_prefix; /* for -p. */
-
-char *infile;
-char *attrsfile;
-
-static char *base_name;
-static char *short_base_name;
+#include "complain.h"
+#include "files.h"
+#include "getargs.h"
+#include "gram.h"
 
 
+/* Initializing some values below (such SPEC_NAME_PREFIX to `yy') is
+   tempting, but don't do that: for the time being our handling of the
+   %directive vs --option leaves precedence to the options by deciding
+   that if a %directive sets a variable which is really set (i.e., not
+   NULL), then the %directive is ignored.  As a result, %name-prefix,
+   for instance, will not be honored.  */
+
+char const *spec_outfile = NULL;       /* for -o. */
+char const *spec_file_prefix = NULL;   /* for -b. */
+char const *spec_name_prefix = NULL;   /* for -p. */
+char *spec_verbose_file = NULL;  /* for --verbose. */
+char *spec_graph_file = NULL;    /* for -g. */
+char *spec_xml_file = NULL;      /* for -x. */
+char *spec_defines_file = NULL;  /* for --defines. */
+char *parser_file_name;
+
+/* All computed output file names.  */
+static char **file_names = NULL;
+static int file_names_count = 0;
+
+uniqstr grammar_file = NULL;
+uniqstr current_file = NULL;
+
+/* If --output=dir/foo.c was specified,
+   DIR_PREFIX is `dir/' and ALL_BUT_EXT and ALL_BUT_TAB_EXT are `dir/foo'.
+
+   If --output=dir/foo.tab.c was specified, DIR_PREFIX is `dir/',
+   ALL_BUT_EXT is `dir/foo.tab', and ALL_BUT_TAB_EXT is `dir/foo'.
+
+   If --output was not specified but --file-prefix=dir/foo was specified,
+   ALL_BUT_EXT = `foo.tab' and ALL_BUT_TAB_EXT = `foo'.
+
+   If neither --output nor --file was specified but the input grammar
+   is name dir/foo.y, ALL_BUT_EXT and ALL_BUT_TAB_EXT are `foo'.
+
+   If neither --output nor --file was specified, DIR_PREFIX is the
+   empty string (meaning the current directory); otherwise it is
+   `dir/'.  */
+
+char *all_but_ext;
+static char *all_but_tab_ext;
+char *dir_prefix;
+
+/* C source file extension (the parser source).  */
+static char *src_extension = NULL;
+/* Header file extension (if option ``-d'' is specified).  */
+static char *header_extension = NULL;
 \f
 \f
-/*--------------------------.
-| Is SUFFIX ending STRING?  |
-`--------------------------*/
-
-static int
-strsuffix (const char *string, const char *suffix)
-{
-  size_t string_len = strlen (string);
-  size_t suffix_len = strlen (suffix);
-  if (suffix_len <= string_len)
-    return !strcmp (string + string_len - suffix_len, suffix);
-  else
-    return 0;
-}
-
-
 /*-----------------------------------------------------------------.
 | Return a newly allocated string composed of the concatenation of |
 /*-----------------------------------------------------------------.
 | Return a newly allocated string composed of the concatenation of |
-| STRING1, and STRING2.                                            |
+| STR1, and STR2.                                                  |
 `-----------------------------------------------------------------*/
 
 static char *
 `-----------------------------------------------------------------*/
 
 static char *
-stringappend (const char *string1, const char *string2)
+concat2 (char const *str1, char const *str2)
 {
 {
-  size_t len = strlen (string1) + strlen (string2);
-  char *res = XMALLOC (char, len + 1);
+  size_t len = strlen (str1) + strlen (str2);
+  char *res = xmalloc (len + 1);
   char *cp;
   char *cp;
-  cp = stpcpy (res, string1);
-  cp = stpcpy (cp, string2);
+  cp = stpcpy (res, str1);
+  cp = stpcpy (cp, str2);
   return res;
 }
 
   return res;
 }
 
@@ -88,9 +108,10 @@ xfopen (const char *name, const char *mode)
 {
   FILE *ptr;
 
 {
   FILE *ptr;
 
-  ptr = fopen (name, mode);
+  ptr = fopen_safer (name, mode);
   if (!ptr)
   if (!ptr)
-    error (2, errno, _("cannot open file `%s'"), name);
+    error (EXIT_FAILURE, get_errno (),
+           _("%s: cannot open"), quotearg_colon (name));
 
   return ptr;
 }
 
   return ptr;
 }
@@ -99,203 +120,277 @@ xfopen (const char *name, const char *mode)
 | Try to close file PTR, and print an error message if fails.  |
 `-------------------------------------------------------------*/
 
 | Try to close file PTR, and print an error message if fails.  |
 `-------------------------------------------------------------*/
 
-int
+void
 xfclose (FILE *ptr)
 {
 xfclose (FILE *ptr)
 {
-  int result;
-
   if (ptr == NULL)
   if (ptr == NULL)
-    return 0;
+    return;
 
 
-  result = fclose (ptr);
-  if (result == EOF)
-    error (2, errno, _("cannot close file"));
+  if (ferror (ptr))
+    error (EXIT_FAILURE, 0, _("input/output error"));
 
 
-  return result;
+  if (fclose (ptr) != 0)
+    error (EXIT_FAILURE, get_errno (), _("cannot close file"));
 }
 }
+\f
+
+/*------------------------------------------------------------------.
+| Compute ALL_BUT_EXT, ALL_BUT_TAB_EXT and output files extensions. |
+`------------------------------------------------------------------*/
 
 
-/*--------------------------------------------------.
-| Save the content of the obstack OBS in FILENAME.  |
-`--------------------------------------------------*/
+/* Compute extensions from the grammar file extension.  */
+static void
+compute_exts_from_gf (const char *ext)
+{
+  if (strcmp (ext, ".y") == 0)
+    {
+      src_extension = xstrdup (language->src_extension);
+      header_extension = xstrdup (language->header_extension);
+    }
+  else
+    {
+      src_extension = xstrdup (ext);
+      header_extension = xstrdup (ext);
+      tr (src_extension, 'y', 'c');
+      tr (src_extension, 'Y', 'C');
+      tr (header_extension, 'y', 'h');
+      tr (header_extension, 'Y', 'H');
+    }
+}
 
 
+/* Compute extensions from the given c source file extension.  */
 static void
 static void
-obstack_save (struct obstack *obs, const char *filename)
+compute_exts_from_src (const char *ext)
 {
 {
-  FILE *out = xfopen (filename, "w");
-  size_t size = obstack_object_size (obs);
-  fwrite (obstack_finish (obs), 1, size, out);
-  xfclose (out);
+  /* We use this function when the user specifies `-o' or `--output',
+     so the extenions must be computed unconditionally from the file name
+     given by this option.  */
+  src_extension = xstrdup (ext);
+  header_extension = xstrdup (ext);
+  tr (header_extension, 'c', 'h');
+  tr (header_extension, 'C', 'H');
 }
 
 
 }
 
 
-/*------------------------------------------------------------------.
-| Return the path to the skeleton which locaction might be given in |
-| ENVVAR, otherwise return SKELETON.                                |
-`------------------------------------------------------------------*/
+/* Decompose FILE_NAME in four parts: *BASE, *TAB, and *EXT, the fourth
+   part, (the directory) is ranging from FILE_NAME to the char before
+   *BASE, so we don't need an additional parameter.
 
 
-const char *
-skeleton_find (const char *envvar, const char *skeleton)
-{
-  const char *res = getenv (envvar);
+   *EXT points to the last period in the basename, or NULL if none.
 
 
-#ifdef MSDOS
-  const char *cp;
+   If there is no *EXT, *TAB is NULL.  Otherwise, *TAB points to
+   `.tab' or `_tab' if present right before *EXT, or is NULL. *TAB
+   cannot be equal to *BASE.
 
 
-  /* File doesn't exist in current directory; try in INIT directory.  */
-  if (!res && (cp = getenv ("INIT")))
-    {
-      res = XMALLOC (char, strlen (cp) + strlen (skeleton) + 2);
-      sprintf (res, "%s%c%s", cp, '/', skeleton);
-    }
-#endif /* !MSDOS */
+   None are allocated, they are simply pointers to parts of FILE_NAME.
+   Examples:
 
 
-  if (!res)
-    res = skeleton;
+   '/tmp/foo.tab.c' -> *BASE = 'foo.tab.c', *TAB = '.tab.c', *EXT =
+   '.c'
 
 
-  return res;
-}
+   'foo.c' -> *BASE = 'foo.c', *TAB = NULL, *EXT = '.c'
 
 
-\f
-/*----------------------------------------.
-| Compute BASE_NAME and SHORT_BASE_NAME.  |
-`----------------------------------------*/
+   'tab.c' -> *BASE = 'tab.c', *TAB = NULL, *EXT = '.c'
+
+   '.tab.c' -> *BASE = '.tab.c', *TAB = NULL, *EXT = '.c'
+
+   'foo.tab' -> *BASE = 'foo.tab', *TAB = NULL, *EXT = '.tab'
 
 
-/* FIXME: Should use xstrndup. */
+   'foo_tab' -> *BASE = 'foo_tab', *TAB = NULL, *EXT = NULL
+
+   'foo' -> *BASE = 'foo', *TAB = NULL, *EXT = NULL.  */
 
 static void
 
 static void
-compute_base_names (void)
+file_name_split (const char *file_name,
+                const char **base, const char **tab, const char **ext)
 {
 {
-  size_t base_length;
-  size_t short_base_length;
+  *base = last_component (file_name);
+
+  /* Look for the extension, i.e., look for the last dot. */
+  *ext = mbsrchr (*base, '.');
+  *tab = NULL;
+
+  /* If there is an extension, check if there is a `.tab' part right
+     before.  */
+  if (*ext)
+    {
+      size_t baselen = *ext - *base;
+      size_t dottablen = 4;
+      if (dottablen < baselen
+         && (strncmp (*ext - dottablen, ".tab", dottablen) == 0
+             || strncmp (*ext - dottablen, "_tab", dottablen) == 0))
+       *tab = *ext - dottablen;
+    }
+}
 
 
-  /* If --output=foo.c was specified (SPEC_OUTFILE == foo.c),
-     BASE_NAME and SHORT_BASE_NAME are `foo'.
 
 
-     If --output=foo.tab.c was specified, BASE_NAME is `foo.tab' and
-     SHORT_BASE_NAME is `foo'.
+static void
+compute_file_name_parts (void)
+{
+  const char *base, *tab, *ext;
+
+  /* Compute ALL_BUT_EXT and ALL_BUT_TAB_EXT from SPEC_OUTFILE
+     or GRAMMAR_FILE.
 
      The precise -o name will be used for FTABLE.  For other output
      files, remove the ".c" or ".tab.c" suffix.  */
   if (spec_outfile)
     {
 
      The precise -o name will be used for FTABLE.  For other output
      files, remove the ".c" or ".tab.c" suffix.  */
   if (spec_outfile)
     {
-#ifdef MSDOS
-      strlwr (spec_outfile);
-#endif /* MSDOS */
-      /* BASE_LENGTH includes ".tab" but not ".c".  */
-      base_length = strlen (spec_outfile);
-      if (strsuffix (spec_outfile, ".c"))
-       base_length -= 2;
-      /* SHORT_BASE_LENGTH includes neither ".tab" nor ".c".  */
-      short_base_length = base_length;
-      if (strsuffix (spec_outfile, ".tab") || strsuffix (spec_outfile, "_tab"))
-       short_base_length -= 4;
-      base_name = strndup (spec_outfile, base_length);
-      short_base_name = strndup (spec_outfile, short_base_length);
-
-      return;
+      file_name_split (spec_outfile, &base, &tab, &ext);
+      dir_prefix = xstrndup (spec_outfile, base - spec_outfile);
+
+      /* ALL_BUT_EXT goes up the EXT, excluding it. */
+      all_but_ext =
+       xstrndup (spec_outfile,
+                 (strlen (spec_outfile) - (ext ? strlen (ext) : 0)));
+
+      /* ALL_BUT_TAB_EXT goes up to TAB, excluding it.  */
+      all_but_tab_ext =
+       xstrndup (spec_outfile,
+                 (strlen (spec_outfile)
+                  - (tab ? strlen (tab) : (ext ? strlen (ext) : 0))));
+
+      if (ext)
+       compute_exts_from_src (ext);
     }
     }
-
-  /* If --file-prefix=foo was specified, BASE_NAME and SHORT_BASE_NAME
-     are `foo'.
-
-     Construct names from it.  */
-  if (spec_file_prefix)
+  else
     {
     {
-#ifdef MSDOS
-      strlwr (spec_file_prefix);
-#endif /* MSDOS */
-      short_base_name = xstrdup (spec_file_prefix);
-
-      base_name = XMALLOC (char,
-                          strlen (short_base_name) + strlen (EXT_TAB) + 1);
-      stpcpy (stpcpy (base_name, short_base_name), EXT_TAB);
-
-      return;
+      file_name_split (grammar_file, &base, &tab, &ext);
+
+      if (spec_file_prefix)
+       {
+         /* If --file-prefix=foo was specified, ALL_BUT_TAB_EXT = `foo'.  */
+         dir_prefix =
+            xstrndup (spec_file_prefix,
+                      last_component (spec_file_prefix) - spec_file_prefix);
+         all_but_tab_ext = xstrdup (spec_file_prefix);
+       }
+      else if (yacc_flag)
+       {
+         /* If --yacc, then the output is `y.tab.c'.  */
+         dir_prefix = xstrdup ("");
+         all_but_tab_ext = xstrdup ("y");
+       }
+      else
+       {
+         /* Otherwise, ALL_BUT_TAB_EXT is computed from the input
+            grammar: `foo/bar.yy' => `bar'.  */
+         dir_prefix = xstrdup ("");
+         all_but_tab_ext =
+           xstrndup (base, (strlen (base) - (ext ? strlen (ext) : 0)));
+       }
+
+      if (language->add_tab)
+        all_but_ext = concat2 (all_but_tab_ext, TAB_EXT);
+      else
+        all_but_ext = xstrdup (all_but_tab_ext);
+
+      /* Compute the extensions from the grammar file name.  */
+      if (ext && !yacc_flag)
+       compute_exts_from_gf (ext);
     }
     }
-
-  /* If neither -o nor --file-prefix were specified, and the input
-     file is foo.y, BASE_NAME is `foo.tab', and SHORT_BASE_NAME is
-     `foo'.
-
-     If --yacc is used, do as if the input file was `y.y'.  */
-  {
-    const char *name_base = yacc_flag ? "y.y" : infile;
-
-    /* BASE_LENGTH gets length of BASE_NAME, sans ".y" suffix if any.  */
-
-    base_length = strlen (name_base);
-    if (strsuffix (name_base, ".y"))
-      base_length -= 2;
-    short_base_length = base_length;
-    short_base_name = strndup (name_base, short_base_length);
-
-    base_name = XMALLOC (char,
-                        strlen (short_base_name) + strlen (EXT_TAB) + 1);
-    stpcpy (stpcpy (base_name, short_base_name), EXT_TAB);
-
-    return;
-  }
 }
 
 }
 
-/*-----------------------------------------------------------------.
-| Open the input file.  Look for the skeletons.  Find the names of |
-| the output files.  Prepare the obstacks.                         |
-`-----------------------------------------------------------------*/
+
+/* Compute the output file names.  Warn if we detect conflicting
+   outputs to the same file.  */
 
 void
 
 void
-open_files (void)
+compute_output_file_names (void)
 {
 {
-  compute_base_names ();
+  compute_file_name_parts ();
 
 
-  finput = xfopen (infile, "r");
+  /* If not yet done. */
+  if (!src_extension)
+    src_extension = xstrdup (".c");
+  if (!header_extension)
+    header_extension = xstrdup (".h");
 
 
-  if (verbose_flag)
-    /* We used to use just .out if spec_name_prefix (-p) was used, but
-       that conflicts with Posix.  */
-    foutput = xfopen (stringappend (base_name, EXT_OUTPUT), "w");
+  parser_file_name =
+    (spec_outfile
+     ? xstrdup (spec_outfile)
+     : concat2 (all_but_ext, src_extension));
 
 
-  attrsfile = stringappend (short_base_name, EXT_STYPE_H);
+  if (defines_flag)
+    {
+      if (! spec_defines_file)
+       spec_defines_file = concat2 (all_but_ext, header_extension);
+    }
 
 
-  /* Initialize the obstacks. */
-  obstack_init (&action_obstack);
-  obstack_init (&attrs_obstack);
-  obstack_init (&table_obstack);
-  obstack_init (&defines_obstack);
-  obstack_init (&guard_obstack);
-}
+  if (graph_flag)
+    {
+      if (! spec_graph_file)
+       spec_graph_file = concat2 (all_but_tab_ext, ".dot");
+      output_file_name_check (&spec_graph_file);
+    }
 
 
+  if (xml_flag)
+    {
+      if (! spec_xml_file)
+       spec_xml_file = concat2 (all_but_tab_ext, ".xml");
+      output_file_name_check (&spec_xml_file);
+    }
 
 
+  if (report_flag)
+    {
+      if (!spec_verbose_file)
+        spec_verbose_file = concat2 (all_but_tab_ext, OUTPUT_EXT);
+      output_file_name_check (&spec_verbose_file);
+    }
 
 
-/*-----------------------------------------------------.
-| Close the open files, produce all the output files.  |
-`-----------------------------------------------------*/
+  free (all_but_tab_ext);
+  free (src_extension);
+  free (header_extension);
+}
 
 void
 
 void
-output_files (void)
+output_file_name_check (char **file_name)
 {
 {
-  xfclose (finput);
-  xfclose (foutput);
-
-  /* Output the main file.  */
-  if (spec_outfile)
-    obstack_save (&table_obstack, spec_outfile);
+  bool conflict = false;
+  if (0 == strcmp (*file_name, grammar_file))
+    {
+      complain (_("refusing to overwrite the input file %s"),
+                quote (*file_name));
+      conflict = true;
+    }
+  else
+    {
+      int i;
+      for (i = 0; i < file_names_count; i++)
+        if (0 == strcmp (file_names[i], *file_name))
+          {
+            warn (_("conflicting outputs to file %s"),
+                  quote (*file_name));
+            conflict = true;
+          }
+    }
+  if (conflict)
+    {
+      free (*file_name);
+      *file_name = strdup ("/dev/null");
+    }
   else
   else
-    obstack_save (&table_obstack,  stringappend (base_name, ".c"));
-
-  /* Output the header file if wanted. */
-  if (defines_flag)
-    obstack_save (&defines_obstack, stringappend (base_name, ".h"));
-
-  /* If we output only the table, dump the actions in ACTFILE. */
-  if (no_parser_flag)
-    obstack_save (&action_obstack, stringappend (short_base_name, ".act"));
-
-  /* If we produced a semantic parser ATTRS_OBSTACK must be dumped
-     into its own file, ATTTRSFILE.  */
-  if (semantic_parser)
     {
     {
-      obstack_save (&attrs_obstack, attrsfile);
-      obstack_save (&guard_obstack,
-                   stringappend (short_base_name, EXT_GUARD_C));
+      file_names = xnrealloc (file_names, ++file_names_count,
+                              sizeof *file_names);
+      file_names[file_names_count-1] = xstrdup (*file_name);
     }
 }
     }
 }
+
+void
+output_file_names_free (void)
+{
+  free (all_but_ext);
+  free (spec_verbose_file);
+  free (spec_graph_file);
+  free (spec_xml_file);
+  free (spec_defines_file);
+  free (parser_file_name);
+  free (dir_prefix);
+  {
+    int i;
+    for (i = 0; i < file_names_count; i++)
+      free (file_names[i]);
+  }
+  free (file_names);
+}