New file: skeleton for GLR (Generalized LR) parser.

[bison.git] / src / files.c

diff --git a/src/files.c b/src/files.c
index 5e81ebe8ae136cdfc7bd6af5192904b17b2ed04d..1252aab0dc1e574636ceea5bf38b51f862b82027 100644 (file)
--- a/src/files.c
+++ b/src/files.c
@@ -1,5 +1,6 @@
 /* Open and close files for bison,
 /* Open and close files for bison,

-   Copyright 1984, 1986, 1989, 1992, 2000 Free Software Foundation, Inc.
+   Copyright (C) 1984, 1986, 1989, 1992, 2000, 2001, 2002
+   Free Software Foundation, Inc.

 
    This file is part of Bison, the GNU Compiler Compiler.
 
 
    This file is part of Bison, the GNU Compiler Compiler.
 


@@ -20,91 +21,133 @@
 
 
 #include "system.h"
 
 
 #include "system.h"

-
-#if defined (VMS) & !defined (__VMS_POSIX)
-# ifndef BISON_SIMPLE
-#  define BISON_SIMPLE "GNU_BISON:[000000]BISON.SIMPLE"
-# endif
-# ifndef BISON_HAIRY
-#  define BISON_HARIRY "GNU_BISON:[000000]BISON.HAIRY"
-# endif
-#endif
-
-#if defined (_MSC_VER)
-# ifndef BISON_SIMPLE
-#  define BISON_SIMPLE "c:/usr/local/lib/bison.simple"
-# endif
-# ifndef BISON_HAIRY
-#  define BISON_HAIRY "c:/usr/local/lib/bison.hairy"
-# endif
-#endif
-

 #include "getargs.h"
 #include "files.h"
 #include "getargs.h"
 #include "files.h"

-#include "xalloc.h"

 #include "gram.h"
 #include "gram.h"

+#include "error.h"

 #include "complain.h"
 
 #include "complain.h"
 

+/* From basename.c.  Almost a lie, as it returns a char *. */
+const char *base_name PARAMS ((char const *name));
+

 FILE *finput = NULL;
 FILE *finput = NULL;

-FILE *foutput = NULL;
-FILE *fguard = NULL;
-FILE *fparser = NULL;

 
 

-struct obstack action_obstack;
-struct obstack attrs_obstack;
-struct obstack table_obstack;
-struct obstack defines_obstack;
+struct obstack pre_prologue_obstack;
+struct obstack post_prologue_obstack;

 
 

-/* File name specified with -o for the output file, or 0 if no -o.  */
-char *spec_outfile;
+/* 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 *infile;
-char *attrsfile;
+char *spec_outfile = NULL;     /* for -o. */
+char *spec_file_prefix = NULL; /* for -b. */
+const char *spec_name_prefix = NULL;   /* for -p. */
+char *spec_verbose_file = NULL;   /* for --verbose. */
+char *spec_graph_file = NULL;   /* for -g. */
+char *spec_defines_file = NULL; /* for --defines. */
+char *parser_file_name = NULL;

 
 

-static char *outfile;
-static char *defsfile;
-static char *tabfile;
-static char *guardfile;
-static char *actfile;
+char *infile = NULL;

 
 

-extern char *getenv ();
+static char *full_base_name = NULL;

 
 

-extern char *program_name;
+/* Prefix used to generate output file names.  */
+char *short_base_name = NULL;
+
+/* Infix used to generate output file names (i.e., `.tab', or `_tab',
+   or `').  */
+char *output_infix = NULL;
+
+/* C source file extension (the parser source).  */
+const char *src_extension = NULL;
+/* Header file extension (if option ``-d'' is specified).  */
+const char *header_extension = NULL;

 \f
 
 \f
 

