src/gromacs/utility/textwriter.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2018,2019, 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 class TextLineWrapperSettings;
  57
  58 /*! \libinternal \brief
  59  * Writes text into a TextOutputStream.
  60  *
  61  * This class provides more formatting and line-oriented writing capabilities
  62  * than writing raw strings into the stream.
  63  *
  64  * All methods that write to the stream can throw any exceptions that the
  65  * underlying stream throws.
  66  *
  67  * \inlibraryapi
  68  * \ingroup module_utility
  69  */
  70 class TextWriter
  71 {
  72 public:
  73     /*! \brief
  74      * Convenience method for writing a file from a string in a single call.
  75      *
  76      * \param[in] filename  Name of the file to read.
  77      * \param[in] text      String to write to \p filename.
  78      * \throws    std::bad_alloc if out of memory.
  79      * \throws    FileIOError on any I/O error.
  80      *
  81      * If \p filename exists, it is overwritten.
  82      */
  83     static void writeFileFromString(const std::string& filename, const std::string& text);
  84
  85     /*! \brief
  86      * Creates a writer that writes to specified file.
  87      *
  88      * \param[in]  filename  Path to the file to open.
  89      * \throws     std::bad_alloc if out of memory.
  90      * \throws     FileIOError on any I/O error.
  91      *
  92      * This constructor is provided for convenience for writing directly to
  93      * a file, without the need to construct multiple objects.
  94      */
  95     explicit TextWriter(const std::string& filename);
  96     /*! \brief
  97      * Creates a writer that writes to specified file.
  98      *
  99      * \param[in]  fp  File handle to write to.
 100      * \throws     std::bad_alloc if out of memory.
 101      * \throws     FileIOError on any I/O error.
 102      *
 103      * This constructor is provided for interoperability with C-like code
 104      * for writing directly to an already opened file, without the need to
 105      * construct multiple objects.
 106      *
 107      * The caller is responsible of closing \p fp; it is not allowed to
 108      * call close() on the writer.
 109      */
 110     explicit TextWriter(FILE* fp);
 111     /*! \brief
 112      * Creates a writer that writes to specified stream.
 113      *
 114      * \param[in]  stream  Stream to write to.
 115      * \throws     std::bad_alloc if out of memory.
 116      *
 117      * The caller is responsible of the lifetime of the stream (should
 118      * remain in existence as long as the writer exists).
 119      *
 120      * This constructor is provided for convenience for cases where the
 121      * stream is not allocated with `new` and/or not managed by a
 122      * std::shared_ptr (e.g., if the stream is an object on the stack).
 123      */
 124     explicit TextWriter(TextOutputStream* stream);
 125     /*! \brief
 126      * Creates a writer that writes to specified stream.
 127      *
 128      * \param[in]  stream  Stream to write to.
 129      * \throws     std::bad_alloc if out of memory.
 130      *
 131      * The writer keeps a reference to the stream, so the caller can pass
 132      * in a temporary if necessary.
 133      */
 134     explicit TextWriter(const TextOutputStreamPointer& stream);
 135     ~TextWriter();
 136
 137     /*! \brief
 138      * Allows adjusting wrapping settings for the writer.
 139      *
 140      * \todo
 141      * Wrapping is not currently implemented for code that writes partial
 142      * lines with writeString().
 143      */
 144     TextLineWrapperSettings& wrapperSettings();
 145
 146     /*! \brief
 147      * Writes a string to the stream.
 148      *
 149      * \param[in]  str  String to write.
 150      */
 151     void writeString(const char* str);
 152     //! \copydoc writeString(const char *)
 153     void writeString(const std::string& str);
 154     //! Writes a string to the stream, with printf-style formatting.
 155     void writeStringFormatted(const char* fmt, ...);
 156     /*! \brief
 157      * Writes a line to the stream.
 158      *
 159      * \param[in]  line  Line to write.
 160      *
 161      * If \p line does not end in a newline, one newline is appended.
 162      * Otherwise, works as writeString().
 163      */
 164     void writeLine(const char* line);
 165     //! \copydoc writeLine(const char *)
 166     void writeLine(const std::string& line);
 167     //! Writes a line to the stream, with printf-style formatting.
 168     void writeLineFormatted(const char* fmt, ...);
 169     //! Writes a newline to the stream.
 170     void writeLine();
 171
 172     /*! \brief
 173      * Writes a newline if previous output did not end in one.
 174      *
 175      * If nothing has been written using the writer, this method does
 176      * nothing.
 177      */
 178     void ensureLineBreak();
 179     /*! \brief
 180      * Ensures that the next string written starts after an empty line.
 181      *
 182      * Always terminates the current line (as with ensureLineBreak()), but
 183      * the empty line is only written out when the next line is written,
 184      * so that trailing newlines after final output can be avoided.
 185      *
 186      * If nothing has been written using the writer, this method does
 187      * nothing.
 188      */
 189     void ensureEmptyLine();
 190
 191     /*! \brief
 192      * Closes the underlying stream.
 193      */
 194     void close();
 195
 196 private:
 197     class Impl;
 198
 199     PrivateImplPointer<Impl> impl_;
 200 };
 201
 202 } // namespace gmx
 203
 204 #endif