src/gromacs/utility/file.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements gmx::File.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "file.h"
  45
  46 #include "config.h"
  47
  48 #include <cerrno>
  49 #include <cstdio>
  50 #include <cstring>
  51
  52 #include <algorithm>
  53 #include <string>
  54 #include <vector>
  55
  56 #include <sys/stat.h>
  57
  58 #ifdef HAVE_UNISTD_H
  59 #include <unistd.h>
  60 #endif
  61
  62 #include "gromacs/utility/exceptions.h"
  63 #include "gromacs/utility/gmxassert.h"
  64 #include "gromacs/utility/stringutil.h"
  65
  66 namespace gmx
  67 {
  68
  69 /*! \internal \brief
  70  * Private implementation class for File.
  71  *
  72  * \ingroup module_utility
  73  */
  74 class File::Impl
  75 {
  76     public:
  77         /*! \brief
  78          * Initialize a file object with the given handle.
  79          *
  80          * \param[in]  fp     %File handle to use (may be NULL).
  81          * \param[in]  bClose Whether this object should close its file handle.
  82          */
  83         Impl(FILE *fp, bool bClose);
  84         ~Impl();
  85
  86         //! File handle for this object (may be NULL).
  87         FILE                   *fp_;
  88         /*! \brief
  89          * Whether \p fp_ should be closed by this object.
  90          *
  91          * Can be true if \p fp_ is NULL.
  92          */
  93         bool                    bClose_;
  94 };
  95
  96 File::Impl::Impl(FILE *fp, bool bClose)
  97     : fp_(fp), bClose_(bClose)
  98 {
  99 }
 100
 101 File::Impl::~Impl()
 102 {
 103     if (fp_ != NULL && bClose_)
 104     {
 105         if (fclose(fp_) != 0)
 106         {
 107             // TODO: Log the error somewhere
 108         }
 109     }
 110 }
 111
 112 // static
 113 FILE *File::openRawHandle(const char *filename, const char *mode)
 114 {
 115     FILE *fp = fopen(filename, mode);
 116     if (fp == NULL)
 117     {
 118         GMX_THROW_WITH_ERRNO(
 119                 FileIOError(formatString("Could not open file '%s'", filename)),
 120                 "fopen", errno);
 121     }
 122     return fp;
 123 }
 124
 125 // static
 126 FILE *File::openRawHandle(const std::string &filename, const char *mode)
 127 {
 128     return openRawHandle(filename.c_str(), mode);
 129 }
 130
 131 File::File(const char *filename, const char *mode)
 132     : impl_(new Impl(NULL, true))
 133 {
 134     open(filename, mode);
 135 }
 136
 137 File::File(const std::string &filename, const char *mode)
 138     : impl_(new Impl(NULL, true))
 139 {
 140     open(filename, mode);
 141 }
 142
 143 File::File(FILE *fp, bool bClose)
 144     : impl_(new Impl(fp, bClose))
 145 {
 146 }
 147
 148 File::~File()
 149 {
 150 }
 151
 152 void File::open(const char *filename, const char *mode)
 153 {
 154     GMX_RELEASE_ASSERT(impl_->fp_ == NULL,
 155                        "Attempted to open the same file object twice");
 156     // TODO: Port all necessary functionality from gmx_ffopen() here.
 157     impl_->fp_ = openRawHandle(filename, mode);
 158 }
 159
 160 void File::open(const std::string &filename, const char *mode)
 161 {
 162     open(filename.c_str(), mode);
 163 }
 164
 165 void File::close()
 166 {
 167     GMX_RELEASE_ASSERT(impl_->fp_ != NULL,
 168                        "Attempted to close a file object that is not open");
 169     GMX_RELEASE_ASSERT(impl_->bClose_,
 170                        "Attempted to close a file object that should not be");
 171     bool bOk = (fclose(impl_->fp_) == 0);
 172     impl_->fp_ = NULL;
 173     if (!bOk)
 174     {
 175         GMX_THROW_WITH_ERRNO(
 176                 FileIOError("Error while closing file"), "fclose", errno);
 177     }
 178 }
 179
 180 bool File::isInteractive() const
 181 {
 182     GMX_RELEASE_ASSERT(impl_->fp_ != NULL,
 183                        "Attempted to access a file object that is not open");
 184 #ifdef HAVE_UNISTD_H
 185     return isatty(fileno(impl_->fp_));
 186 #else
 187     return true;
 188 #endif
 189 }
 190
 191 FILE *File::handle()
 192 {
 193     GMX_RELEASE_ASSERT(impl_->fp_ != NULL,
 194                        "Attempted to access a file object that is not open");
 195     return impl_->fp_;
 196 }
 197
 198 void File::readBytes(void *buffer, size_t bytes)
 199 {
 200     errno = 0;
 201     FILE  *fp = handle();
 202     // TODO: Retry based on errno or something else?
 203     size_t bytesRead = std::fread(buffer, 1, bytes, fp);
 204     if (bytesRead != bytes)
 205     {
 206         if (feof(fp))
 207         {
 208             GMX_THROW(FileIOError(
 209                               formatString("Premature end of file\n"
 210                                            "Attempted to read: %d bytes\n"
 211                                            "Successfully read: %d bytes",
 212                                            static_cast<int>(bytes),
 213                                            static_cast<int>(bytesRead))));
 214         }
 215         else
 216         {
 217             GMX_THROW_WITH_ERRNO(FileIOError("Error while reading file"),
 218                                  "fread", errno);
 219         }
 220     }
 221 }
 222
 223 bool File::readLine(std::string *line)
 224 {
 225     if (!readLineWithTrailingSpace(line))
 226     {
 227         return false;
 228     }
 229     size_t endPos = line->find_last_not_of(" \t\r\n");
 230     if (endPos != std::string::npos)
 231     {
 232         line->resize(endPos + 1);
 233     }
 234     return true;
 235 }
 236
 237 bool File::readLineWithTrailingSpace(std::string *line)
 238 {
 239     line->clear();
 240     const size_t bufsize = 256;
 241     std::string  result;
 242     char         buf[bufsize];
 243     buf[0] = '\0';
 244     FILE        *fp = handle();
 245     while (fgets(buf, bufsize, fp) != NULL)
 246     {
 247         size_t length = std::strlen(buf);
 248         result.append(buf, length);
 249         if (length < bufsize - 1 || buf[length - 1] == '\n')
 250         {
 251             break;
 252         }
 253     }
 254     if (ferror(fp))
 255     {
 256         GMX_THROW_WITH_ERRNO(FileIOError("Error while reading file"),
 257                              "fgets", errno);
 258     }
 259     *line = result;
 260     return !result.empty() || !feof(fp);
 261 }
 262
 263 void File::writeString(const char *str)
 264 {
 265     if (fprintf(handle(), "%s", str) < 0)
 266     {
 267         GMX_THROW_WITH_ERRNO(FileIOError("Writing to file failed"),
 268                              "fprintf", errno);
 269     }
 270 }
 271
 272 void File::writeLine(const char *line)
 273 {
 274     size_t length = std::strlen(line);
 275
 276     writeString(line);
 277     if (length == 0 || line[length-1] != '\n')
 278     {
 279         writeString("\n");
 280     }
 281 }
 282
 283 void File::writeLine()
 284 {
 285     writeString("\n");
 286 }
 287
 288 // static
 289 bool File::exists(const char *filename)
 290 {
 291     if (filename == NULL)
 292     {
 293         return false;
 294     }
 295     FILE *test = fopen(filename, "r");
 296     if (test == NULL)
 297     {
 298         return false;
 299     }
 300     else
 301     {
 302         fclose(test);
 303         // Windows doesn't allow fopen of directory, so we don't need to check
 304         // this separately.
 305 #ifndef GMX_NATIVE_WINDOWS
 306         struct stat st_buf;
 307         int         status = stat(filename, &st_buf);
 308         if (status != 0 || !S_ISREG(st_buf.st_mode))
 309         {
 310             return false;
 311         }
 312 #endif
 313         return true;
 314     }
 315 }
 316
 317 // static
 318 bool File::exists(const std::string &filename)
 319 {
 320     return exists(filename.c_str());
 321 }
 322
 323 // static
 324 File &File::standardInput()
 325 {
 326     static File stdinObject(stdin, false);
 327     return stdinObject;
 328 }
 329
 330 // static
 331 std::string File::readToString(const char *filename)
 332 {
 333     // Binary mode is required on Windows to be able to determine a size
 334     // that can be passed to fread().
 335     File  file(filename, "rb");
 336     FILE *fp = file.handle();
 337
 338     if (std::fseek(fp, 0L, SEEK_END) != 0)
 339     {
 340         GMX_THROW_WITH_ERRNO(FileIOError("Seeking to end of file failed"),
 341                              "fseek", errno);
 342     }
 343     long len = std::ftell(fp);
 344     if (len == -1)
 345     {
 346         GMX_THROW_WITH_ERRNO(FileIOError("Reading file length failed"),
 347                              "ftell", errno);
 348     }
 349     if (std::fseek(fp, 0L, SEEK_SET) != 0)
 350     {
 351         GMX_THROW_WITH_ERRNO(FileIOError("Seeking to start of file failed"),
 352                              "fseek", errno);
 353     }
 354
 355     std::vector<char> data(len);
 356     file.readBytes(&data[0], len);
 357     file.close();
 358
 359     std::string result(&data[0], len);
 360     // The below is necessary on Windows to make newlines stay as '\n' on a
 361     // roundtrip.
 362     result = replaceAll(result, "\r\n", "\n");
 363
 364     return result;
 365 }
 366
 367 // static
 368 std::string File::readToString(const std::string &filename)
 369 {
 370     return readToString(filename.c_str());
 371 }
 372
 373 // static
 374 void File::writeFileFromString(const std::string &filename,
 375                                const std::string &text)
 376 {
 377     File file(filename, "w");
 378     file.writeString(text);
 379     file.close();
 380 }
 381
 382 } // namespace gmx