src/files.c

   1 /* Open and close files for bison,
   2    Copyright 1984, 1986, 1989, 1992, 2000, 2001 Free Software Foundation, Inc.
   3
   4    This file is part of Bison, the GNU Compiler Compiler.
   5
   6    Bison is free software; you can redistribute it and/or modify it
   7    under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2, or (at your option)
   9    any later version.
  10
  11    Bison is distributed in the hope that it will be useful, but
  12    WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with Bison; see the file COPYING.  If not, write to the Free
  18    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19    02111-1307, USA.  */
  20
  21
  22 #include "system.h"
  23 #include "getargs.h"
  24 #include "files.h"
  25 #include "gram.h"
  26 #include "complain.h"
  27
  28 FILE *finput = NULL;
  29
  30 struct obstack action_obstack;
  31 struct obstack attrs_obstack;
  32 struct obstack table_obstack;
  33 struct obstack defines_obstack;
  34 struct obstack guard_obstack;
  35 struct obstack output_obstack;
  36
  37 char *spec_outfile = NULL;      /* for -o. */
  38 char *spec_file_prefix = NULL;  /* for -b. */
  39 char *spec_name_prefix = NULL;  /* for -p. */
  40 char *spec_verbose_file = NULL;   /* for --verbose. */
  41 char *spec_graph_file = NULL;   /* for -g. */
  42 char *spec_defines_file = NULL; /* for --defines. */
  43
  44 char *infile = NULL;
  45 char *attrsfile = NULL;
  46
  47 static char *base_name = NULL;
  48 static char *short_base_name = NULL;
  49
  50 /* C source file extension (the parser source).  */
  51 const char *src_extension = NULL;
  52 /* Header file extension (if option ``-d'' is specified).  */
  53 const char *header_extension = NULL;
  54 \f
  55
  56 /*--------------------------.
  57 | Is SUFFIX ending STRING?  |
  58 `--------------------------*/
  59
  60 static int
  61 strsuffix (const char *string, const char *suffix)
  62 {
  63   size_t string_len = strlen (string);
  64   size_t suffix_len = strlen (suffix);
  65   if (suffix_len <= string_len)
  66     return !strcmp (string + string_len - suffix_len, suffix);
  67   else
  68     return 0;
  69 }
  70
  71
  72 /*-----------------------------------------------------------------.
  73 | Return a newly allocated string composed of the concatenation of |
  74 | STRING1, and STRING2.                                            |
  75 `-----------------------------------------------------------------*/
  76
  77 static char *
  78 stringappend (const char *string1, const char *string2)
  79 {
  80   size_t len = strlen (string1) + strlen (string2);
  81   char *res = XMALLOC (char, len + 1);
  82   char *cp;
  83   cp = stpcpy (res, string1);
  84   cp = stpcpy (cp, string2);
  85   return res;
  86 }
  87
  88
  89 /*---------------------------------------------------------------.
  90 |  Computes the macro name used to avoid double inclusion in the |
  91 |  header of the parser and store it in header_macro_name.       |
  92 `---------------------------------------------------------------*/
  93
  94 static char *
  95 compute_header_macro (void)
  96 {
  97   int ite;
  98   char *macro_name;
  99
 100   if (spec_defines_file)
 101     macro_name = xstrdup (spec_defines_file);
 102   else
 103     {
 104       macro_name = XMALLOC (char,
 105                             strlen (base_name) +
 106                             strlen (header_extension) + 1);
 107
 108       stpcpy (macro_name, base_name);
 109       strcat (macro_name, header_extension);
 110     }
 111
 112   for (ite = 0; macro_name[ite]; ite++)
 113     if (macro_name[ite] == '.')
 114       macro_name[ite] = '_';
 115     else
 116       {
 117         if (islower (macro_name[ite]))
 118           macro_name[ite] -= ('a' - 'A');
 119       }
 120   return macro_name;
 121 }
 122
 123
 124 /*-----------------------------------------------------------------.
 125 | Try to open file NAME with mode MODE, and print an error message |
 126 | if fails.                                                        |
 127 `-----------------------------------------------------------------*/
 128
 129 FILE *
 130 xfopen (const char *name, const char *mode)
 131 {
 132   FILE *ptr;
 133
 134   ptr = fopen (name, mode);
 135   if (!ptr)
 136     error (2, errno, _("cannot open file `%s'"), name);
 137
 138   return ptr;
 139 }
 140
 141 /*-------------------------------------------------------------.
 142 | Try to close file PTR, and print an error message if fails.  |
 143 `-------------------------------------------------------------*/
 144
 145 int
 146 xfclose (FILE *ptr)
 147 {
 148   int result;
 149
 150   if (ptr == NULL)
 151     return 0;
 152
 153   result = fclose (ptr);
 154   if (result == EOF)
 155     error (2, errno, _("cannot close file"));
 156
 157   return result;
 158 }
 159
 160 /*--------------------------------------------------.
 161 | Save the content of the obstack OBS in FILENAME.  |
 162 `--------------------------------------------------*/
 163
 164 static void
 165 obstack_save (struct obstack *obs, const char *filename)
 166 {
 167   FILE *out = xfopen (filename, "w");
 168   size_t size = obstack_object_size (obs);
 169   fwrite (obstack_finish (obs), 1, size, out);
 170   xfclose (out);
 171 }
 172
 173 /*---------------------------------------------------------------------.
 174 | Output double inclusion protection macros and saves defines_obstack  |
 175 `---------------------------------------------------------------------*/
 176
 177 static void
 178 defines_obstack_save (const char *filename)
 179 {
 180   FILE *out = xfopen (filename, "w");
 181   size_t size = obstack_object_size (&defines_obstack);
 182   char *macro_name = compute_header_macro ();
 183
 184   fprintf (out, "#ifndef %s\n", macro_name);
 185   fprintf (out, "# define %s\n\n", macro_name);
 186   fwrite (obstack_finish (&defines_obstack), 1, size, out);
 187   fprintf (out, "\n#endif /* not %s */\n", macro_name);
 188
 189   free (macro_name);
 190   xfclose (out);
 191 }
 192
 193 /*------------------------------------------------------------------.
 194 | Return the path to the skeleton which locaction might be given in |
 195 | ENVVAR, otherwise return SKELETON_NAME.                           |
 196 `------------------------------------------------------------------*/
 197
 198 const char *
 199 skeleton_find (const char *envvar, const char *skeleton_name)
 200 {
 201   const char *res = getenv (envvar);
 202
 203 #ifdef MSDOS
 204   const char *cp;
 205
 206   /* File doesn't exist in current directory; try in INIT directory.  */
 207   if (!res && (cp = getenv ("INIT")))
 208     {
 209       res = XMALLOC (char, strlen (cp) + strlen (skeleton_name) + 2);
 210       sprintf (res, "%s%c%s", cp, '/', skeleton_name);
 211     }
 212 #endif /* !MSDOS */
 213
 214   if (!res)
 215     res = skeleton_name;
 216
 217   return res;
 218 }
 219 \f
 220
 221 /*----------------------------------------------------------------.
 222 | Compute BASE_NAME, SHORT_BASE_NAME and output files extensions. |
 223 `----------------------------------------------------------------*/
 224
 225 /* Replace all characters FROM by TO in the string IN.
 226    and returns a new allocated string.  */
 227 static char *
 228 tr (const char *in, char from, char to)
 229 {
 230   char *temp;
 231   char *out;
 232
 233   out = XMALLOC (char, strlen (in) + 1);
 234
 235   for (temp = out; *in; in++, out++)
 236     if (*in == from)
 237       *out = to;
 238     else
 239       *out = *in;
 240   *out = 0;
 241   return (temp);
 242 }
 243
 244 /* Gets the extension index in FILENAME. Returns 0 if fails to
 245    find an extension.  */
 246 static int
 247 get_extension_index (const char *filename)
 248 {
 249   int len;
 250
 251   len = strlen (filename);
 252
 253   if (filename[len-- - 1] == '.')
 254     return (0);
 255
 256   while ((len > 0) && (filename[len - 1] != '.'))
 257     if (filename[len - 1] == '/')
 258       return (0);
 259     else
 260       len--;
 261
 262   return (len - 1);
 263 }
 264
 265 /* Computes extensions from the grammar file extension. */
 266 static void
 267 compute_exts_from_gf (const char *ext)
 268 {
 269   src_extension = tr (ext, 'y', 'c');
 270   src_extension = tr (src_extension, 'Y', 'C');
 271   header_extension = tr (ext, 'y', 'h');
 272   header_extension = tr (header_extension, 'Y', 'H');
 273 }
 274
 275 /* Computes extensions from the given c source file extension. */
 276 static void
 277 compute_exts_from_src (const char *ext)
 278 {
 279   /* We use this function when the user specifies `-o' or `--output',
 280      so the extenions must be computed unconditionally from the file name
 281      given by this option.  */
 282   src_extension = xstrdup (ext);
 283   header_extension = tr (ext, 'c', 'h');
 284   header_extension = tr (header_extension, 'C', 'H');
 285 }
 286
 287 /* FIXME: Should use xstrndup. */
 288
 289 static void
 290 compute_base_names (void)
 291 {
 292   size_t base_length;
 293   size_t short_base_length;
 294   size_t ext_index;
 295
 296   /* If --output=foo.c was specified (SPEC_OUTFILE == foo.c),
 297      BASE_NAME and SHORT_BASE_NAME are `foo'.
 298
 299      If --output=foo.tab.c was specified, BASE_NAME is `foo.tab' and
 300      SHORT_BASE_NAME is `foo'.
 301
 302      The precise -o name will be used for FTABLE.  For other output
 303      files, remove the ".c" or ".tab.c" suffix.  */
 304   if (spec_outfile)
 305     {
 306 #ifdef MSDOS
 307       strlwr (spec_outfile);
 308 #endif /* MSDOS */
 309       /* BASE_LENGTH includes ".tab" but not ".c".  */
 310       base_length = strlen (spec_outfile);
 311
 312       ext_index = get_extension_index (spec_outfile);
 313       /* If the initial segment of extension contains 'c' or a 'C', I assume
 314          that it is a C or C++ source file.  */
 315       if (ext_index)
 316         ext_index =
 317           (strspn (spec_outfile + ext_index + 1, "cC")) ? ext_index : 0;
 318       if (ext_index)
 319         {
 320           base_length -= strlen (spec_outfile + ext_index);
 321           compute_exts_from_src (spec_outfile + ext_index);
 322         }
 323
 324       base_name = strndup (spec_outfile, base_length);
 325       /* SHORT_BASE_LENGTH includes neither ".tab" nor ".c".  */
 326       short_base_length = base_length;
 327       if (strsuffix (base_name, ".tab") || strsuffix (base_name, "_tab"))
 328         short_base_length -= 4;
 329       short_base_name = strndup (spec_outfile, short_base_length);
 330
 331       return;
 332     }
 333
 334   /* If --file-prefix=foo was specified, BASE_NAME and SHORT_BASE_NAME
 335      are `foo'.
 336
 337      Construct names from it.  */
 338   if (spec_file_prefix)
 339     {
 340 #ifdef MSDOS
 341       strlwr (spec_file_prefix);
 342 #endif /* MSDOS */
 343       short_base_name = xstrdup (spec_file_prefix);
 344       base_name = XMALLOC (char,
 345                            strlen (short_base_name) + strlen (EXT_TAB) + 1);
 346       stpcpy (stpcpy (base_name, short_base_name), EXT_TAB);
 347
 348       /* Computes the extensions from the garmmar file name.  */
 349       ext_index = get_extension_index (infile);
 350       /* If the initial segment of extension contains a 'y' or a 'Y', I assume
 351          that it is a yacc or bison grammar file.  */
 352       if (ext_index)
 353         ext_index = (strspn (infile + ext_index + 1, "yY")) ? ext_index : 0;
 354       if (ext_index)
 355         compute_exts_from_gf (infile + ext_index);
 356
 357       return;
 358     }
 359
 360   /* If neither -o nor --file-prefix were specified, and the input
 361      file is foo.y, BASE_NAME is `foo.tab', and SHORT_BASE_NAME is
 362      `foo'.
 363
 364      If --yacc is used, do as if the input file was `y.y'.  */
 365   {
 366     const char *name_base = yacc_flag ? "y.y" : infile;
 367
 368     /* BASE_LENGTH gets length of BASE_NAME, sans ".y" suffix if any.  */
 369
 370     base_length = strlen (name_base);
 371
 372     ext_index = get_extension_index (name_base);
 373     /* If the initial segment of extension contains a 'y' or a 'Y', I assume
 374        that it is a yacc or bison grammar file.  */
 375     if (ext_index)
 376       ext_index = (strspn (name_base + ext_index + 1, "yY")) ? ext_index : 0;
 377     if (ext_index)
 378       {
 379         base_length -= strlen (name_base + ext_index);
 380         compute_exts_from_gf (name_base + ext_index);
 381       }
 382
 383     short_base_length = base_length;
 384     short_base_name = strndup (name_base, short_base_length);
 385
 386     base_name = XMALLOC (char,
 387                          strlen (short_base_name) + strlen (EXT_TAB) + 1);
 388     stpcpy (stpcpy (base_name, short_base_name), EXT_TAB);
 389
 390     return;
 391   }
 392 }
 393
 394 /*-------------------------------------------------------.
 395 | Close the open files, compute the output files names.  |
 396 `-------------------------------------------------------*/
 397
 398 void
 399 compute_output_file_names (void)
 400 {
 401   compute_base_names ();
 402
 403   /* If not yet done. */
 404   if (!src_extension)
 405     src_extension = ".c";
 406   if (!header_extension)
 407     header_extension = ".h";
 408
 409   /* It the defines filename if not given, we create it.  */
 410   if (!spec_defines_file)
 411     spec_defines_file = stringappend (base_name, header_extension);
 412
 413   /* It the graph filename if not given, we create it.  */
 414   if (!spec_graph_file)
 415     spec_graph_file = stringappend (short_base_name, ".vcg");
 416
 417   spec_verbose_file = stringappend (short_base_name, EXT_OUTPUT);
 418
 419   attrsfile = stringappend (short_base_name, EXT_STYPE_H);
 420 #ifndef MSDOS
 421   attrsfile = stringappend (attrsfile, header_extension);
 422 #endif /* MSDOS */
 423
 424 }
 425
 426 /*-----------------------------------------------------------------.
 427 | Open the input file.  Look for the skeletons.  Find the names of |
 428 | the output files.  Prepare the obstacks.                         |
 429 `-----------------------------------------------------------------*/
 430
 431 void
 432 open_files (void)
 433 {
 434   finput = xfopen (infile, "r");
 435
 436   /* Initialize the obstacks. */
 437   obstack_init (&action_obstack);
 438   obstack_init (&attrs_obstack);
 439   obstack_init (&table_obstack);
 440   obstack_init (&defines_obstack);
 441   obstack_init (&guard_obstack);
 442   obstack_init (&output_obstack);
 443 }
 444
 445
 446
 447 /*-----------------------.
 448 | Close the open file..  |
 449 `-----------------------*/
 450
 451 void
 452 close_files (void)
 453 {
 454   xfclose (finput);
 455 }
 456
 457 /*---------------------------.
 458 | Produce the output files.  |
 459 `---------------------------*/
 460
 461 void
 462 output_files (void)
 463 {
 464   /* Output the main file.  */
 465   if (spec_outfile)
 466     obstack_save (&table_obstack, spec_outfile);
 467   else
 468     obstack_save (&table_obstack, stringappend (base_name, src_extension));
 469   obstack_free (&table_obstack, NULL);
 470
 471   /* Output the header file if wanted. */
 472   if (defines_flag)
 473     defines_obstack_save (spec_defines_file);
 474   obstack_free (&defines_obstack, NULL);
 475
 476   /* If we output only the table, dump the actions in ACTFILE. */
 477   if (no_parser_flag)
 478     obstack_save (&action_obstack, stringappend (short_base_name, ".act"));
 479   obstack_free (&action_obstack, NULL);
 480
 481   /* If we produced a semantic parser ATTRS_OBSTACK must be dumped
 482      into its own file, ATTTRSFILE.  */
 483   if (semantic_parser)
 484     {
 485       char *temp_name;
 486
 487       obstack_save (&attrs_obstack, attrsfile);
 488       obstack_free (&attrs_obstack, NULL);
 489       temp_name = stringappend (short_base_name, EXT_GUARD_C);
 490 #ifndef MSDOS
 491       temp_name = stringappend (temp_name, src_extension);
 492 #endif /* MSDOS */
 493       obstack_save (&guard_obstack, temp_name);
 494       obstack_free (&guard_obstack, NULL);
 495     }
 496 }