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.
35 /*! \libinternal \file
37 * Declares gmx::TextWriter.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_utility
43 #ifndef GMX_UTILITY_TEXTWRITER_H
44 #define GMX_UTILITY_TEXTWRITER_H
48 #include "gromacs/utility/classhelpers.h"
49 #include "gromacs/utility/textstream.h"
54 /*! \libinternal \brief
55 * Writes text into a TextOutputStream.
57 * This class provides more formatting and line-oriented writing capabilities
58 * than writing raw strings into the stream.
60 * All methods that write to the stream can throw any exceptions that the
61 * underlying stream throws.
64 * \ingroup module_utility
70 * Convenience method for writing a file from a string in a single call.
72 * \param[in] filename Name of the file to read.
73 * \param[in] text String to write to \p filename.
74 * \throws std::bad_alloc if out of memory.
75 * \throws FileIOError on any I/O error.
77 * If \p filename exists, it is overwritten.
79 static void writeFileFromString(const std::string &filename,
80 const std::string &text);
83 * Creates a writer that writes to specified file.
85 * \param[in] filename Path to the file to open.
86 * \throws std::bad_alloc if out of memory.
87 * \throws FileIOError on any I/O error.
89 * This constructor is provided for convenience for writing directly to
90 * a file, without the need to construct multiple objects.
92 explicit TextWriter(const std::string &filename);
94 * Creates a writer that writes to specified stream.
96 * \param[in] stream Stream to write to.
97 * \throws std::bad_alloc if out of memory.
99 * The caller is responsible of the lifetime of the stream (should
100 * remain in existence as long as the writer exists).
102 * This constructor is provided for convenience for cases where the
103 * stream is not allocated with `new` and/or not managed by a
104 * boost::shared_ptr (e.g., if the stream is an object on the stack).
106 explicit TextWriter(TextOutputStream *stream);
108 * Creates a writer that writes to specified stream.
110 * \param[in] stream Stream to write to.
111 * \throws std::bad_alloc if out of memory.
113 * The writer keeps a reference to the stream, so the caller can pass
114 * in a temporary if necessary.
116 explicit TextWriter(const TextOutputStreamPointer &stream);
119 //! Returns the underlying stream for this writer.
120 TextOutputStream &stream();
123 * Writes a string to the stream.
125 * \param[in] str String to write.
127 void writeString(const char *str);
128 //! \copydoc writeString(const char *)
129 void writeString(const std::string &str);
131 * Writes a line to the stream.
133 * \param[in] line Line to write.
135 * If \p line does not end in a newline, one newline is appended.
136 * Otherwise, works as writeString().
138 void writeLine(const char *line);
139 //! \copydoc writeLine(const char *)
140 void writeLine(const std::string &line);
141 //! Writes a newline to the stream.
145 * Closes the underlying stream.
152 PrivateImplPointer<Impl> impl_;