src/files.c

   1 /* Open and close files for Bison.
   2
   3    Copyright (C) 1984, 1986, 1989, 1992, 2000-2012 Free Software
   4    Foundation, Inc.
   5
   6    This file is part of Bison, the GNU Compiler Compiler.
   7
   8    This program is free software: you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation, either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #include <config.h>
  22 #include "system.h"
  23
  24 #include <error.h>
  25 #include <dirname.h>
  26 #include <get-errno.h>
  27 #include <quote.h>
  28 #include <quotearg.h>
  29 #include <stdio-safer.h>
  30 #include <xstrndup.h>
  31
  32 #include "complain.h"
  33 #include "files.h"
  34 #include "getargs.h"
  35 #include "gram.h"
  36
  37 /* Initializing some values below (such SPEC_NAME_PREFIX to `yy') is
  38    tempting, but don't do that: for the time being our handling of the
  39    %directive vs --option leaves precedence to the options by deciding
  40    that if a %directive sets a variable which is really set (i.e., not
  41    NULL), then the %directive is ignored.  As a result, %name-prefix,
  42    for instance, will not be honored.  */
  43
  44 char const *spec_outfile = NULL;       /* for -o. */
  45 char const *spec_file_prefix = NULL;   /* for -b. */
  46 char const *spec_name_prefix = NULL;   /* for -p. */
  47 char *spec_verbose_file = NULL;  /* for --verbose. */
  48 char *spec_graph_file = NULL;    /* for -g. */
  49 char *spec_xml_file = NULL;      /* for -x. */
  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 (),
 114            _("%s: cannot open"), quotearg_colon (name));
 115
 116   return ptr;
 117 }
 118
 119 /*-------------------------------------------------------------.
 120 | Try to close file PTR, and print an error message if fails.  |
 121 `-------------------------------------------------------------*/
 122
 123 void
 124 xfclose (FILE *ptr)
 125 {
 126   if (ptr == NULL)
 127     return;
 128
 129   if (ferror (ptr))
 130     error (EXIT_FAILURE, 0, _("input/output error"));
 131
 132   if (fclose (ptr) != 0)
 133     error (EXIT_FAILURE, get_errno (), _("cannot close file"));
 134 }
 135 \f
 136
 137 FILE *
 138 xfdopen (int fd, char const *mode)
 139 {
 140   FILE *res = fdopen (fd, mode);
 141   if (! res)
 142     error (EXIT_FAILURE, get_errno (),
 143            // On a separate line to please the "unmarked_diagnostics"
 144            // syntax-check.
 145            "fdopen");
 146   return res;
 147 }
 148
 149 /*------------------------------------------------------------------.
 150 | Compute ALL_BUT_EXT, ALL_BUT_TAB_EXT and output files extensions. |
 151 `------------------------------------------------------------------*/
 152
 153 /* Compute extensions from the grammar file extension.  */
 154 static void
 155 compute_exts_from_gf (const char *ext)
 156 {
 157   if (STREQ (ext, ".y"))
 158     {
 159       src_extension = xstrdup (language->src_extension);
 160       header_extension = xstrdup (language->header_extension);
 161     }
 162   else
 163     {
 164       src_extension = xstrdup (ext);
 165       header_extension = xstrdup (ext);
 166       tr (src_extension, 'y', 'c');
 167       tr (src_extension, 'Y', 'C');
 168       tr (header_extension, 'y', 'h');
 169       tr (header_extension, 'Y', 'H');
 170     }
 171 }
 172
 173 /* Compute extensions from the given c source file extension.  */
 174 static void
 175 compute_exts_from_src (const char *ext)
 176 {
 177   /* We use this function when the user specifies `-o' or `--output',
 178      so the extenions must be computed unconditionally from the file name
 179      given by this option.  */
 180   src_extension = xstrdup (ext);
 181   header_extension = xstrdup (ext);
 182   tr (header_extension, 'c', 'h');
 183   tr (header_extension, 'C', 'H');
 184 }
 185
 186
 187 /* Decompose FILE_NAME in four parts: *BASE, *TAB, and *EXT, the fourth
 188    part, (the directory) is ranging from FILE_NAME to the char before
 189    *BASE, so we don't need an additional parameter.
 190
 191    *EXT points to the last period in the basename, or NULL if none.
 192
 193    If there is no *EXT, *TAB is NULL.  Otherwise, *TAB points to
 194    `.tab' or `_tab' if present right before *EXT, or is NULL. *TAB
 195    cannot be equal to *BASE.
 196
 197    None are allocated, they are simply pointers to parts of FILE_NAME.
 198    Examples:
 199
 200    '/tmp/foo.tab.c' -> *BASE = 'foo.tab.c', *TAB = '.tab.c', *EXT =
 201    '.c'
 202
 203    'foo.c' -> *BASE = 'foo.c', *TAB = NULL, *EXT = '.c'
 204
 205    'tab.c' -> *BASE = 'tab.c', *TAB = NULL, *EXT = '.c'
 206
 207    '.tab.c' -> *BASE = '.tab.c', *TAB = NULL, *EXT = '.c'
 208
 209    'foo.tab' -> *BASE = 'foo.tab', *TAB = NULL, *EXT = '.tab'
 210
 211    'foo_tab' -> *BASE = 'foo_tab', *TAB = NULL, *EXT = NULL
 212
 213    'foo' -> *BASE = 'foo', *TAB = NULL, *EXT = NULL.  */
 214
 215 static void
 216 file_name_split (const char *file_name,
 217                  const char **base, const char **tab, const char **ext)
 218 {
 219   *base = last_component (file_name);
 220
 221   /* Look for the extension, i.e., look for the last dot. */
 222   *ext = strrchr (*base, '.');
 223   *tab = NULL;
 224
 225   /* If there is an extension, check if there is a `.tab' part right
 226      before.  */
 227   if (*ext)
 228     {
 229       size_t baselen = *ext - *base;
 230       size_t dottablen = sizeof (TAB_EXT) - 1;
 231       if (dottablen < baselen
 232           && STRPREFIX_LIT (TAB_EXT, *ext - dottablen))
 233         *tab = *ext - dottablen;
 234     }
 235 }
 236
 237
 238 static void
 239 compute_file_name_parts (void)
 240 {
 241   const char *base, *tab, *ext;
 242
 243   /* Compute ALL_BUT_EXT and ALL_BUT_TAB_EXT from SPEC_OUTFILE
 244      or GRAMMAR_FILE.
 245
 246      The precise -o name will be used for FTABLE.  For other output
 247      files, remove the ".c" or ".tab.c" suffix.  */
 248   if (spec_outfile)
 249     {
 250       file_name_split (spec_outfile, &base, &tab, &ext);
 251       dir_prefix = xstrndup (spec_outfile, base - spec_outfile);
 252
 253       /* ALL_BUT_EXT goes up the EXT, excluding it. */
 254       all_but_ext =
 255         xstrndup (spec_outfile,
 256                   (strlen (spec_outfile) - (ext ? strlen (ext) : 0)));
 257
 258       /* ALL_BUT_TAB_EXT goes up to TAB, excluding it.  */
 259       all_but_tab_ext =
 260         xstrndup (spec_outfile,
 261                   (strlen (spec_outfile)
 262                    - (tab ? strlen (tab) : (ext ? strlen (ext) : 0))));
 263
 264       if (ext)
 265         compute_exts_from_src (ext);
 266     }
 267   else
 268     {
 269       file_name_split (grammar_file, &base, &tab, &ext);
 270
 271       if (spec_file_prefix)
 272         {
 273           /* If --file-prefix=foo was specified, ALL_BUT_TAB_EXT = `foo'.  */
 274           dir_prefix =
 275             xstrndup (spec_file_prefix,
 276                       last_component (spec_file_prefix) - spec_file_prefix);
 277           all_but_tab_ext = xstrdup (spec_file_prefix);
 278         }
 279       else if (yacc_flag)
 280         {
 281           /* If --yacc, then the output is `y.tab.c'.  */
 282           dir_prefix = xstrdup ("");
 283           all_but_tab_ext = xstrdup ("y");
 284         }
 285       else
 286         {
 287           /* Otherwise, ALL_BUT_TAB_EXT is computed from the input
 288              grammar: `foo/bar.yy' => `bar'.  */
 289           dir_prefix = xstrdup ("");
 290           all_but_tab_ext =
 291             xstrndup (base, (strlen (base) - (ext ? strlen (ext) : 0)));
 292         }
 293
 294       if (language->add_tab)
 295         all_but_ext = concat2 (all_but_tab_ext, TAB_EXT);
 296       else
 297         all_but_ext = xstrdup (all_but_tab_ext);
 298
 299       /* Compute the extensions from the grammar file name.  */
 300       if (ext && !yacc_flag)
 301         compute_exts_from_gf (ext);
 302     }
 303 }
 304
 305
 306 /* Compute the output file names.  Warn if we detect conflicting
 307    outputs to the same file.  */
 308
 309 void
 310 compute_output_file_names (void)
 311 {
 312   compute_file_name_parts ();
 313
 314   /* If not yet done. */
 315   if (!src_extension)
 316     src_extension = xstrdup (".c");
 317   if (!header_extension)
 318     header_extension = xstrdup (".h");
 319
 320   parser_file_name =
 321     (spec_outfile
 322      ? xstrdup (spec_outfile)
 323      : concat2 (all_but_ext, src_extension));
 324
 325   if (defines_flag)
 326     {
 327       if (! spec_defines_file)
 328         spec_defines_file = concat2 (all_but_ext, header_extension);
 329     }
 330
 331   if (graph_flag)
 332     {
 333       if (! spec_graph_file)
 334         spec_graph_file = concat2 (all_but_tab_ext, ".dot");
 335       output_file_name_check (&spec_graph_file);
 336     }
 337
 338   if (xml_flag)
 339     {
 340       if (! spec_xml_file)
 341         spec_xml_file = concat2 (all_but_tab_ext, ".xml");
 342       output_file_name_check (&spec_xml_file);
 343     }
 344
 345   if (report_flag)
 346     {
 347       if (!spec_verbose_file)
 348         spec_verbose_file = concat2 (all_but_tab_ext, OUTPUT_EXT);
 349       output_file_name_check (&spec_verbose_file);
 350     }
 351
 352   free (all_but_tab_ext);
 353   free (src_extension);
 354   free (header_extension);
 355 }
 356
 357 void
 358 output_file_name_check (char **file_name)
 359 {
 360   bool conflict = false;
 361   if (STREQ (*file_name, grammar_file))
 362     {
 363       complain (complaint, _("refusing to overwrite the input file %s"),
 364                 quote (*file_name));
 365       conflict = true;
 366     }
 367   else
 368     {
 369       int i;
 370       for (i = 0; i < file_names_count; i++)
 371         if (STREQ (file_names[i], *file_name))
 372           {
 373             complain (Wother, _("conflicting outputs to file %s"),
 374                       quote (*file_name));
 375             conflict = true;
 376           }
 377     }
 378   if (conflict)
 379     {
 380       free (*file_name);
 381       *file_name = strdup ("/dev/null");
 382     }
 383   else
 384     {
 385       file_names = xnrealloc (file_names, ++file_names_count,
 386                               sizeof *file_names);
 387       file_names[file_names_count-1] = xstrdup (*file_name);
 388     }
 389 }
 390
 391 void
 392 output_file_names_free (void)
 393 {
 394   free (all_but_ext);
 395   free (spec_verbose_file);
 396   free (spec_graph_file);
 397   free (spec_xml_file);
 398   free (spec_defines_file);
 399   free (parser_file_name);
 400   free (dir_prefix);
 401   {
 402     int i;
 403     for (i = 0; i < file_names_count; i++)
 404       free (file_names[i]);
 405   }
 406   free (file_names);
 407 }