src/files.c

   1 /* Open and close files for bison,
   2    Copyright 1984, 1986, 1989, 1992, 2000, 2001, 2002
   3    Free Software Foundation, Inc.
   4
   5    This file is part of Bison, the GNU Compiler Compiler.
   6
   7    Bison is free software; you can redistribute it and/or modify it
   8    under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2, or (at your option)
  10    any later version.
  11
  12    Bison is distributed in the hope that it will be useful, but
  13    WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15    General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with Bison; see the file COPYING.  If not, write to the Free
  19    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  20    02111-1307, USA.  */
  21
  22
  23 #include "system.h"
  24 #include "getargs.h"
  25 #include "files.h"
  26 #include "gram.h"
  27 #include "error.h"
  28 #include "complain.h"
  29
  30 /* From basename.c.  Almost a lie, as it returns a char *. */
  31 const char *base_name PARAMS ((char const *name));
  32
  33 FILE *finput = NULL;
  34
  35 struct obstack action_obstack;
  36 struct obstack output_obstack;
  37 struct obstack pre_prologue_obstack;
  38 struct obstack post_prologue_obstack;
  39
  40 /* Initializing some values below (such SPEC_NAME_PREFIX to `yy') is
  41    tempting, but don't do that: for the time being our handling of the
  42    %directive vs --option leaves precedence to the options by deciding
  43    that if a %directive sets a variable which is really set (i.e., not
  44    NULL), then the %directive is ignored.  As a result, %name-prefix,
  45    for instance, will not be honored.  */
  46
  47 char *spec_outfile = NULL;      /* for -o. */
  48 char *spec_file_prefix = NULL;  /* for -b. */
  49 const char *spec_name_prefix = NULL;    /* for -p. */
  50 char *spec_verbose_file = NULL;   /* for --verbose. */
  51 char *spec_graph_file = NULL;   /* for -g. */
  52 char *spec_defines_file = NULL; /* for --defines. */
  53 char *parser_file_name = NULL;
  54
  55 char *infile = NULL;
  56 char *attrsfile = NULL;
  57
  58 static char *full_base_name = NULL;
  59
  60 /* Prefix used to generate output file names.  */
  61 char *short_base_name = NULL;
  62
  63 /* Infix used to generate output file names (i.e., `.tab', or `_tab',
  64    or `').  */
  65 char *output_infix = NULL;
  66
  67 /* C source file extension (the parser source).  */
  68 const char *src_extension = NULL;
  69 /* Header file extension (if option ``-d'' is specified).  */
  70 const char *header_extension = NULL;
  71 \f
  72
  73 /*--------------------------.
  74 | Is SUFFIX ending STRING?  |
  75 `--------------------------*/
  76
  77 int
  78 strsuffix (const char *string, const char *suffix)
  79 {
  80   size_t string_len = strlen (string);
  81   size_t suffix_len = strlen (suffix);
  82   if (suffix_len <= string_len)
  83     return !strcmp (string + string_len - suffix_len, suffix);
  84   else
  85     return 0;
  86 }
  87
  88
  89 /*-----------------------------------------------------------------.
  90 | Return a newly allocated string composed of the concatenation of |
  91 | STRING1, and STRING2.                                            |
  92 `-----------------------------------------------------------------*/
  93
  94 char*
  95 stringappend (const char *string1, const char *string2)
  96 {
  97   size_t len = strlen (string1) + strlen (string2);
  98   char *res = XMALLOC (char, len + 1);
  99   char *cp;
 100   cp = stpcpy (res, string1);
 101   cp = stpcpy (cp, string2);
 102   return res;
 103 }
 104
 105
 106 /*-----------------------------------------------------------------.
 107 | Computes the macro name used to avoid double inclusion in the    |
 108 | header of the parser and store it in header_macro_name.  Be sure |
 109 | to produce valid CPP names (don't start with digit, remain       |
 110 | alphanumerical + underscore).                                    |
 111 `-----------------------------------------------------------------*/
 112
 113 char *
 114 compute_header_macro (void)
 115 {
 116   const char *prefix = "BISON_";
 117   char *macro_name, *cp;
 118
 119   if (spec_defines_file)
 120     {
 121       macro_name = XMALLOC (char,
 122                             strlen (prefix) +
 123                             strlen (spec_defines_file) + 1);
 124       cp = stpcpy (macro_name, prefix);
 125       cp = stpcpy (cp, spec_defines_file);
 126     }
 127   else
 128     {
 129       macro_name = XMALLOC (char,
 130                             strlen (prefix) +
 131                             strlen (full_base_name) +
 132                             strlen (header_extension) + 1);
 133       cp = stpcpy (macro_name, prefix);
 134       cp = stpcpy (cp, full_base_name);
 135       cp = stpcpy (cp, header_extension);
 136     }
 137
 138   for (cp = macro_name; *cp; ++cp)
 139     if (islower (*cp))
 140       *cp = toupper (*cp);
 141     else if (!isalnum (*cp))
 142       *cp = '_';
 143
 144   return macro_name;
 145 }
 146
 147
 148 /*-----------------------------------------------------------------.
 149 | Try to open file NAME with mode MODE, and print an error message |
 150 | if fails.                                                        |
 151 `-----------------------------------------------------------------*/
 152
 153 FILE *
 154 xfopen (const char *name, const char *mode)
 155 {
 156   FILE *ptr;
 157
 158   ptr = fopen (name, mode);
 159   if (!ptr)
 160     error (2, errno, _("cannot open file `%s'"), name);
 161
 162   return ptr;
 163 }
 164
 165 /*-------------------------------------------------------------.
 166 | Try to close file PTR, and print an error message if fails.  |
 167 `-------------------------------------------------------------*/
 168
 169 int
 170 xfclose (FILE *ptr)
 171 {
 172   int result;
 173
 174   if (ptr == NULL)
 175     return 0;
 176
 177   result = fclose (ptr);
 178   if (result == EOF)
 179     error (2, errno, _("cannot close file"));
 180
 181   return result;
 182 }
 183
 184
 185 /*------------------------------------------------------------------.
 186 | Return the path to the skeleton which locaction might be given in |
 187 | ENVVAR, otherwise return SKELETON_NAME.                           |
 188 `------------------------------------------------------------------*/
 189
 190 const char *
 191 skeleton_find (const char *envvar, const char *skeleton_name)
 192 {
 193   const char *res = getenv (envvar);
 194
 195 #if defined (MSDOS) || defined (_WIN32)
 196   const char *cp = getenv ("INIT");
 197   if (!res)
 198     {
 199       /* Skeleton file name without path */
 200       const char *skel_name = strrchr (skeleton_name, '/');
 201       if (!skel_name)
 202         skel_name = strrchr (skeleton_name, '\\');
 203       if (!skel_name)
 204         skel_name = skeleton_name;
 205       else
 206         ++skel_name;
 207
 208       /* File doesn't exist in current directory; try in INIT directory.  */
 209       if (cp)
 210         {
 211           res = XMALLOC (char, strlen (cp) + strlen (skel_name) + 2);
 212           sprintf (res, "%s%c%s", cp, '\\', skel_name);
 213         }
 214       else if (access (skel_name, 4) == 0) /* Look in current dir. */
 215         res = skel_name;
 216       else
 217         {
 218           /* Look in program locations dir. */
 219           extern char *program_name;
 220           cp = strrchr(program_name, '\\');
 221           if (!cp)
 222             return skeleton_name;
 223           else
 224             ++cp;
 225           res = XMALLOC (char, cp - program_name + strlen (skel_name) + 1);
 226           strncpy (res, program_name, cp - program_name);
 227           strcpy (res + (cp - program_name), skel_name);
 228         }
 229     }
 230 #endif /* defined (MSDOS) || defined (_WIN32) */
 231   if (!res)
 232     res = skeleton_name;
 233
 234   return res;
 235 }
 236 \f
 237
 238 /*----------------------------------------------------------------.
 239 | Compute BASE_NAME, SHORT_BASE_NAME and output files extensions. |
 240 `----------------------------------------------------------------*/
 241
 242 /* Replace all characters FROM by TO in the string IN.
 243    and returns a new allocated string.  */
 244 static char *
 245 tr (const char *in, char from, char to)
 246 {
 247   char *temp;
 248   char *out;
 249
 250   out = XMALLOC (char, strlen (in) + 1);
 251
 252   for (temp = out; *in; in++, out++)
 253     if (*in == from)
 254       *out = to;
 255     else
 256       *out = *in;
 257   *out = 0;
 258   return (temp);
 259 }
 260
 261 /* Computes extensions from the grammar file extension. */
 262 static void
 263 compute_exts_from_gf (const char *ext)
 264 {
 265   src_extension = tr (ext, 'y', 'c');
 266   src_extension = tr (src_extension, 'Y', 'C');
 267   header_extension = tr (ext, 'y', 'h');
 268   header_extension = tr (header_extension, 'Y', 'H');
 269 }
 270
 271 /* Computes extensions from the given c source file extension. */
 272 static void
 273 compute_exts_from_src (const char *ext)
 274 {
 275   /* We use this function when the user specifies `-o' or `--output',
 276      so the extenions must be computed unconditionally from the file name
 277      given by this option.  */
 278   src_extension = xstrdup (ext);
 279   header_extension = tr (ext, 'c', 'h');
 280   header_extension = tr (header_extension, 'C', 'H');
 281 }
 282
 283
 284 /* Decompose FILENAME in four parts: *BASE, *TAB, and *EXT, the fourth
 285    part, (the directory) is ranging from FILENAME to the char before
 286    *BASE, so we don't need an additional parameter.
 287
 288    *EXT points to the last period in the basename, or NULL if none.
 289
 290    If there is no *EXT, *TAB is NULL.  Otherwise, *TAB points to
 291    `.tab' or `_tab' if present right before *EXT, or is NULL. *TAB
 292    cannot be equal to *BASE.
 293
 294    None are allocated, they are simply pointers to parts of FILENAME.
 295    Examples:
 296
 297    '/tmp/foo.tab.c' -> *BASE = 'foo.tab.c', *TAB = '.tab.c', *EXT =
 298    '.c'
 299
 300    'foo.c' -> *BASE = 'foo.c', *TAB = NULL, *EXT = '.c'
 301
 302    'tab.c' -> *BASE = 'tab.c', *TAB = NULL, *EXT = '.c'
 303
 304    '.tab.c' -> *BASE = '.tab.c', *TAB = NULL, *EXT = '.c'
 305
 306    'foo.tab' -> *BASE = 'foo.tab', *TAB = NULL, *EXT = '.tab'
 307
 308    'foo_tab' -> *BASE = 'foo_tab', *TAB = NULL, *EXT = NULL
 309
 310    'foo' -> *BASE = 'foo', *TAB = NULL, *EXT = NULL.  */
 311
 312 static void
 313 filename_split (const char *filename,
 314                 const char **base, const char **tab, const char **ext)
 315 {
 316   *base = base_name (filename);
 317
 318   /* Look for the extension, i.e., look for the last dot. */
 319   *ext = strrchr (*base, '.');
 320   *tab = NULL;
 321
 322   /* If there is an exentension, check if there is a `.tab' part right
 323      before.  */
 324   if (*ext
 325       && (*ext - *base) > (int) strlen (".tab")
 326       && (!strncmp (*ext - strlen (".tab"), ".tab", strlen (".tab"))
 327           || !strncmp (*ext - strlen ("_tab"), "_tab", strlen ("_tab"))))
 328     *tab = *ext - strlen (".tab");
 329 }
 330
 331
 332 /* FIXME: Should use xstrndup. */
 333
 334 static void
 335 compute_base_names (void)
 336 {
 337   const char *base, *tab, *ext;
 338
 339   /* If --output=foo.c was specified (SPEC_OUTFILE == foo.c),
 340      BASE_NAME and SHORT_BASE_NAME are `foo'.
 341
 342      If --output=foo.tab.c was specified, BASE_NAME is `foo.tab' and
 343      SHORT_BASE_NAME is `foo'.
 344
 345      The precise -o name will be used for FTABLE.  For other output
 346      files, remove the ".c" or ".tab.c" suffix.  */
 347   if (spec_outfile)
 348     {
 349       filename_split (spec_outfile, &base, &tab, &ext);
 350
 351       /* The full base name goes up the EXT, excluding it. */
 352       full_base_name =
 353         xstrndup (spec_outfile,
 354                   (strlen (spec_outfile) - (ext ? strlen (ext) : 0)));
 355
 356       /* The short base name goes up to TAB, excluding it.  */
 357       short_base_name =
 358         xstrndup (spec_outfile,
 359                   (strlen (spec_outfile)
 360                    - (tab ? strlen (tab) : (ext ? strlen (ext) : 0))));
 361
 362       if (tab)
 363         output_infix = xstrndup (tab,
 364                                  (strlen (tab) - (ext ? strlen (ext) : 0)));
 365
 366       if (ext)
 367         compute_exts_from_src (ext);
 368     }
 369
 370   /* If --file-prefix=foo was specified, FULL_BASE_NAME = `foo.tab'
 371      and SHORT_BASE_NAME = `foo'.
 372
 373      Construct names from it.  */
 374   else
 375     {
 376       if (spec_file_prefix)
 377         {
 378           /* If --file-prefix=foo was specified, SHORT_BASE_NAME =
 379              `foo'.  */
 380           short_base_name = xstrdup (spec_file_prefix);
 381         }
 382       else if (yacc_flag)
 383         {
 384           /* If --yacc, then the output is `y.tab.c'. */
 385           short_base_name = xstrdup ("y");
 386         }
 387       else
 388         {
 389           /* Otherwise, the short base name is computed from the input
 390              grammar: `foo.yy' => `foo'.  */
 391           filename_split (infile, &base, &tab, &ext);
 392           short_base_name =
 393             xstrndup (infile,
 394                       (strlen (infile) - (ext ? strlen (ext) : 0)));
 395         }
 396
 397       /* In these cases, always append `.tab'. */
 398       output_infix = xstrdup (EXT_TAB);
 399
 400       full_base_name = XMALLOC (char,
 401                                 strlen (short_base_name)
 402                                 + strlen (EXT_TAB) + 1);
 403       stpcpy (stpcpy (full_base_name, short_base_name), EXT_TAB);
 404
 405       /* Computes the extensions from the grammar file name.  */
 406       filename_split (infile, &base, &tab, &ext);
 407       if (ext && !yacc_flag)
 408         compute_exts_from_gf (ext);
 409     }
 410 }
 411
 412 /*-------------------------------------------------------.
 413 | Close the open files, compute the output files names.  |
 414 `-------------------------------------------------------*/
 415
 416 void
 417 compute_output_file_names (void)
 418 {
 419   compute_base_names ();
 420
 421   /* If not yet done. */
 422   if (!src_extension)
 423     src_extension = ".c";
 424   if (!header_extension)
 425     header_extension = ".h";
 426
 427   parser_file_name =
 428     spec_outfile ? spec_outfile : stringappend (full_base_name, src_extension);
 429
 430   /* It the defines filename if not given, we create it.  */
 431   if (!spec_defines_file)
 432     spec_defines_file = stringappend (full_base_name, header_extension);
 433
 434   /* It the graph filename if not given, we create it.  */
 435   if (!spec_graph_file)
 436     spec_graph_file = stringappend (short_base_name, ".vcg");
 437
 438   spec_verbose_file = stringappend (short_base_name, EXT_OUTPUT);
 439
 440   attrsfile = stringappend (short_base_name, EXT_STYPE_H);
 441 }