2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014, 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.
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.
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.
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.
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.
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.
37 * Implements gmx::File.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_utility
54 #include "gromacs/utility/exceptions.h"
55 #include "gromacs/utility/gmxassert.h"
56 #include "gromacs/utility/stringutil.h"
58 #include "gmx_header_config.h"
64 * Private implementation class for File.
66 * \ingroup module_utility
72 * Initialize a file object with the given handle.
74 * \param[in] fp %File handle to use (may be NULL).
75 * \param[in] bClose Whether this object should close its file handle.
77 Impl(FILE *fp, bool bClose);
80 //! File handle for this object (may be NULL).
83 * Whether \p fp_ should be closed by this object.
85 * Can be true if \p fp_ is NULL.
90 File::Impl::Impl(FILE *fp, bool bClose)
91 : fp_(fp), bClose_(bClose)
97 if (fp_ != NULL && bClose_)
101 // TODO: Log the error somewhere
106 File::File(const char *filename, const char *mode)
107 : impl_(new Impl(NULL, true))
109 open(filename, mode);
112 File::File(const std::string &filename, const char *mode)
113 : impl_(new Impl(NULL, true))
115 open(filename, mode);
118 File::File(FILE *fp, bool bClose)
119 : impl_(new Impl(fp, bClose))
127 void File::open(const char *filename, const char *mode)
129 GMX_RELEASE_ASSERT(impl_->fp_ == NULL,
130 "Attempted to open the same file object twice");
131 // TODO: Port all necessary functionality from gmx_ffopen() here.
132 impl_->fp_ = fopen(filename, mode);
133 if (impl_->fp_ == NULL)
135 GMX_THROW_WITH_ERRNO(
136 FileIOError(formatString("Could not open file '%s'", filename)),
141 void File::open(const std::string &filename, const char *mode)
143 open(filename.c_str(), mode);
148 GMX_RELEASE_ASSERT(impl_->fp_ != NULL,
149 "Attempted to close a file object that is not open");
150 GMX_RELEASE_ASSERT(impl_->bClose_,
151 "Attempted to close a file object that should not be");
152 bool bOk = (fclose(impl_->fp_) == 0);
156 GMX_THROW_WITH_ERRNO(
157 FileIOError("Error while closing file"), "fclose", errno);
163 GMX_RELEASE_ASSERT(impl_->fp_ != NULL,
164 "Attempted to access a file object that is not open");
168 void File::readBytes(void *buffer, size_t bytes)
172 // TODO: Retry based on errno or something else?
173 size_t bytesRead = std::fread(buffer, 1, bytes, fp);
174 if (bytesRead != bytes)
178 GMX_THROW(FileIOError(
179 formatString("Premature end of file\n"
180 "Attempted to read: %d bytes\n"
181 "Successfully read: %d bytes",
182 static_cast<int>(bytes),
183 static_cast<int>(bytesRead))));
187 GMX_THROW_WITH_ERRNO(FileIOError("Error while reading file"),
193 bool File::readLine(std::string *line)
195 if (!readLineWithTrailingSpace(line))
199 size_t endPos = line->find_last_not_of(" \t\r\n");
200 if (endPos != std::string::npos)
202 line->resize(endPos + 1);
207 bool File::readLineWithTrailingSpace(std::string *line)
210 const size_t bufsize = 256;
215 while (fgets(buf, bufsize, fp) != NULL)
217 size_t length = std::strlen(buf);
218 result.append(buf, length);
219 if (length < bufsize - 1 || buf[length - 1] == '\n')
226 GMX_THROW_WITH_ERRNO(FileIOError("Error while reading file"),
230 return !result.empty() || !feof(fp);
233 void File::writeString(const char *str)
235 if (fprintf(handle(), "%s", str) < 0)
237 GMX_THROW_WITH_ERRNO(FileIOError("Writing to file failed"),
242 void File::writeLine(const char *line)
244 size_t length = std::strlen(line);
247 if (length == 0 || line[length-1] != '\n')
253 void File::writeLine()
259 bool File::exists(const char *filename)
261 if (filename == NULL)
265 FILE *test = fopen(filename, "r");
273 // Windows doesn't allow fopen of directory, so we don't need to check
275 #ifndef GMX_NATIVE_WINDOWS
277 int status = stat(filename, &st_buf);
278 if (status != 0 || !S_ISREG(st_buf.st_mode))
288 bool File::exists(const std::string &filename)
290 return exists(filename.c_str());
294 File &File::standardInput()
296 static File stdinObject(stdin, false);
301 File &File::standardOutput()
303 static File stdoutObject(stdout, false);
308 File &File::standardError()
310 static File stderrObject(stderr, false);
315 std::string File::readToString(const char *filename)
317 // Binary mode is required on Windows to be able to determine a size
318 // that can be passed to fread().
319 File file(filename, "rb");
320 FILE *fp = file.handle();
322 if (std::fseek(fp, 0L, SEEK_END) != 0)
324 GMX_THROW_WITH_ERRNO(FileIOError("Seeking to end of file failed"),
327 long len = std::ftell(fp);
330 GMX_THROW_WITH_ERRNO(FileIOError("Reading file length failed"),
333 if (std::fseek(fp, 0L, SEEK_SET) != 0)
335 GMX_THROW_WITH_ERRNO(FileIOError("Seeking to start of file failed"),
339 std::vector<char> data(len);
340 file.readBytes(&data[0], len);
343 std::string result(&data[0], len);
344 // The below is necessary on Windows to make newlines stay as '\n' on a
346 result = replaceAll(result, "\r\n", "\n");
352 std::string File::readToString(const std::string &filename)
354 return readToString(filename.c_str());
358 void File::writeFileFromString(const std::string &filename,
359 const std::string &text)
361 File file(filename, "w");
362 file.writeString(text);