/*
* This file is part of the GROMACS molecular simulation package.
*
- * Copyright (c) 2015,2017, by the GROMACS development team, led by
+ * Copyright (c) 2015,2017,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 TextReader
{
- public:
- /*! \brief
- * Reads contents of a file to a std::string.
- *
- * \param[in] filename Name of the file to read.
- * \returns The contents of \p filename.
- * \throws std::bad_alloc if out of memory.
- * \throws FileIOError on any I/O error.
- */
- static std::string readFileToString(const char *filename);
- //! \copydoc readFileToString(const char *)
- static std::string readFileToString(const std::string &filename);
+public:
+ /*! \brief
+ * Reads contents of a file to a std::string.
+ *
+ * \param[in] filename Name of the file to read.
+ * \returns The contents of \p filename.
+ * \throws std::bad_alloc if out of memory.
+ * \throws FileIOError on any I/O error.
+ */
+ static std::string readFileToString(const char* filename);
+ //! \copydoc readFileToString(const char *)
+ static std::string readFileToString(const std::string& filename);
- /*! \brief
- * Creates a reader that reads from 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 reading directly
- * from a file, without the need to construct multiple objects.
- */
- explicit TextReader(const std::string &filename);
- /*! \brief
- * Creates a reader that reads from specified stream.
- *
- * \param[in] stream Stream to read from.
- * \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 reader 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 TextReader(TextInputStream *stream);
- /*! \brief
- * Creates a reader that reads from specified stream.
- *
- * \param[in] stream Stream to read from.
- * \throws std::bad_alloc if out of memory.
- *
- * The reader keeps a reference to the stream, so the caller can pass
- * in a temporary if necessary.
- */
- explicit TextReader(const TextInputStreamPointer &stream);
- ~TextReader();
+ /*! \brief
+ * Creates a reader that reads from 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 reading directly
+ * from a file, without the need to construct multiple objects.
+ */
+ explicit TextReader(const std::string& filename);
+ /*! \brief
+ * Creates a reader that reads from specified stream.
+ *
+ * \param[in] stream Stream to read from.
+ * \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 reader 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 TextReader(TextInputStream* stream);
+ /*! \brief
+ * Creates a reader that reads from specified stream.
+ *
+ * \param[in] stream Stream to read from.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * The reader keeps a reference to the stream, so the caller can pass
+ * in a temporary if necessary.
+ */
+ explicit TextReader(const TextInputStreamPointer& stream);
+ ~TextReader();
- /*! \brief
- * Reads a single line (including newline) from the stream.
- *
- * \param[out] line String to receive the line.
- * \returns `false` if nothing was read because the file ended.
- *
- * On error or when false is returned, \p line will be empty.
- * Newlines will be returned as part of \p line if it was present in
- * the stream.
- * To loop over all lines in the stream, use:
- * \code
- std::string line;
- while (reader.readLine(&line))
- {
- // ...
- }
- \endcode
- *
- * Behaviours such as trimming whitespace or comments can be
- * configured by calling other methods before this one.
- */
- bool readLine(std::string *line);
- /*! \brief Sets whether the reader should trim leading whitespace
- * from a line before returning it.
- *
- * \param[in] doTrimming Whether trimming should be active.
- */
- void setTrimLeadingWhiteSpace(bool doTrimming);
- /*! \brief Sets whether the reader should trim trailing whitespace
- * from a line before returning it.
- *
- * Note that comment trimming will precede whitespace trimming
- * when both are active.
- *
- * \param[in] doTrimming Whether trimming should be active.
- */
- void setTrimTrailingWhiteSpace(bool doTrimming);
- /*! \brief Sets whether the reader should trim at trailing
- * comment from a line before returning it.
- *
- * Note that comment trimming will precede whitespace trimming
- * when both are active.
- *
- * \param[in] commentChar The character that begins a comment.
- *
- * \param[in] doTrimming Whether trimming should be active.
- */
- void setTrimTrailingComment(bool doTrimming, char commentChar);
- /*! \brief
- * Reads all remaining lines from the stream as a single string.
- *
- * \returns Full contents of the stream (from the current point to
- * the end).
- */
- std::string readAll();
+ /*! \brief
+ * Reads a single line (including newline) from the stream.
+ *
+ * \param[out] line String to receive the line.
+ * \returns `false` if nothing was read because the file ended.
+ *
+ * On error or when false is returned, \p line will be empty.
+ * Newlines will be returned as part of \p line if it was present in
+ * the stream.
+ * To loop over all lines in the stream, use:
+ * \code
+ std::string line;
+ while (reader.readLine(&line))
+ {
+ // ...
+ }
+ \endcode
+ *
+ * Behaviours such as trimming whitespace or comments can be
+ * configured by calling other methods before this one.
+ */
+ bool readLine(std::string* line);
+ /*! \brief Sets whether the reader should trim leading whitespace
+ * from a line before returning it.
+ *
+ * \param[in] doTrimming Whether trimming should be active.
+ */
+ void setTrimLeadingWhiteSpace(bool doTrimming);
+ /*! \brief Sets whether the reader should trim trailing whitespace
+ * from a line before returning it.
+ *
+ * Note that comment trimming will precede whitespace trimming
+ * when both are active.
+ *
+ * \param[in] doTrimming Whether trimming should be active.
+ */
+ void setTrimTrailingWhiteSpace(bool doTrimming);
+ /*! \brief Sets whether the reader should trim at trailing
+ * comment from a line before returning it.
+ *
+ * Note that comment trimming will precede whitespace trimming
+ * when both are active.
+ *
+ * \param[in] commentChar The character that begins a comment.
+ *
+ * \param[in] doTrimming Whether trimming should be active.
+ */
+ void setTrimTrailingComment(bool doTrimming, char commentChar);
+ /*! \brief
+ * Reads all remaining lines from the stream as a single string.
+ *
+ * \returns Full contents of the stream (from the current point to
+ * the end).
+ */
+ std::string readAll();
- /*! \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