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 <cstdio>
  47
  48 #include <string>
  49
  50 #include "gromacs/utility/classhelpers.h"
  51 #include "gromacs/utility/textstream.h"
  52
  53 namespace gmx
  54 {
  55
  56 /*! \libinternal \brief
  57  * Writes text into a TextOutputStream.
  58  *
  59  * This class provides more formatting and line-oriented writing capabilities
  60  * than writing raw strings into the stream.
  61  *
  62  * All methods that write to the stream can throw any exceptions that the
  63  * underlying stream throws.
  64  *
  65  * \inlibraryapi
  66  * \ingroup module_utility
  67  */
  68 class TextWriter
  69 {
  70     public:
  71         /*! \brief
  72          * Convenience method for writing a file from a string in a single call.
  73          *
  74          * \param[in] filename  Name of the file to read.
  75          * \param[in] text      String to write to \p filename.
  76          * \throws    std::bad_alloc if out of memory.
  77          * \throws    FileIOError on any I/O error.
  78          *
  79          * If \p filename exists, it is overwritten.
  80          */
  81         static void writeFileFromString(const std::string &filename,
  82                                         const std::string &text);
  83
  84         /*! \brief
  85          * Creates a writer that writes to specified file.
  86          *
  87          * \param[in]  filename  Path to the file to open.
  88          * \throws     std::bad_alloc if out of memory.
  89          * \throws     FileIOError on any I/O error.
  90          *
  91          * This constructor is provided for convenience for writing directly to
  92          * a file, without the need to construct multiple objects.
  93          */
  94         explicit TextWriter(const std::string &filename);
  95         /*! \brief
  96          * Creates a writer that writes to specified file.
  97          *
  98          * \param[in]  fp  File handle to write to.
  99          * \throws     std::bad_alloc if out of memory.
 100          * \throws     FileIOError on any I/O error.
 101          *
 102          * This constructor is provided for interoperability with C-like code
 103          * for writing directly to an already opened file, without the need to
 104          * construct multiple objects.
 105          *
 106          * The caller is responsible of closing \p fp; it is not allowed to
 107          * call close() on the writer.
 108          */
 109         explicit TextWriter(FILE *fp);
 110         /*! \brief
 111          * Creates a writer that writes to specified stream.
 112          *
 113          * \param[in]  stream  Stream to write to.
 114          * \throws     std::bad_alloc if out of memory.
 115          *
 116          * The caller is responsible of the lifetime of the stream (should
 117          * remain in existence as long as the writer exists).
 118          *
 119          * This constructor is provided for convenience for cases where the
 120          * stream is not allocated with `new` and/or not managed by a
 121          * boost::shared_ptr (e.g., if the stream is an object on the stack).
 122          */
 123         explicit TextWriter(TextOutputStream *stream);
 124         /*! \brief
 125          * Creates a writer that writes to specified stream.
 126          *
 127          * \param[in]  stream  Stream to write to.
 128          * \throws     std::bad_alloc if out of memory.
 129          *
 130          * The writer keeps a reference to the stream, so the caller can pass
 131          * in a temporary if necessary.
 132          */
 133         explicit TextWriter(const TextOutputStreamPointer &stream);
 134         ~TextWriter();
 135
 136         //! Returns the underlying stream for this writer.
 137         TextOutputStream &stream();
 138
 139         /*! \brief
 140          * Writes a string to the stream.
 141          *
 142          * \param[in]  str  String to write.
 143          */
 144         void writeString(const char *str);
 145         //! \copydoc writeString(const char *)
 146         void writeString(const std::string &str);
 147         /*! \brief
 148          * Writes a line to the stream.
 149          *
 150          * \param[in]  line  Line to write.
 151          *
 152          * If \p line does not end in a newline, one newline is appended.
 153          * Otherwise, works as writeString().
 154          */
 155         void writeLine(const char *line);
 156         //! \copydoc writeLine(const char *)
 157         void writeLine(const std::string &line);
 158         //! Writes a newline to the stream.
 159         void writeLine();
 160
 161         /*! \brief
 162          * Closes the underlying stream.
 163          */
 164         void close();
 165
 166     private:
 167         class Impl;
 168
 169         PrivateImplPointer<Impl> impl_;
 170 };
 171
 172 } // namespace gmx
 173
 174 #endif