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 interfaces for simple input/output streams.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_utility
43 #ifndef GMX_UTILITY_TEXTSTREAM_H
44 #define GMX_UTILITY_TEXTSTREAM_H
46 #include <boost/shared_ptr.hpp>
51 /*! \libinternal \brief
52 * Interface for writing text.
54 * Concrete implementations can write the text to, e.g., a file or an in-memory
55 * string. The main use is to allow unit tests to inject in-memory buffers
56 * instead of reading in files produced by the code under test, but there are
57 * also use cases outside the tests where it is useful to abstract out whether
58 * the output is into a real file or something else.
60 * To use more advanced formatting than writing plain strings, use TextWriter.
62 * The current implementation assumes text-only output in several places, but
63 * this interface could possibly be generalized also for binary files.
64 * However, since all binary files currently written by \Gromacs are either
65 * XDR- or TNG-based, they may require a different approach. Also, it is worth
66 * keeping the distinction between text and binary files clear, since Windows
67 * does transparent `LF`-`CRLF` newline translation for text files, so mixing
68 * modes when reading and/or writing the same file can cause subtle issues.
70 * Both methods in the interface can throw std::bad_alloc or other exceptions
71 * that indicate failures to write to the stream.
74 * \ingroup module_utility
76 class TextOutputStream
79 virtual ~TextOutputStream() {}
82 * Writes a given string to the stream.
84 virtual void write(const char *text) = 0;
88 * It is not allowed to write to a stream after it has been closed.
89 * A method separate from the destructor is provided such that errors
90 * that occur while closing the stream (e.g., when closing the file)
91 * can be handled using exceptions.
92 * The destructor is not allowed to throw, so code that wants to
93 * observe such errors needs to call close() after it has finished
94 * writing to the stream.
96 virtual void close() = 0;
99 //! Shorthand for a smart pointer to a TextOutputStream.
100 typedef boost::shared_ptr<TextOutputStream> TextOutputStreamPointer;