src/files.c

   1 /* Open and close files for Bison.
   2
   3    Copyright (C) 1984, 1986, 1989, 1992, 2000-2015 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 typedef struct generated_file
  55 {
  56   /** File name.  */
  57   char *name;
  58   /** Whether is a generated source file (e.g., *.c, *.java...), as
  59       opposed to the report file (e.g., *.output).  When late errors
  60       are detected, generated source files are removed.  */
  61   bool is_source;
  62 } generated_file;
  63 static generated_file *generated_files = NULL;
  64 static int generated_files_size = 0;
  65
  66 uniqstr grammar_file = NULL;
  67 uniqstr current_file = NULL;
  68
  69 /* If --output=dir/foo.c was specified,
  70    DIR_PREFIX is 'dir/' and ALL_BUT_EXT and ALL_BUT_TAB_EXT are 'dir/foo'.
  71
  72    If --output=dir/foo.tab.c was specified, DIR_PREFIX is 'dir/',
  73    ALL_BUT_EXT is 'dir/foo.tab', and ALL_BUT_TAB_EXT is 'dir/foo'.
  74
  75    If --output was not specified but --file-prefix=dir/foo was specified,
  76    ALL_BUT_EXT = 'foo.tab' and ALL_BUT_TAB_EXT = 'foo'.
  77
  78    If neither --output nor --file was specified but the input grammar
  79    is name dir/foo.y, ALL_BUT_EXT and ALL_BUT_TAB_EXT are 'foo'.
  80
  81    If neither --output nor --file was specified, DIR_PREFIX is the
  82    empty string (meaning the current directory); otherwise it is
  83    'dir/'.  */
  84
  85 char *all_but_ext;
  86 static char *all_but_tab_ext;
  87 char *dir_prefix;
  88
  89 /* C source file extension (the parser source).  */
  90 static char *src_extension = NULL;
  91 /* Header file extension (if option '`-d'' is specified).  */
  92 static char *header_extension = NULL;
  93 \f
  94 /*-----------------------------------------------------------------.
  95 | Return a newly allocated string composed of the concatenation of |
  96 | STR1, and STR2.                                                  |
  97 `-----------------------------------------------------------------*/
  98
  99 static char *
 100 concat2 (char const *str1, char const *str2)
 101 {
 102   size_t len = strlen (str1) + strlen (str2);
 103   char *res = xmalloc (len + 1);
 104   char *cp;
 105   cp = stpcpy (res, str1);
 106   cp = stpcpy (cp, str2);
 107   return res;
 108 }
 109
 110 /*-----------------------------------------------------------------.
 111 | Try to open file NAME with mode MODE, and print an error message |
 112 | if fails.                                                        |
 113 `-----------------------------------------------------------------*/
 114
 115 FILE *
 116 xfopen (const char *name, const char *mode)
 117 {
 118   FILE *ptr;
 119
 120   ptr = fopen_safer (name, mode);
 121   if (!ptr)
 122     error (EXIT_FAILURE, get_errno (),
 123            _("%s: cannot open"), quotearg_colon (name));
 124
 125   return ptr;
 126 }
 127
 128 /*-------------------------------------------------------------.
 129 | Try to close file PTR, and print an error message if fails.  |
 130 `-------------------------------------------------------------*/
 131
 132 void
 133 xfclose (FILE *ptr)
 134 {
 135   if (ptr == NULL)
 136     return;
 137
 138   if (ferror (ptr))
 139     error (EXIT_FAILURE, 0, _("input/output error"));
 140
 141   if (fclose (ptr) != 0)
 142     error (EXIT_FAILURE, get_errno (), _("cannot close file"));
 143 }
 144 \f
 145
 146 FILE *
 147 xfdopen (int fd, char const *mode)
 148 {
 149   FILE *res = fdopen (fd, mode);
 150   if (! res)
 151     error (EXIT_FAILURE, get_errno (),
 152            /* On a separate line to please the "unmarked_diagnostics"
 153               syntax-check. */
 154            "fdopen");
 155   return res;
 156 }
 157
 158 /*------------------------------------------------------------------.
 159 | Compute ALL_BUT_EXT, ALL_BUT_TAB_EXT and output files extensions. |
 160 `------------------------------------------------------------------*/
 161
 162 /* Compute extensions from the grammar file extension.  */
 163 static void
 164 compute_exts_from_gf (const char *ext)
 165 {
 166   if (STREQ (ext, ".y"))
 167     {
 168       src_extension = xstrdup (language->src_extension);
 169       header_extension = xstrdup (language->header_extension);
 170     }
 171   else
 172     {
 173       src_extension = xstrdup (ext);
 174       header_extension = xstrdup (ext);
 175       tr (src_extension, 'y', 'c');
 176       tr (src_extension, 'Y', 'C');
 177       tr (header_extension, 'y', 'h');
 178       tr (header_extension, 'Y', 'H');
 179     }
 180 }
 181
 182 /* Compute extensions from the given c source file extension.  */
 183 static void
 184 compute_exts_from_src (const char *ext)
 185 {
 186   /* We use this function when the user specifies `-o' or `--output',
 187      so the extenions must be computed unconditionally from the file name
 188      given by this option.  */
 189   src_extension = xstrdup (ext);
 190   header_extension = xstrdup (ext);
 191   tr (header_extension, 'c', 'h');
 192   tr (header_extension, 'C', 'H');
 193 }
 194
 195
 196 /* Decompose FILE_NAME in four parts: *BASE, *TAB, and *EXT, the fourth
 197    part, (the directory) is ranging from FILE_NAME to the char before
 198    *BASE, so we don't need an additional parameter.
 199
 200    *EXT points to the last period in the basename, or NULL if none.
 201
 202    If there is no *EXT, *TAB is NULL.  Otherwise, *TAB points to
 203    '.tab' or '_tab' if present right before *EXT, or is NULL. *TAB
 204    cannot be equal to *BASE.
 205
 206    None are allocated, they are simply pointers to parts of FILE_NAME.
 207    Examples:
 208
 209    '/tmp/foo.tab.c' -> *BASE = 'foo.tab.c', *TAB = '.tab.c', *EXT =
 210    '.c'
 211
 212    'foo.c' -> *BASE = 'foo.c', *TAB = NULL, *EXT = '.c'
 213
 214    'tab.c' -> *BASE = 'tab.c', *TAB = NULL, *EXT = '.c'
 215
 216    '.tab.c' -> *BASE = '.tab.c', *TAB = NULL, *EXT = '.c'
 217
 218    'foo.tab' -> *BASE = 'foo.tab', *TAB = NULL, *EXT = '.tab'
 219
 220    'foo_tab' -> *BASE = 'foo_tab', *TAB = NULL, *EXT = NULL
 221
 222    'foo' -> *BASE = 'foo', *TAB = NULL, *EXT = NULL.  */
 223
 224 static void
 225 file_name_split (const char *file_name,
 226                  const char **base, const char **tab, const char **ext)
 227 {
 228   *base = last_component (file_name);
 229
 230   /* Look for the extension, i.e., look for the last dot. */
 231   *ext = strrchr (*base, '.');
 232   *tab = NULL;
 233
 234   /* If there is an extension, check if there is a '.tab' part right
 235      before.  */
 236   if (*ext)
 237     {
 238       size_t baselen = *ext - *base;
 239       size_t dottablen = sizeof (TAB_EXT) - 1;
 240       if (dottablen < baselen
 241           && STRPREFIX_LIT (TAB_EXT, *ext - dottablen))
 242         *tab = *ext - dottablen;
 243     }
 244 }
 245
 246
 247 static void
 248 compute_file_name_parts (void)
 249 {
 250   const char *base, *tab, *ext;
 251
 252   /* Compute ALL_BUT_EXT and ALL_BUT_TAB_EXT from SPEC_OUTFILE
 253      or GRAMMAR_FILE.
 254
 255      The precise -o name will be used for FTABLE.  For other output
 256      files, remove the ".c" or ".tab.c" suffix.  */
 257   if (spec_outfile)
 258     {
 259       file_name_split (spec_outfile, &base, &tab, &ext);
 260       dir_prefix = xstrndup (spec_outfile, base - spec_outfile);
 261
 262       /* ALL_BUT_EXT goes up the EXT, excluding it. */
 263       all_but_ext =
 264         xstrndup (spec_outfile,
 265                   (strlen (spec_outfile) - (ext ? strlen (ext) : 0)));
 266
 267       /* ALL_BUT_TAB_EXT goes up to TAB, excluding it.  */
 268       all_but_tab_ext =
 269         xstrndup (spec_outfile,
 270                   (strlen (spec_outfile)
 271                    - (tab ? strlen (tab) : (ext ? strlen (ext) : 0))));
 272
 273       if (ext)
 274         compute_exts_from_src (ext);
 275     }
 276   else
 277     {
 278       file_name_split (grammar_file, &base, &tab, &ext);
 279
 280       if (spec_file_prefix)
 281         {
 282           /* If --file-prefix=foo was specified, ALL_BUT_TAB_EXT = 'foo'.  */
 283           dir_prefix =
 284             xstrndup (spec_file_prefix,
 285                       last_component (spec_file_prefix) - spec_file_prefix);
 286           all_but_tab_ext = xstrdup (spec_file_prefix);
 287         }
 288       else if (yacc_flag)
 289         {
 290           /* If --yacc, then the output is 'y.tab.c'.  */
 291           dir_prefix = xstrdup ("");
 292           all_but_tab_ext = xstrdup ("y");
 293         }
 294       else
 295         {
 296           /* Otherwise, ALL_BUT_TAB_EXT is computed from the input
 297              grammar: 'foo/bar.yy' => 'bar'.  */
 298           dir_prefix = xstrdup ("");
 299           all_but_tab_ext =
 300             xstrndup (base, (strlen (base) - (ext ? strlen (ext) : 0)));
 301         }
 302
 303       if (language->add_tab)
 304         all_but_ext = concat2 (all_but_tab_ext, TAB_EXT);
 305       else
 306         all_but_ext = xstrdup (all_but_tab_ext);
 307
 308       /* Compute the extensions from the grammar file name.  */
 309       if (ext && !yacc_flag)
 310         compute_exts_from_gf (ext);
 311     }
 312 }
 313
 314
 315 /* Compute the output file names.  Warn if we detect conflicting
 316    outputs to the same file.  */
 317
 318 void
 319 compute_output_file_names (void)
 320 {
 321   compute_file_name_parts ();
 322
 323   /* If not yet done. */
 324   if (!src_extension)
 325     src_extension = xstrdup (".c");
 326   if (!header_extension)
 327     header_extension = xstrdup (".h");
 328
 329   parser_file_name =
 330     (spec_outfile
 331      ? xstrdup (spec_outfile)
 332      : concat2 (all_but_ext, src_extension));
 333
 334   if (defines_flag)
 335     {
 336       if (! spec_defines_file)
 337         spec_defines_file = concat2 (all_but_ext, header_extension);
 338     }
 339
 340   if (graph_flag)
 341     {
 342       if (! spec_graph_file)
 343         spec_graph_file = concat2 (all_but_tab_ext, ".dot");
 344       output_file_name_check (&spec_graph_file, false);
 345     }
 346
 347   if (xml_flag)
 348     {
 349       if (! spec_xml_file)
 350         spec_xml_file = concat2 (all_but_tab_ext, ".xml");
 351       output_file_name_check (&spec_xml_file, false);
 352     }
 353
 354   if (report_flag)
 355     {
 356       if (!spec_verbose_file)
 357         spec_verbose_file = concat2 (all_but_tab_ext, OUTPUT_EXT);
 358       output_file_name_check (&spec_verbose_file, false);
 359     }
 360
 361   free (all_but_tab_ext);
 362   free (src_extension);
 363   free (header_extension);
 364 }
 365
 366 void
 367 output_file_name_check (char **file_name, bool source)
 368 {
 369   bool conflict = false;
 370   if (STREQ (*file_name, grammar_file))
 371     {
 372       complain (NULL, complaint, _("refusing to overwrite the input file %s"),
 373                 quote (*file_name));
 374       conflict = true;
 375     }
 376   else
 377     {
 378       int i;
 379       for (i = 0; i < generated_files_size; i++)
 380         if (STREQ (generated_files[i].name, *file_name))
 381           {
 382             complain (NULL, Wother, _("conflicting outputs to file %s"),
 383                       quote (generated_files[i].name));
 384             conflict = true;
 385           }
 386     }
 387   if (conflict)
 388     {
 389       free (*file_name);
 390       *file_name = strdup ("/dev/null");
 391     }
 392   else
 393     {
 394       generated_files = xnrealloc (generated_files, ++generated_files_size,
 395                                    sizeof *generated_files);
 396       generated_files[generated_files_size-1].name = xstrdup (*file_name);
 397       generated_files[generated_files_size-1].is_source = source;
 398     }
 399 }
 400
 401 void
 402 unlink_generated_sources (void)
 403 {
 404   int i;
 405   for (i = 0; i < generated_files_size; i++)
 406     if (generated_files[i].is_source)
 407       /* Ignore errors.  The file might not even exist.  */
 408       unlink (generated_files[i].name);
 409 }
 410
 411 void
 412 output_file_names_free (void)
 413 {
 414   free (all_but_ext);
 415   free (spec_verbose_file);
 416   free (spec_graph_file);
 417   free (spec_xml_file);
 418   free (spec_defines_file);
 419   free (parser_file_name);
 420   free (dir_prefix);
 421   {
 422     int i;
 423     for (i = 0; i < generated_files_size; i++)
 424       free (generated_files[i].name);
 425   }
 426   free (generated_files);
 427 }