2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2015,2018,2019,2020,2021, 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.
35 /*! \libinternal \file
37 * Declares implementations for textstream.h interfaces for file input/output.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_utility
43 #ifndef GMX_UTILITY_FILESTREAM_H
44 #define GMX_UTILITY_FILESTREAM_H
51 #include "gromacs/utility/fileptr.h"
52 #include "gromacs/utility/textstream.h"
62 /*! \libinternal \brief
63 * Text input stream implementation for reading from `stdin`.
65 * Implementations for the TextInputStream methods throw FileIOError on any
69 * \ingroup module_utility
71 class StandardInputStream : public TextInputStream
75 * Returns whether `stdin` is an interactive terminal.
77 * Only works on Unix, otherwise always returns true.
81 static bool isInteractive();
83 // From TextInputStream
84 bool readLine(std::string* line) override;
85 void close() override {}
88 /*! \libinternal \brief
89 * Text input stream implementation for reading from a file.
91 * Implementations for the TextInputStream methods throw FileIOError on any
95 * \ingroup module_utility
97 class TextInputFile : public TextInputStream
101 * Opens a file and returns an RAII-style `FILE` handle.
103 * \param[in] filename Path of the file to open.
104 * \throws FileIOError on any I/O error.
106 * Instead of returning `NULL` on errors, throws an exception with
107 * additional details (including the file name and `errno`).
109 static FilePtr openRawHandle(const char* filename);
110 //! \copydoc openRawHandle(const char *)
111 static FilePtr openRawHandle(const std::string& filename);
114 * Opens a text file as a stream.
116 * \param[in] filename Path to the file to open.
117 * \throws std::bad_alloc if out of memory.
118 * \throws FileIOError on any I/O error.
120 explicit TextInputFile(const std::string& filename);
122 * Initializes file object from an existing file handle.
124 * \param[in] fp File handle to use.
125 * \throws std::bad_alloc if out of memory.
127 * The caller is responsible of closing the file; close() does nothing
128 * for an object constructed this way.
130 explicit TextInputFile(FILE* fp);
131 ~TextInputFile() override;
134 * Returns a raw handle to the input file.
136 * This is provided for interoperability with older C-like code.
140 // From TextInputStream
141 bool readLine(std::string* line) override;
142 void close() override;
145 std::unique_ptr<internal::FileStreamImpl> impl_;
148 /*! \libinternal \brief
149 * Text output stream implementation for writing to a file.
151 * Implementations for the TextOutputStream methods throw FileIOError on any
155 * \ingroup module_utility
157 class TextOutputFile : public TextOutputStream
160 //! \copydoc TextInputFile::TextInputFile(const std::string &)
161 explicit TextOutputFile(const std::string& filename);
162 //! \copydoc TextInputFile::TextInputFile(FILE *)
163 explicit TextOutputFile(FILE* fp);
164 ~TextOutputFile() override;
166 // From TextOutputStream
167 void write(const char* text) override;
168 void close() override;
171 * Returns a stream for accessing `stdout`.
173 * \throws std::bad_alloc if out of memory (only on first call).
175 static TextOutputFile& standardOutput();
177 * Returns a stream for accessing `stderr`.
179 * \throws std::bad_alloc if out of memory (only on first call).
181 static TextOutputFile& standardError();
184 std::unique_ptr<internal::FileStreamImpl> impl_;