-static char *
-stringappend (const char *string1, int end1, const char *string2)
+/*--------------------------.
+| Is SUFFIX ending STRING?  |
+`--------------------------*/
+
+int
+strsuffix (const char *string, const char *suffix)

 {
 {

-  register char *ostring;
-  register char *cp;
-  register const char *cp1;
-  register int i;
+  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;
+}

 
 

-  cp1 = string2;
-  i = 0;
-  while (*cp1++)
-    i++;

 
 

-  ostring = XCALLOC (char, i + end1 + 1);
+/*-----------------------------------------------------------------.
+| Return a newly allocated string composed of the concatenation of |
+| STRING1, and STRING2.                                            |
+`-----------------------------------------------------------------*/

 
 

-  cp = ostring;
-  cp1 = string1;
-  for (i = 0; i < end1; i++)
-    *cp++ = *cp1++;
+char*
+stringappend (const char *string1, const char *string2)
+{
+  size_t len = strlen (string1) + strlen (string2);
+  char *res = XMALLOC (char, len + 1);
+  char *cp;
+  cp = stpcpy (res, string1);
+  cp = stpcpy (cp, string2);
+  return res;
+}

 
 

-  cp1 = string2;
-  while ((*cp++ = *cp1++))
-    ;

 
 

-  return ostring;
+/*-----------------------------------------------------------------.
+| Computes the macro name used to avoid double inclusion in the    |
+| header of the parser and store it in header_macro_name.  Be sure |
+| to produce valid CPP names (don't start with digit, remain       |
+| alphanumerical + underscore).                                    |
+`-----------------------------------------------------------------*/
+
+char *
+compute_header_macro (void)
+{
+  const char *prefix = "BISON_";
+  char *macro_name, *cp;
+
+  if (spec_defines_file)
+    {
+      macro_name = XMALLOC (char,
+                           strlen (prefix) +
+                           strlen (spec_defines_file) + 1);
+      cp = stpcpy (macro_name, prefix);
+      cp = stpcpy (cp, spec_defines_file);
+    }
+  else
+    {
+      macro_name = XMALLOC (char,
+                           strlen (prefix) +
+                           strlen (full_base_name) +
+                           strlen (header_extension) + 1);
+      cp = stpcpy (macro_name, prefix);
+      cp = stpcpy (cp, full_base_name);
+      cp = stpcpy (cp, header_extension);
+    }
+
+  for (cp = macro_name; *cp; ++cp)
+    if (islower (*cp))
+      *cp = toupper (*cp);
+    else if (!isalnum (*cp))
+      *cp = '_';
+
+  return macro_name;

 }
 
 }
 

+

 /*-----------------------------------------------------------------.
 | Try to open file NAME with mode MODE, and print an error message |
 | if fails.                                                        |
 `-----------------------------------------------------------------*/
 
 /*-----------------------------------------------------------------.
 | Try to open file NAME with mode MODE, and print an error message |
 | if fails.                                                        |
 `-----------------------------------------------------------------*/
 

