src/files.c

   1 /* Open and close files for Bison.
   2
   3    Copyright (C) 1984, 1986, 1989, 1992, 2000, 2001, 2002, 2003, 2004,
   4    2005, 2006 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 #include <config.h>
  24 #include "system.h"
  25
  26 #include <error.h>
  27 #include <dirname.h>
  28 #include <get-errno.h>
  29 #include <quote.h>
  30 #include <stdio-safer.h>
  31 #include <xstrndup.h>
  32
  33 #include "complain.h"
  34 #include "files.h"
  35 #include "getargs.h"
  36 #include "gram.h"
  37
  38 /* Initializing some values below (such SPEC_NAME_PREFIX to `yy') is
  39    tempting, but don't do that: for the time being our handling of the
  40    %directive vs --option leaves precedence to the options by deciding
  41    that if a %directive sets a variable which is really set (i.e., not
  42    NULL), then the %directive is ignored.  As a result, %name-prefix,
  43    for instance, will not be honored.  */
  44
  45 char const *spec_outfile = NULL;       /* for -o. */
  46 char const *spec_file_prefix = NULL;   /* for -b. */
  47 char const *spec_name_prefix = NULL;   /* for -p. */
  48 char *spec_verbose_file = NULL;  /* for --verbose. */
  49 char *spec_graph_file = NULL;    /* for -g. */
  50 char *spec_defines_file = NULL;  /* for --defines. */
  51 char *parser_file_name;
  52
  53 /* All computed output file names.  */
  54 static char **file_names = NULL;
  55 static int file_names_count = 0;
  56
  57 uniqstr grammar_file = NULL;
  58 uniqstr current_file = NULL;
  59
  60 /* If --output=dir/foo.c was specified,
  61    DIR_PREFIX is `dir/' and ALL_BUT_EXT and ALL_BUT_TAB_EXT are `dir/foo'.
  62
  63    If --output=dir/foo.tab.c was specified, DIR_PREFIX is `dir/',
  64    ALL_BUT_EXT is `dir/foo.tab', and ALL_BUT_TAB_EXT is `dir/foo'.
  65
  66    If --output was not specified but --file-prefix=dir/foo was specified,
  67    ALL_BUT_EXT = `foo.tab' and ALL_BUT_TAB_EXT = `foo'.
  68
  69    If neither --output nor --file was specified but the input grammar
  70    is name dir/foo.y, ALL_BUT_EXT and ALL_BUT_TAB_EXT are `foo'.
  71
  72    If neither --output nor --file was specified, DIR_PREFIX is the
  73    empty string (meaning the current directory); otherwise it is
  74    `dir/'.  */
  75
  76 char *all_but_ext;
  77 static char *all_but_tab_ext;
  78 char *dir_prefix;
  79
  80 /* C source file extension (the parser source).  */
  81 static char *src_extension = NULL;
  82 /* Header file extension (if option ``-d'' is specified).  */
  83 static char *header_extension = NULL;
  84 \f
  85 /*-----------------------------------------------------------------.
  86 | Return a newly allocated string composed of the concatenation of |
  87 | STR1, and STR2.                                                  |
  88 `-----------------------------------------------------------------*/
  89
  90 static char *
  91 concat2 (char const *str1, char const *str2)
  92 {
  93   size_t len = strlen (str1) + strlen (str2);
  94   char *res = xmalloc (len + 1);
  95   char *cp;
  96   cp = stpcpy (res, str1);
  97   cp = stpcpy (cp, str2);
  98   return res;
  99 }
 100
 101 /*-----------------------------------------------------------------.
 102 | Try to open file NAME with mode MODE, and print an error message |
 103 | if fails.                                                        |
 104 `-----------------------------------------------------------------*/
 105
 106 FILE *
 107 xfopen (const char *name, const char *mode)
 108 {
 109   FILE *ptr;
 110
 111   ptr = fopen_safer (name, mode);
 112   if (!ptr)
 113     error (EXIT_FAILURE, get_errno (), _("cannot open file `%s'"), name);
 114
 115   return ptr;
 116 }
 117
 118 /*-------------------------------------------------------------.
 119 | Try to close file PTR, and print an error message if fails.  |
 120 `-------------------------------------------------------------*/
 121
 122 void
 123 xfclose (FILE *ptr)
 124 {
 125   if (ptr == NULL)
 126     return;
 127
 128   if (ferror (ptr))
 129     error (EXIT_FAILURE, 0, _("I/O error"));
 130
 131   if (fclose (ptr) != 0)
 132     error (EXIT_FAILURE, get_errno (), _("cannot close file"));
 133 }
 134 \f
 135
 136 /*------------------------------------------------------------------.
 137 | Compute ALL_BUT_EXT, ALL_BUT_TAB_EXT and output files extensions. |
 138 `------------------------------------------------------------------*/
 139
 140 /* In the string S, replace all characters FROM by TO.  */
 141 static void
 142 tr (char *s, char from, char to)
 143 {
 144   for (; *s; s++)
 145     if (*s == from)
 146       *s = to;
 147 }
 148
 149 /* Compute extensions from the grammar file extension.  */
 150 static void
 151 compute_exts_from_gf (const char *ext)
 152 {
 153   if (strcmp (ext, ".y") == 0)
 154     {
 155       src_extension = xstrdup (language->src_extension);
 156       header_extension = xstrdup (language->header_extension);
 157     }
 158   else
 159     {
 160       src_extension = xstrdup (ext);
 161       header_extension = xstrdup (ext);
 162       tr (src_extension, 'y', 'c');
 163       tr (src_extension, 'Y', 'C');
 164       tr (header_extension, 'y', 'h');
 165       tr (header_extension, 'Y', 'H');
 166     }
 167 }
 168
 169 /* Compute extensions from the given c source file extension.  */
 170 static void
 171 compute_exts_from_src (const char *ext)
 172 {
 173   /* We use this function when the user specifies `-o' or `--output',
 174      so the extenions must be computed unconditionally from the file name
 175      given by this option.  */
 176   src_extension = xstrdup (ext);
 177   header_extension = xstrdup (ext);
 178   tr (header_extension, 'c', 'h');
 179   tr (header_extension, 'C', 'H');
 180 }
 181
 182
 183 /* Decompose FILE_NAME in four parts: *BASE, *TAB, and *EXT, the fourth
 184    part, (the directory) is ranging from FILE_NAME to the char before
 185    *BASE, so we don't need an additional parameter.
 186
 187    *EXT points to the last period in the basename, or NULL if none.
 188
 189    If there is no *EXT, *TAB is NULL.  Otherwise, *TAB points to
 190    `.tab' or `_tab' if present right before *EXT, or is NULL. *TAB
 191    cannot be equal to *BASE.
 192
 193    None are allocated, they are simply pointers to parts of FILE_NAME.
 194    Examples:
 195
 196    '/tmp/foo.tab.c' -> *BASE = 'foo.tab.c', *TAB = '.tab.c', *EXT =
 197    '.c'
 198
 199    'foo.c' -> *BASE = 'foo.c', *TAB = NULL, *EXT = '.c'
 200
 201    'tab.c' -> *BASE = 'tab.c', *TAB = NULL, *EXT = '.c'
 202
 203    '.tab.c' -> *BASE = '.tab.c', *TAB = NULL, *EXT = '.c'
 204
 205    'foo.tab' -> *BASE = 'foo.tab', *TAB = NULL, *EXT = '.tab'
 206
 207    'foo_tab' -> *BASE = 'foo_tab', *TAB = NULL, *EXT = NULL
 208
 209    'foo' -> *BASE = 'foo', *TAB = NULL, *EXT = NULL.  */
 210
 211 static void
 212 file_name_split (const char *file_name,
 213                  const char **base, const char **tab, const char **ext)
 214 {
 215   *base = last_component (file_name);
 216
 217   /* Look for the extension, i.e., look for the last dot. */
 218   *ext = strrchr (*base, '.');
 219   *tab = NULL;
 220
 221   /* If there is an extension, check if there is a `.tab' part right
 222      before.  */
 223   if (*ext)
 224     {
 225       size_t baselen = *ext - *base;
 226       size_t dottablen = 4;
 227       if (dottablen < baselen
 228           && (strncmp (*ext - dottablen, ".tab", dottablen) == 0
 229               || strncmp (*ext - dottablen, "_tab", dottablen) == 0))
 230         *tab = *ext - dottablen;
 231     }
 232 }
 233
 234
 235 static void
 236 compute_file_name_parts (void)
 237 {
 238   const char *base, *tab, *ext;
 239
 240   /* Compute ALL_BUT_EXT and ALL_BUT_TAB_EXT from SPEC_OUTFILE
 241      or GRAMMAR_FILE.
 242
 243      The precise -o name will be used for FTABLE.  For other output
 244      files, remove the ".c" or ".tab.c" suffix.  */
 245   if (spec_outfile)
 246     {
 247       file_name_split (spec_outfile, &base, &tab, &ext);
 248       dir_prefix = xstrndup (spec_outfile, base - spec_outfile);
 249
 250       /* ALL_BUT_EXT goes up the EXT, excluding it. */
 251       all_but_ext =
 252         xstrndup (spec_outfile,
 253                   (strlen (spec_outfile) - (ext ? strlen (ext) : 0)));
 254
 255       /* ALL_BUT_TAB_EXT goes up to TAB, excluding it.  */
 256       all_but_tab_ext =
 257         xstrndup (spec_outfile,
 258                   (strlen (spec_outfile)
 259                    - (tab ? strlen (tab) : (ext ? strlen (ext) : 0))));
 260
 261       if (ext)
 262         compute_exts_from_src (ext);
 263     }
 264   else
 265     {
 266       file_name_split (grammar_file, &base, &tab, &ext);
 267
 268       if (spec_file_prefix)
 269         {
 270           /* If --file-prefix=foo was specified, ALL_BUT_TAB_EXT = `foo'.  */
 271           dir_prefix = xstrndup (grammar_file, base - grammar_file);
 272           all_but_tab_ext = xstrdup (spec_file_prefix);
 273         }
 274       else if (yacc_flag)
 275         {
 276           /* If --yacc, then the output is `y.tab.c'.  */
 277           dir_prefix = xstrdup ("");
 278           all_but_tab_ext = xstrdup ("y");
 279         }
 280       else
 281         {
 282           /* Otherwise, ALL_BUT_TAB_EXT is computed from the input
 283              grammar: `foo/bar.yy' => `bar'.  */
 284           dir_prefix = xstrdup ("");
 285           all_but_tab_ext =
 286             xstrndup (base, (strlen (base) - (ext ? strlen (ext) : 0)));
 287         }
 288
 289       if (language->add_tab)
 290         all_but_ext = concat2 (all_but_tab_ext, TAB_EXT);
 291       else
 292         all_but_ext = xstrdup (all_but_tab_ext);
 293
 294       /* Compute the extensions from the grammar file name.  */
 295       if (ext && !yacc_flag)
 296         compute_exts_from_gf (ext);
 297     }
 298 }
 299
 300
 301 /* Compute the output file names.  Warn if we detect conflicting
 302    outputs to the same file.  */
 303
 304 void
 305 compute_output_file_names (void)
 306 {
 307   compute_file_name_parts ();
 308
 309   /* If not yet done. */
 310   if (!src_extension)
 311     src_extension = xstrdup (".c");
 312   if (!header_extension)
 313     header_extension = xstrdup (".h");
 314
 315   parser_file_name =
 316     (spec_outfile
 317      ? xstrdup (spec_outfile)
 318      : concat2 (all_but_ext, src_extension));
 319
 320   if (defines_flag)
 321     {
 322       if (! spec_defines_file)
 323         spec_defines_file = concat2 (all_but_ext, header_extension);
 324     }
 325
 326   if (graph_flag)
 327     {
 328       if (! spec_graph_file)
 329         spec_graph_file = concat2 (all_but_tab_ext, ".dot");
 330       output_file_name_check (spec_graph_file);
 331     }
 332
 333   if (report_flag)
 334     {
 335       spec_verbose_file = concat2 (all_but_tab_ext, OUTPUT_EXT);
 336       output_file_name_check (spec_verbose_file);
 337     }
 338
 339   free (all_but_tab_ext);
 340   free (src_extension);
 341   free (header_extension);
 342 }
 343
 344 void
 345 output_file_name_check (char const *file_name)
 346 {
 347   {
 348     int i;
 349     for (i = 0; i < file_names_count; i++)
 350       if (0 == strcmp (file_names[i], file_name))
 351         warn (_("conflicting outputs to file %s"), quote (file_name));
 352   }
 353   file_names = xnrealloc (file_names, ++file_names_count, sizeof *file_names);
 354   file_names[file_names_count-1] = xstrdup (file_name);
 355 }
 356
 357 void
 358 output_file_names_free (void)
 359 {
 360   free (all_but_ext);
 361   free (spec_verbose_file);
 362   free (spec_graph_file);
 363   free (spec_defines_file);
 364   free (parser_file_name);
 365   free (dir_prefix);
 366   {
 367     int i;
 368     for (i = 0; i < file_names_count; i++)
 369       free (file_names[i]);
 370   }
 371   free (file_names);
 372 }