src/files.c

   1 /* Open and close files for Bison.
   2
   3    Copyright (C) 1984, 1986, 1989, 1992, 2000, 2001, 2002, 2003, 2004, 2005
   4    Free Software Foundation, Inc.
   5
   6    This file is part of Bison, the GNU Compiler Compiler.
   7
   8    Bison is free software; you can redistribute it and/or modify it
   9    under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2, or (at your option)
  11    any later version.
  12
  13    Bison is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with Bison; see the file COPYING.  If not, write to the Free
  20    Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.  */
  22
  23
  24 #include "system.h"
  25
  26 #include <error.h>
  27 #include <get-errno.h>
  28 #include <quote.h>
  29 #include <xstrndup.h>
  30
  31 #include "complain.h"
  32 #include "files.h"
  33 #include "getargs.h"
  34 #include "gram.h"
  35 #include "stdio-safer.h"
  36
  37 /* From basename.c.  Almost a lie, as it returns a char *. */
  38 const char *base_name (char const *name);
  39
  40 FILE *finput = NULL;
  41
  42 struct obstack pre_prologue_obstack;
  43 struct obstack post_prologue_obstack;
  44
  45 /* Initializing some values below (such SPEC_NAME_PREFIX to `yy') is
  46    tempting, but don't do that: for the time being our handling of the
  47    %directive vs --option leaves precedence to the options by deciding
  48    that if a %directive sets a variable which is really set (i.e., not
  49    NULL), then the %directive is ignored.  As a result, %name-prefix,
  50    for instance, will not be honored.  */
  51
  52 char *spec_outfile = NULL;      /* for -o. */
  53 char *spec_file_prefix = NULL;  /* for -b. */
  54 const char *spec_name_prefix = NULL;    /* for -p. */
  55 char *spec_verbose_file = NULL;   /* for --verbose. */
  56 char *spec_graph_file = NULL;   /* for -g. */
  57 char *spec_defines_file = NULL; /* for --defines. */
  58 char *parser_file_name = NULL;
  59
  60 uniqstr grammar_file = NULL;
  61 uniqstr current_file = NULL;
  62
  63 static char *full_base_name = NULL;
  64
  65 /* Prefix used to generate output file names.  */
  66 char *short_base_name = NULL;
  67
  68 /* C source file extension (the parser source).  */
  69 const char *src_extension = NULL;
  70 /* Header file extension (if option ``-d'' is specified).  */
  71 const char *header_extension = NULL;
  72 \f
  73 /*-----------------------------------------------------------------.
  74 | Return a newly allocated string composed of the concatenation of |
  75 | STR1, and STR2.                                                  |
  76 `-----------------------------------------------------------------*/
  77
  78 static char *
  79 concat2 (char const *str1, char const *str2)
  80 {
  81   size_t len = strlen (str1) + strlen (str2);
  82   char *res = xmalloc (len + 1);
  83   char *cp;
  84   cp = stpcpy (res, str1);
  85   cp = stpcpy (cp, str2);
  86   return res;
  87 }
  88
  89 /*-----------------------------------------------------------------.
  90 | Try to open file NAME with mode MODE, and print an error message |
  91 | if fails.                                                        |
  92 `-----------------------------------------------------------------*/
  93
  94 FILE *
  95 xfopen (const char *name, const char *mode)
  96 {
  97   FILE *ptr;
  98
  99   ptr = fopen_safer (name, mode);
 100   if (!ptr)
 101     error (EXIT_FAILURE, get_errno (), _("cannot open file `%s'"), name);
 102
 103   return ptr;
 104 }
 105
 106 /*-------------------------------------------------------------.
 107 | Try to close file PTR, and print an error message if fails.  |
 108 `-------------------------------------------------------------*/
 109
 110 void
 111 xfclose (FILE *ptr)
 112 {
 113   if (ptr == NULL)
 114     return;
 115
 116   if (ferror (ptr))
 117     error (EXIT_FAILURE, 0, _("I/O error"));
 118
 119   if (fclose (ptr) != 0)
 120     error (EXIT_FAILURE, get_errno (), _("cannot close file"));
 121 }
 122 \f
 123
 124 /*---------------------------------------------------------------------.
 125 | Compute FULL_BASE_NAME, SHORT_BASE_NAME and output files extensions. |
 126 `---------------------------------------------------------------------*/
 127
 128 /* Replace all characters FROM by TO in the string IN.
 129    and returns a new allocated string.  */
 130 static char *
 131 tr (const char *in, char from, char to)
 132 {
 133   char *temp;
 134   char *out = xmalloc (strlen (in) + 1);
 135
 136   for (temp = out; *in; in++, out++)
 137     if (*in == from)
 138       *out = to;
 139     else
 140       *out = *in;
 141   *out = 0;
 142   return (temp);
 143 }
 144
 145 /* Compute extensions from the grammar file extension.  */
 146 static void
 147 compute_exts_from_gf (const char *ext)
 148 {
 149   src_extension = tr (ext, 'y', 'c');
 150   src_extension = tr (src_extension, 'Y', 'C');
 151   header_extension = tr (ext, 'y', 'h');
 152   header_extension = tr (header_extension, 'Y', 'H');
 153 }
 154
 155 /* Compute extensions from the given c source file extension.  */
 156 static void
 157 compute_exts_from_src (const char *ext)
 158 {
 159   /* We use this function when the user specifies `-o' or `--output',
 160      so the extenions must be computed unconditionally from the file name
 161      given by this option.  */
 162   src_extension = xstrdup (ext);
 163   header_extension = tr (ext, 'c', 'h');
 164   header_extension = tr (header_extension, 'C', 'H');
 165 }
 166
 167
 168 /* Decompose FILENAME in four parts: *BASE, *TAB, and *EXT, the fourth
 169    part, (the directory) is ranging from FILENAME to the char before
 170    *BASE, so we don't need an additional parameter.
 171
 172    *EXT points to the last period in the basename, or NULL if none.
 173
 174    If there is no *EXT, *TAB is NULL.  Otherwise, *TAB points to
 175    `.tab' or `_tab' if present right before *EXT, or is NULL. *TAB
 176    cannot be equal to *BASE.
 177
 178    None are allocated, they are simply pointers to parts of FILENAME.
 179    Examples:
 180
 181    '/tmp/foo.tab.c' -> *BASE = 'foo.tab.c', *TAB = '.tab.c', *EXT =
 182    '.c'
 183
 184    'foo.c' -> *BASE = 'foo.c', *TAB = NULL, *EXT = '.c'
 185
 186    'tab.c' -> *BASE = 'tab.c', *TAB = NULL, *EXT = '.c'
 187
 188    '.tab.c' -> *BASE = '.tab.c', *TAB = NULL, *EXT = '.c'
 189
 190    'foo.tab' -> *BASE = 'foo.tab', *TAB = NULL, *EXT = '.tab'
 191
 192    'foo_tab' -> *BASE = 'foo_tab', *TAB = NULL, *EXT = NULL
 193
 194    'foo' -> *BASE = 'foo', *TAB = NULL, *EXT = NULL.  */
 195
 196 static void
 197 filename_split (const char *filename,
 198                 const char **base, const char **tab, const char **ext)
 199 {
 200   *base = base_name (filename);
 201
 202   /* Look for the extension, i.e., look for the last dot. */
 203   *ext = strrchr (*base, '.');
 204   *tab = NULL;
 205
 206   /* If there is an extension, check if there is a `.tab' part right
 207      before.  */
 208   if (*ext)
 209     {
 210       size_t baselen = *ext - *base;
 211       size_t dottablen = 4;
 212       if (dottablen < baselen
 213           && (strncmp (*ext - dottablen, ".tab", dottablen) == 0
 214               || strncmp (*ext - dottablen, "_tab", dottablen) == 0))
 215         *tab = *ext - dottablen;
 216     }
 217 }
 218
 219
 220 /* FIXME: Should use xstrndup. */
 221
 222 static void
 223 compute_base_names (void)
 224 {
 225   const char *base, *tab, *ext;
 226
 227   /* If --output=foo.c was specified (SPEC_OUTFILE == foo.c),
 228      FULL_BASE_NAME and SHORT_BASE_NAME are `foo'.
 229
 230      If --output=foo.tab.c was specified, FULL_BASE_NAME is `foo.tab'
 231      and SHORT_BASE_NAME is `foo'.
 232
 233      The precise -o name will be used for FTABLE.  For other output
 234      files, remove the ".c" or ".tab.c" suffix.  */
 235   if (spec_outfile)
 236     {
 237       filename_split (spec_outfile, &base, &tab, &ext);
 238
 239       /* The full base name goes up the EXT, excluding it. */
 240       full_base_name =
 241         xstrndup (spec_outfile,
 242                   (strlen (spec_outfile) - (ext ? strlen (ext) : 0)));
 243
 244       /* The short base name goes up to TAB, excluding it.  */
 245       short_base_name =
 246         xstrndup (spec_outfile,
 247                   (strlen (spec_outfile)
 248                    - (tab ? strlen (tab) : (ext ? strlen (ext) : 0))));
 249
 250       if (ext)
 251         compute_exts_from_src (ext);
 252     }
 253
 254   /* If --file-prefix=foo was specified, FULL_BASE_NAME = `foo.tab'
 255      and SHORT_BASE_NAME = `foo'.
 256
 257      Construct names from it.  */
 258   else
 259     {
 260       if (spec_file_prefix)
 261         {
 262           /* If --file-prefix=foo was specified, SHORT_BASE_NAME =
 263              `foo'.  */
 264           short_base_name = xstrdup (spec_file_prefix);
 265         }
 266       else if (yacc_flag)
 267         {
 268           /* If --yacc, then the output is `y.tab.c'. */
 269           short_base_name = xstrdup ("y");
 270         }
 271       else
 272         {
 273           /* Otherwise, the short base name is computed from the input
 274              grammar: `foo/bar.yy' => `bar'.  */
 275           filename_split (grammar_file, &base, &tab, &ext);
 276           short_base_name =
 277             xstrndup (base,
 278                       (strlen (base) - (ext ? strlen (ext) : 0)));
 279         }
 280
 281       full_base_name = xmalloc (strlen (short_base_name)
 282                                 + strlen (TAB_EXT) + 1);
 283       stpcpy (stpcpy (full_base_name, short_base_name), TAB_EXT);
 284
 285       /* Compute the extensions from the grammar file name.  */
 286       filename_split (grammar_file, &base, &tab, &ext);
 287       if (ext && !yacc_flag)
 288         compute_exts_from_gf (ext);
 289     }
 290 }
 291
 292
 293 /* Compute the output file names.  Warn if we detect conflicting
 294    outputs to the same file.  */
 295
 296 void
 297 compute_output_file_names (void)
 298 {
 299   char const *name[4];
 300   int i;
 301   int j;
 302   int names = 0;
 303
 304   compute_base_names ();
 305
 306   /* If not yet done. */
 307   if (!src_extension)
 308     src_extension = ".c";
 309   if (!header_extension)
 310     header_extension = ".h";
 311
 312   name[names++] = parser_file_name =
 313     spec_outfile ? spec_outfile : concat2 (full_base_name, src_extension);
 314
 315   if (defines_flag)
 316     {
 317       if (! spec_defines_file)
 318         spec_defines_file = concat2 (full_base_name, header_extension);
 319       name[names++] = spec_defines_file;
 320     }
 321
 322   if (graph_flag)
 323     {
 324       if (! spec_graph_file)
 325         spec_graph_file = concat2 (short_base_name, ".vcg");
 326       name[names++] = spec_graph_file;
 327     }
 328
 329   if (report_flag)
 330     {
 331       spec_verbose_file = concat2 (short_base_name, OUTPUT_EXT);
 332       name[names++] = spec_verbose_file;
 333     }
 334
 335   for (j = 0; j < names; j++)
 336     for (i = 0; i < j; i++)
 337       if (strcmp (name[i], name[j]) == 0)
 338         warn (_("conflicting outputs to file %s"), quote (name[i]));
 339 }