/*
* This file is part of the GROMACS molecular simulation package.
*
- * Copyright (c) 2015,2018, by the GROMACS development team, led by
+ * Copyright (c) 2015,2018,2019, by the GROMACS development team, led by
* Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
* and including many others, as listed in the AUTHORS file in the
* top-level source directory and at http://www.gromacs.org.
*/
class TextWriter
{
- public:
- /*! \brief
- * Convenience method for writing a file from a string in a single call.
- *
- * \param[in] filename Name of the file to read.
- * \param[in] text String to write to \p filename.
- * \throws std::bad_alloc if out of memory.
- * \throws FileIOError on any I/O error.
- *
- * If \p filename exists, it is overwritten.
- */
- static void writeFileFromString(const std::string &filename,
- const std::string &text);
+public:
+ /*! \brief
+ * Convenience method for writing a file from a string in a single call.
+ *
+ * \param[in] filename Name of the file to read.
+ * \param[in] text String to write to \p filename.
+ * \throws std::bad_alloc if out of memory.
+ * \throws FileIOError on any I/O error.
+ *
+ * If \p filename exists, it is overwritten.
+ */
+ static void writeFileFromString(const std::string& filename, const std::string& text);
- /*! \brief
- * Creates a writer that writes to specified file.
- *
- * \param[in] filename Path to the file to open.
- * \throws std::bad_alloc if out of memory.
- * \throws FileIOError on any I/O error.
- *
- * This constructor is provided for convenience for writing directly to
- * a file, without the need to construct multiple objects.
- */
- explicit TextWriter(const std::string &filename);
- /*! \brief
- * Creates a writer that writes to specified file.
- *
- * \param[in] fp File handle to write to.
- * \throws std::bad_alloc if out of memory.
- * \throws FileIOError on any I/O error.
- *
- * This constructor is provided for interoperability with C-like code
- * for writing directly to an already opened file, without the need to
- * construct multiple objects.
- *
- * The caller is responsible of closing \p fp; it is not allowed to
- * call close() on the writer.
- */
- explicit TextWriter(FILE *fp);
- /*! \brief
- * Creates a writer that writes to specified stream.
- *
- * \param[in] stream Stream to write to.
- * \throws std::bad_alloc if out of memory.
- *
- * The caller is responsible of the lifetime of the stream (should
- * remain in existence as long as the writer exists).
- *
- * This constructor is provided for convenience for cases where the
- * stream is not allocated with `new` and/or not managed by a
- * std::shared_ptr (e.g., if the stream is an object on the stack).
- */
- explicit TextWriter(TextOutputStream *stream);
- /*! \brief
- * Creates a writer that writes to specified stream.
- *
- * \param[in] stream Stream to write to.
- * \throws std::bad_alloc if out of memory.
- *
- * The writer keeps a reference to the stream, so the caller can pass
- * in a temporary if necessary.
- */
- explicit TextWriter(const TextOutputStreamPointer &stream);
- ~TextWriter();
+ /*! \brief
+ * Creates a writer that writes to specified file.
+ *
+ * \param[in] filename Path to the file to open.
+ * \throws std::bad_alloc if out of memory.
+ * \throws FileIOError on any I/O error.
+ *
+ * This constructor is provided for convenience for writing directly to
+ * a file, without the need to construct multiple objects.
+ */
+ explicit TextWriter(const std::string& filename);
+ /*! \brief
+ * Creates a writer that writes to specified file.
+ *
+ * \param[in] fp File handle to write to.
+ * \throws std::bad_alloc if out of memory.
+ * \throws FileIOError on any I/O error.
+ *
+ * This constructor is provided for interoperability with C-like code
+ * for writing directly to an already opened file, without the need to
+ * construct multiple objects.
+ *
+ * The caller is responsible of closing \p fp; it is not allowed to
+ * call close() on the writer.
+ */
+ explicit TextWriter(FILE* fp);
+ /*! \brief
+ * Creates a writer that writes to specified stream.
+ *
+ * \param[in] stream Stream to write to.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * The caller is responsible of the lifetime of the stream (should
+ * remain in existence as long as the writer exists).
+ *
+ * This constructor is provided for convenience for cases where the
+ * stream is not allocated with `new` and/or not managed by a
+ * std::shared_ptr (e.g., if the stream is an object on the stack).
+ */
+ explicit TextWriter(TextOutputStream* stream);
+ /*! \brief
+ * Creates a writer that writes to specified stream.
+ *
+ * \param[in] stream Stream to write to.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * The writer keeps a reference to the stream, so the caller can pass
+ * in a temporary if necessary.
+ */
+ explicit TextWriter(const TextOutputStreamPointer& stream);
+ ~TextWriter();
- /*! \brief
- * Allows adjusting wrapping settings for the writer.
- *
- * \todo
- * Wrapping is not currently implemented for code that writes partial
- * lines with writeString().
- */
- TextLineWrapperSettings &wrapperSettings();
+ /*! \brief
+ * Allows adjusting wrapping settings for the writer.
+ *
+ * \todo
+ * Wrapping is not currently implemented for code that writes partial
+ * lines with writeString().
+ */
+ TextLineWrapperSettings& wrapperSettings();
- /*! \brief
- * Writes a string to the stream.
- *
- * \param[in] str String to write.
- */
- void writeString(const char *str);
- //! \copydoc writeString(const char *)
- void writeString(const std::string &str);
- //! Writes a string to the stream, with printf-style formatting.
- void writeStringFormatted(const char *fmt, ...);
- /*! \brief
- * Writes a line to the stream.
- *
- * \param[in] line Line to write.
- *
- * If \p line does not end in a newline, one newline is appended.
- * Otherwise, works as writeString().
- */
- void writeLine(const char *line);
- //! \copydoc writeLine(const char *)
- void writeLine(const std::string &line);
- //! Writes a line to the stream, with printf-style formatting.
- void writeLineFormatted(const char *fmt, ...);
- //! Writes a newline to the stream.
- void writeLine();
+ /*! \brief
+ * Writes a string to the stream.
+ *
+ * \param[in] str String to write.
+ */
+ void writeString(const char* str);
+ //! \copydoc writeString(const char *)
+ void writeString(const std::string& str);
+ //! Writes a string to the stream, with printf-style formatting.
+ void writeStringFormatted(const char* fmt, ...);
+ /*! \brief
+ * Writes a line to the stream.
+ *
+ * \param[in] line Line to write.
+ *
+ * If \p line does not end in a newline, one newline is appended.
+ * Otherwise, works as writeString().
+ */
+ void writeLine(const char* line);
+ //! \copydoc writeLine(const char *)
+ void writeLine(const std::string& line);
+ //! Writes a line to the stream, with printf-style formatting.
+ void writeLineFormatted(const char* fmt, ...);
+ //! Writes a newline to the stream.
+ void writeLine();
- /*! \brief
- * Writes a newline if previous output did not end in one.
- *
- * If nothing has been written using the writer, this method does
- * nothing.
- */
- void ensureLineBreak();
- /*! \brief
- * Ensures that the next string written starts after an empty line.
- *
- * Always terminates the current line (as with ensureLineBreak()), but
- * the empty line is only written out when the next line is written,
- * so that trailing newlines after final output can be avoided.
- *
- * If nothing has been written using the writer, this method does
- * nothing.
- */
- void ensureEmptyLine();
+ /*! \brief
+ * Writes a newline if previous output did not end in one.
+ *
+ * If nothing has been written using the writer, this method does
+ * nothing.
+ */
+ void ensureLineBreak();
+ /*! \brief
+ * Ensures that the next string written starts after an empty line.
+ *
+ * Always terminates the current line (as with ensureLineBreak()), but
+ * the empty line is only written out when the next line is written,
+ * so that trailing newlines after final output can be avoided.
+ *
+ * If nothing has been written using the writer, this method does
+ * nothing.
+ */
+ void ensureEmptyLine();
- /*! \brief
- * Closes the underlying stream.
- */
- void close();
+ /*! \brief
+ * Closes the underlying stream.
+ */
+ void close();
- private:
- class Impl;
+private:
+ class Impl;
- PrivateImplPointer<Impl> impl_;
+ PrivateImplPointer<Impl> impl_;
};
} // namespace gmx
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff