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