src/gromacs/utility/textwriter.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::TextWriter.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_TEXTWRITER_H
  44 #define GMX_UTILITY_TEXTWRITER_H
  45
  46 #include <string>
  47
  48 #include "gromacs/utility/classhelpers.h"
  49 #include "gromacs/utility/textstream.h"
  50
  51 namespace gmx
  52 {
  53
  54 /*! \libinternal \brief
  55  * Writes text into a TextOutputStream.
  56  *
  57  * This class provides more formatting and line-oriented writing capabilities
  58  * than writing raw strings into the stream.
  59  *
  60  * All methods that write to the stream can throw any exceptions that the
  61  * underlying stream throws.
  62  *
  63  * \inlibraryapi
  64  * \ingroup module_utility
  65  */
  66 class TextWriter
  67 {
  68     public:
  69         /*! \brief
  70          * Creates a writer that writes to specified file.
  71          *
  72          * \param[in]  filename  Path to the file to open.
  73          * \throws     std::bad_alloc if out of memory.
  74          * \throws     FileIOError on any I/O error.
  75          *
  76          * This constructor is provided for convenience for writing directly to
  77          * a file, without the need to construct multiple objects.
  78          */
  79         explicit TextWriter(const std::string &filename);
  80         /*! \brief
  81          * Creates a writer that writes to specified stream.
  82          *
  83          * \param[in]  stream  Stream to write to.
  84          * \throws     std::bad_alloc if out of memory.
  85          *
  86          * The caller is responsible of the lifetime of the stream (should
  87          * remain in existence as long as the writer exists).
  88          *
  89          * This constructor is provided for convenience for cases where the
  90          * stream is not allocated with `new` and/or not managed by a
  91          * boost::shared_ptr (e.g., if the stream is an object on the stack).
  92          */
  93         explicit TextWriter(TextOutputStream *stream);
  94         /*! \brief
  95          * Creates a writer that writes to specified stream.
  96          *
  97          * \param[in]  stream  Stream to write to.
  98          * \throws     std::bad_alloc if out of memory.
  99          *
 100          * The writer keeps a reference to the stream, so the caller can pass
 101          * in a temporary if necessary.
 102          */
 103         explicit TextWriter(const TextOutputStreamPointer &stream);
 104         ~TextWriter();
 105
 106         //! Returns the underlying stream for this writer.
 107         TextOutputStream &stream();
 108
 109         /*! \brief
 110          * Writes a string to the stream.
 111          *
 112          * \param[in]  str  String to write.
 113          */
 114         void writeString(const char *str);
 115         //! \copydoc writeString(const char *)
 116         void writeString(const std::string &str);
 117         /*! \brief
 118          * Writes a line to the stream.
 119          *
 120          * \param[in]  line  Line to write.
 121          *
 122          * If \p line does not end in a newline, one newline is appended.
 123          * Otherwise, works as writeString().
 124          */
 125         void writeLine(const char *line);
 126         //! \copydoc writeLine(const char *)
 127         void writeLine(const std::string &line);
 128         //! Writes a newline to the stream.
 129         void writeLine();
 130
 131         /*! \brief
 132          * Closes the underlying stream.
 133          */
 134         void close();
 135
 136     private:
 137         class Impl;
 138
 139         PrivateImplPointer<Impl> impl_;
 140 };
 141
 142 } // namespace gmx
 143
 144 #endif