-static FILE *
+FILE *

 xfopen (const char *name, const char *mode)
 {
   FILE *ptr;
 xfopen (const char *name, const char *mode)
 {
   FILE *ptr;


@@ -120,7 +163,7 @@ 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.  |
 `-------------------------------------------------------------*/
 

-static int
+int

 xfclose (FILE *ptr)
 {
   int result;
 xfclose (FILE *ptr)
 {
   int result;


@@ -135,230 +178,259 @@ xfclose (FILE *ptr)
   return result;
 }
 
   return result;
 }
 

-/*--------------------------------------------------.
-| Save the content of the obstack OBS in FILENAME.  |
-`--------------------------------------------------*/
-
-static void
-obstack_save (struct obstack *obs, const char *filename)
-{
-  FILE *out = xfopen (filename, "w");
-  size_t size = obstack_object_size (obs);
-  fwrite (obstack_finish (obs), 1, size, out);
-  xfclose (out);
-}

 
 

+/*------------------------------------------------------------------.
+| Return the path to the skeleton which locaction might be given in |
+| ENVVAR, otherwise return SKELETON_NAME.                           |
+`------------------------------------------------------------------*/

 
 

-static const char *
-skeleton_find (const char *envvar, const char *skeleton)
+const char *
+skeleton_find (const char *envvar, const char *skeleton_name)

 {
   const char *res = getenv (envvar);
 
 {
   const char *res = getenv (envvar);
 

-#ifdef MSDOS
-  const char *cp;
-
-  /* File doesn't exist in current directory; try in INIT directory.  */
-  if (!res && (cp = getenv ("INIT")))
+#if defined (MSDOS) || defined (_WIN32)
+  const char *cp = getenv ("INIT");
+  if (!res)

     {
     {

-      res = XMALLOC (char, strlen (cp) + strlen (skeleton) + 2);
-      sprintf (res, "%s%c%s", cp, '/', skeleton);
+      /* Skeleton file name without path */
+      const char *skel_name = strrchr (skeleton_name, '/');
+      if (!skel_name)
+        skel_name = strrchr (skeleton_name, '\\');
+      if (!skel_name)
+        skel_name = skeleton_name;
+      else
+        ++skel_name;
+
+      /* File doesn't exist in current directory; try in INIT directory.  */
+      if (cp)
+       {
+         res = XMALLOC (char, strlen (cp) + strlen (skel_name) + 2);
+         sprintf (res, "%s%c%s", cp, '\\', skel_name);
+       }
+      else if (access (skel_name, 4) == 0) /* Look in current dir. */
+        res = skel_name;
+      else
+       {
+         /* Look in program locations dir. */
+         extern char *program_name;
+         cp = strrchr(program_name, '\\');
+         if (!cp)
+           return skeleton_name;
+         else
+           ++cp;
+         res = XMALLOC (char, cp - program_name + strlen (skel_name) + 1);
+         strncpy (res, program_name, cp - program_name);
+         strcpy (res + (cp - program_name), skel_name);
+       }

     }
     }

-#endif /* !MSDOS */
-
+#endif /* defined (MSDOS) || defined (_WIN32) */

   if (!res)
   if (!res)

-    res = skeleton;
+    res = skeleton_name;

 
   return res;
 }
 
   return res;
 }

-

 \f
 \f

-/*-----------------------------------------------------------------.
-| Open the input file.  Look for the skeletons.  Find the names of |
-| the output files.  Prepare the obstacks.                         |
-`-----------------------------------------------------------------*/

 
 

-void
-open_files (void)
+/*----------------------------------------------------------------.
+| Compute BASE_NAME, SHORT_BASE_NAME and output files extensions. |
+`----------------------------------------------------------------*/
+
+/* Replace all characters FROM by TO in the string IN.
+   and returns a new allocated string.  */
+static char *
+tr (const char *in, char from, char to)

 {
 {

-  char *name_base;
-#ifdef MSDOS
-  register char *cp;
-#endif
-  int base_length;
-  int short_base_length;
-
-#if defined (VMS) & !defined (__VMS_POSIX)
-  const char *tmp_base = "sys$scratch:b_";
-#else
-  const char *tmp_base = "/tmp/b.";
-#endif
-  int tmp_len;
-
-#ifdef MSDOS
-  tmp_base = getenv ("TMP");
-  if (tmp_base == 0)
-    tmp_base = "";
-  strlwr (infile);
-#endif /* MSDOS */
-
-#if (defined(_WIN32) && !defined(__CYGWIN32__))
-  tmp_base = getenv ("TEMP");  /* Windows95 defines this ... */
-  if (tmp_base == 0)
-    tmp_base = getenv ("Temp");        /* ... while NT prefers this */
-  if (tmp_base == 0)
-    tmp_base = "";
-  strlwr (infile);
-#endif /* _WIN32 && !__CYGWIN32__ */
-
-#if (defined(unix) || defined(__unix) || defined(__unix__) || defined(__EMX__))
-  {
-    char *tmp_ptr = getenv ("TMPDIR");
-
-    if (tmp_ptr != 0)
-      tmp_base = stringappend (tmp_ptr, strlen (tmp_ptr), "/b.");
-  }
-#endif /* unix || __unix || __unix__ */
-
-  tmp_len = strlen (tmp_base);
+  char *temp;
+  char *out;
+
+  out = XMALLOC (char, strlen (in) + 1);
+
+  for (temp = out; *in; in++, out++)
+    if (*in == from)
+      *out = to;
+    else
+      *out = *in;
+  *out = 0;
+  return (temp);
+}

 
 

-  if (spec_outfile)
-    {
-      /* -o was specified.  The precise -o name will be used for FTABLE.
-         For other output files, remove the ".c" or ".tab.c" suffix.  */
-      name_base = spec_outfile;
-#ifdef MSDOS
-      strlwr (name_base);
-#endif /* MSDOS */
-      /* BASE_LENGTH includes ".tab" but not ".c".  */
-      base_length = strlen (name_base);
-      if (!strcmp (name_base + base_length - 2, ".c"))
-       base_length -= 2;
-      /* SHORT_BASE_LENGTH includes neither ".tab" nor ".c".  */
-      short_base_length = base_length;
-      if (!strncmp (name_base + short_base_length - 4, ".tab", 4))
-       short_base_length -= 4;
-      else if (!strncmp (name_base + short_base_length - 4, "_tab", 4))
-       short_base_length -= 4;
-    }
-  else if (spec_file_prefix)
-    {
-      /* -b was specified.  Construct names from it.  */
-      /* SHORT_BASE_LENGTH includes neither ".tab" nor ".c".  */
-      short_base_length = strlen (spec_file_prefix);
-      /* Count room for `.tab'.  */
-      base_length = short_base_length + 4;
-      name_base = XMALLOC (char, base_length + 1);
-      /* Append `.tab'.  */
-      strcpy (name_base, spec_file_prefix);
-      strcat (name_base, EXT_TAB);
-#ifdef MSDOS
-      strlwr (name_base);
-#endif /* MSDOS */
-    }
-  else
-    {
-      /* -o was not specified; compute output file name from input
-         or use y.tab.c, etc., if -y was specified.  */
+/* Computes extensions from the grammar file extension. */
+static void
+compute_exts_from_gf (const char *ext)
+{
+  src_extension = tr (ext, 'y', 'c');
+  src_extension = tr (src_extension, 'Y', 'C');
+  header_extension = tr (ext, 'y', 'h');
+  header_extension = tr (header_extension, 'Y', 'H');
+}

 
 

-      static char FIXED_NAME_BASE[] = "y.y";
+/* Computes extensions from the given c source file extension. */
+static void
+compute_exts_from_src (const char *ext)
+{
+  /* 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 = tr (ext, 'c', 'h');
+  header_extension = tr (header_extension, 'C', 'H');
+}

 
 

-      name_base = yacc_flag ? FIXED_NAME_BASE : infile;

 
 

-      /* BASE_LENGTH gets length of NAME_BASE, sans ".y" suffix if any.  */
+/* Decompose FILENAME in four parts: *BASE, *TAB, and *EXT, the fourth
+   part, (the directory) is ranging from FILENAME to the char before
+   *BASE, so we don't need an additional parameter.

 
 

-      base_length = strlen (name_base);
-      if (!strcmp (name_base + base_length - 2, ".y"))
-       base_length -= 2;
-      short_base_length = base_length;
+   *EXT points to the last period in the basename, or NULL if none.

 
 

-      name_base = stringappend (name_base, short_base_length, EXT_TAB);
-      base_length = short_base_length + 4;
-    }
+   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.

 
 

-  finput = xfopen (infile, "r");
+   None are allocated, they are simply pointers to parts of FILENAME.
+   Examples:

 
 

-  if (!no_parser_flag)
-    fparser = xfopen (skeleton_find ("BISON_SIMPLE", BISON_SIMPLE), "r");
+   '/tmp/foo.tab.c' -> *BASE = 'foo.tab.c', *TAB = '.tab.c', *EXT =
+   '.c'

 
 

-  if (verbose_flag)
-    {
-      /* We used to use just .out if spec_name_prefix (-p) was used,
-         but that conflicts with Posix.  */
-      outfile = stringappend (name_base, short_base_length, EXT_OUTPUT);
-      foutput = xfopen (outfile, "w");
-    }
+   'foo.c' -> *BASE = 'foo.c', *TAB = NULL, *EXT = '.c'

 
 

-  if (no_parser_flag)
-    {
-      /* use permanent name for actions file */
-      actfile = stringappend (name_base, short_base_length, ".act");
-    }
+   'tab.c' -> *BASE = 'tab.c', *TAB = NULL, *EXT = '.c'

 
 

-  if (defines_flag)
-    {
-      defsfile = stringappend (name_base, base_length, ".h");
-    }
+   '.tab.c' -> *BASE = '.tab.c', *TAB = NULL, *EXT = '.c'

 
 

-  /* These are opened by `done' or `open_extra_files', if at all */
-  if (spec_outfile)
-    tabfile = spec_outfile;
-  else
-    tabfile = stringappend (name_base, base_length, ".c");
+   'foo.tab' -> *BASE = 'foo.tab', *TAB = NULL, *EXT = '.tab'

 
 

-  attrsfile = stringappend (name_base, short_base_length, EXT_STYPE_H);
-  guardfile = stringappend (name_base, short_base_length, EXT_GUARD_C);
+   'foo_tab' -> *BASE = 'foo_tab', *TAB = NULL, *EXT = NULL

 
 

-  /* Initialize the obstacks. */
-  obstack_init (&action_obstack);
-  obstack_init (&attrs_obstack);
-  obstack_init (&table_obstack);
-  obstack_init (&defines_obstack);
-}
+   'foo' -> *BASE = 'foo', *TAB = NULL, *EXT = NULL.  */

 
 

+static void
+filename_split (const char *filename,
+               const char **base, const char **tab, const char **ext)
+{
+  *base = base_name (filename);
+
+  /* Look for the extension, i.e., look for the last dot. */
+  *ext = strrchr (*base, '.');
+  *tab = NULL;
+
+  /* If there is an exentension, check if there is a `.tab' part right
+     before.  */
+  if (*ext
+      && (*ext - *base) > (int) strlen (".tab")
+      && (!strncmp (*ext - strlen (".tab"), ".tab", strlen (".tab"))
+         || !strncmp (*ext - strlen ("_tab"), "_tab", strlen ("_tab"))))
+    *tab = *ext - strlen (".tab");
+}

 
 
 
 

-/*--------------------------------------------------------------------.
-| Open the output files needed only for the semantic parser.  This    |
-| is done when %semantic_parser is seen in the declarations section.  |
-`--------------------------------------------------------------------*/
+/* FIXME: Should use xstrndup. */

 
 

-void
-open_extra_files (void)
+static void
+compute_base_names (void)

 {
 {

-  xfclose (fparser);
+  const char *base, *tab, *ext;

 
 

-  if (!no_parser_flag)
-    fparser = xfopen (skeleton_find ("BISON_HAIRY", BISON_HAIRY), "r");
-  fguard = xfopen (guardfile, "w");
-}
+  /* 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'.
+
+     The precise -o name will be used for FTABLE.  For other output
+     files, remove the ".c" or ".tab.c" suffix.  */
+  if (spec_outfile)
+    {
+      filename_split (spec_outfile, &base, &tab, &ext);
+
+      /* The full base name goes up the EXT, excluding it. */
+      full_base_name =
+       xstrndup (spec_outfile,
+                 (strlen (spec_outfile) - (ext ? strlen (ext) : 0)));
+
+      /* The short base name goes up to TAB, excluding it.  */
+      short_base_name =
+       xstrndup (spec_outfile,
+                 (strlen (spec_outfile)
+                  - (tab ? strlen (tab) : (ext ? strlen (ext) : 0))));
+
+      if (tab)
+       output_infix = xstrndup (tab,
+                                (strlen (tab) - (ext ? strlen (ext) : 0)));
+
+      if (ext)
+       compute_exts_from_src (ext);
+    }
+
+  /* If --file-prefix=foo was specified, FULL_BASE_NAME = `foo.tab'
+     and SHORT_BASE_NAME = `foo'.

 
 

+     Construct names from it.  */
+  else
+    {
+      if (spec_file_prefix)
+       {
+         /* If --file-prefix=foo was specified, SHORT_BASE_NAME =
+            `foo'.  */
+         short_base_name = xstrdup (spec_file_prefix);
+       }
+      else if (yacc_flag)
+       {
+         /* If --yacc, then the output is `y.tab.c'. */
+         short_base_name = xstrdup ("y");
+       }
+      else
+       {
+         /* Otherwise, the short base name is computed from the input
+            grammar: `foo/bar.yy' => `bar'.  */
+         filename_split (infile, &base, &tab, &ext);
+         short_base_name =
+           xstrndup (base,
+                     (strlen (base) - (ext ? strlen (ext) : 0)));
+       }
+
+      /* In these cases, always append `.tab'. */
+      output_infix = xstrdup (EXT_TAB);
+
+      full_base_name = XMALLOC (char,
+                               strlen (short_base_name)
+                               + strlen (EXT_TAB) + 1);
+      stpcpy (stpcpy (full_base_name, short_base_name), EXT_TAB);
+
+      /* Computes the extensions from the grammar file name.  */
+      filename_split (infile, &base, &tab, &ext);
+      if (ext && !yacc_flag)
+       compute_exts_from_gf (ext);
+    }
+}

 
 

-/*-----------------------------------------------------.
-| Close the open files, produce all the output files.  |
-`-----------------------------------------------------*/
+/*-------------------------------------------------------.
+| Close the open files, compute the output files names.  |
+`-------------------------------------------------------*/

 
 void
 
 void

-output_files (void)
+compute_output_file_names (void)

 {
 {

-  xfclose (fguard);
-  xfclose (finput);
-  xfclose (fparser);
-  xfclose (foutput);
-
-  /* Output the main file.  */
-  obstack_save (&table_obstack, tabfile);
-
-  /* Output the header file if wanted. */
-  if (defines_flag)
-    obstack_save (&defines_obstack, defsfile);
-
-  /* If we output only the table, dump the actions in ACTFILE.
-     */
-  if (no_parser_flag)
-    obstack_save (&action_obstack, actfile);
-
-  /* If we produced a semantic parser ATTRS_OBSTACK must be dumped
-     into its own file, ATTTRSFILE.  */
-  if (semantic_parser)
-    obstack_save (&attrs_obstack, attrsfile);
+  compute_base_names ();
+
+  /* If not yet done. */
+  if (!src_extension)
+    src_extension = ".c";
+  if (!header_extension)
+    header_extension = ".h";
+
+  parser_file_name =
+    spec_outfile ? spec_outfile : stringappend (full_base_name, src_extension);
+
+  /* It the defines filename if not given, we create it.  */
+  if (!spec_defines_file)
+    spec_defines_file = stringappend (full_base_name, header_extension);
+
+  /* It the graph filename if not given, we create it.  */
+  if (!spec_graph_file)
+    spec_graph_file = stringappend (short_base_name, ".vcg");
+
+  spec_verbose_file = stringappend (short_base_name, EXT_OUTPUT);

 }
 }