2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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.
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 classes from filestream.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_utility
44 #include "filestream.h"
55 #include "gromacs/utility/exceptions.h"
56 #include "gromacs/utility/gmxassert.h"
57 #include "gromacs/utility/stringutil.h"
65 //! Helper function for implementing readLine() for input streams.
66 bool readLineImpl(FILE *fp
, std::string
*line
)
69 const size_t bufsize
= 256;
73 while (std::fgets(buf
, bufsize
, fp
) != NULL
)
75 const size_t length
= std::strlen(buf
);
76 result
.append(buf
, length
);
77 if (length
< bufsize
- 1 || buf
[length
- 1] == '\n')
84 GMX_THROW_WITH_ERRNO(FileIOError("Error while reading file"),
88 return !result
.empty() || !std::feof(fp
);
96 /********************************************************************
103 explicit FileStreamImpl(FILE *fp
)
104 : fp_(fp
), bClose_(false)
107 FileStreamImpl(const char *filename
, const char *mode
)
108 : fp_(NULL
), bClose_(true)
110 fp_
= std::fopen(filename
, mode
);
113 GMX_THROW_WITH_ERRNO(
114 FileIOError(formatString("Could not open file '%s'", filename
)),
120 if (fp_
!= NULL
&& bClose_
)
122 if (std::fclose(fp_
) != 0)
124 // TODO: Log the error somewhere
131 GMX_RELEASE_ASSERT(fp_
!= NULL
,
132 "Attempted to access a file object that is not open");
138 GMX_RELEASE_ASSERT(fp_
!= NULL
,
139 "Attempted to close a file object that is not open");
140 GMX_RELEASE_ASSERT(bClose_
,
141 "Attempted to close a file object that should not be");
142 const bool bOk
= (std::fclose(fp_
) == 0);
146 GMX_THROW_WITH_ERRNO(
147 FileIOError("Error while closing file"), "fclose", errno
);
152 //! File handle for this object (NULL if the stream has been closed).
154 //! Whether \p fp_ should be closed by this object.
158 } // namespace internal
160 using internal::FileStreamImpl
;
162 /********************************************************************
163 * StandardInputStream
166 bool StandardInputStream::isInteractive() const
169 return isatty(fileno(stdin
));
175 bool StandardInputStream::readLine(std::string
*line
)
177 return readLineImpl(stdin
, line
);
181 StandardInputStream
&StandardInputStream::instance()
183 static StandardInputStream stdinObject
;
187 /********************************************************************
192 FILE *TextInputFile::openRawHandle(const char *filename
)
194 FILE *fp
= fopen(filename
, "r");
197 GMX_THROW_WITH_ERRNO(
198 FileIOError(formatString("Could not open file '%s'", filename
)),
205 FILE *TextInputFile::openRawHandle(const std::string
&filename
)
207 return openRawHandle(filename
.c_str());
210 TextInputFile::TextInputFile(const std::string
&filename
)
211 : impl_(new FileStreamImpl(filename
.c_str(), "r"))
215 TextInputFile::TextInputFile(FILE *fp
)
216 : impl_(new FileStreamImpl(fp
))
220 TextInputFile::~TextInputFile()
224 FILE *TextInputFile::handle()
226 return impl_
->handle();
229 bool TextInputFile::readLine(std::string
*line
)
231 return readLineImpl(impl_
->handle(), line
);
234 void TextInputFile::close()
239 /********************************************************************
243 TextOutputFile::TextOutputFile(const std::string
&filename
)
244 : impl_(new FileStreamImpl(filename
.c_str(), "w"))
248 TextOutputFile::TextOutputFile(FILE *fp
)
249 : impl_(new FileStreamImpl(fp
))
253 TextOutputFile::~TextOutputFile()
257 void TextOutputFile::write(const char *str
)
259 if (std::fprintf(impl_
->handle(), "%s", str
) < 0)
261 GMX_THROW_WITH_ERRNO(FileIOError("Writing to file failed"),
266 void TextOutputFile::close()
272 TextOutputFile
&TextOutputFile::standardOutput()
274 static TextOutputFile
stdoutObject(stdout
);
279 TextOutputFile
&TextOutputFile::standardError()
281 static TextOutputFile
stderrObject(stderr
);