--- /dev/null
+/*
+ * This file is part of the GROMACS molecular simulation package.
+ *
+ * Copyright (c) 2011,2012,2013,2014,2019,2021, 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.
+ *
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
+ *
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
+ *
+ * To help us fund GROMACS development, we humbly ask that you cite
+ * the research papers on the package. Check out http://www.gromacs.org.
+ */
+/*! \libinternal \file
+ * \brief
+ * Declares ::gmx::MessageStringCollector.
+ *
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
+ * \inlibraryapi
+ * \ingroup module_utility
+ */
+#ifndef GMX_UTILITY_MESSAGE_STRING_COLLECTOR_H
+#define GMX_UTILITY_MESSAGE_STRING_COLLECTOR_H
+
+#include <memory>
+#include <string>
+
+#include "gromacs/utility/classhelpers.h"
+
+namespace gmx
+{
+
+/*! \libinternal \brief
+ * Helper class for collecting message strings, optionally with context.
+ *
+ * After strings have been collected, they can be formatted into one long
+ * string for, e.g., printing out or for including in an exception.
+ *
+ * \inlibraryapi
+ * \ingroup module_utility
+ */
+class MessageStringCollector
+{
+public:
+ MessageStringCollector();
+ ~MessageStringCollector();
+
+ /*! \brief
+ * Starts a context for messages.
+ *
+ * \param[in] name Short description of the context.
+ *
+ * \see finishContext()
+ * \see MessageStringContext
+ */
+ void startContext(const char* name);
+ /*! \brief
+ * Convenience wrapper for startContext(const char *).
+ */
+ void startContext(const std::string& name) { startContext(name.c_str()); }
+ /*! \brief
+ * Adds a new message.
+ */
+ void append(const char* message) { append(std::string(message)); }
+ /*! \brief
+ * Adds a new message.
+ */
+ void append(const std::string& message);
+ /*! \brief
+ * Adds a new message if the condition is satisfied..
+ */
+ void appendIf(bool condition, const char* message);
+ /*! \brief
+ * Adds a new message if the condition is satisfied.
+ */
+ void appendIf(bool condition, const std::string& message);
+ /*! \brief
+ * Ends a context started with startContext().
+ *
+ * \see MessageStringContext
+ */
+ void finishContext();
+ /*! \brief
+ * Clears all collected messages.
+ */
+ void clear();
+
+ /*! \brief
+ * Returns false if any messages have been added.
+ *
+ * \returns false if append() has been called at least once.
+ *
+ * The return value is identical to `toString().empty()`.
+ * Calls to startContext() or finishContext() do not affect the
+ * return value of this function.
+ */
+ bool isEmpty() const;
+ /*! \brief
+ * Returns all collected messages as one string.
+ */
+ std::string toString() const;
+
+private:
+ class Impl;
+
+ std::unique_ptr<Impl> impl_;
+};
+
+/*! \libinternal \brief
+ * Convenience class for creating a message context.
+ *
+ * This class provides a RAII-style interface to the
+ * MessageStringCollector::startContext() and
+ * MessageStringCollector::finishContext() methods: finishContext() is called
+ * upon destruction of the object. This avoids the need to call
+ * MessageStringCollector::finishContext() on every possible exit point.
+ *
+ * Example usage:
+ * \code
+ bool function(::gmx::MessageStringCollector *errors)
+ {
+ ::gmx::MessageStringContext errcontext(errors, "In function()");
+ bool bOk = function2(errors);
+ bOk = function3(errors) && bOk;
+ // <more processing>
+ return bOk;
+ }
+ \endcode
+ *
+ * \see MessageStringCollector
+ * \inlibraryapi
+ * \ingroup module_utility
+ */
+class MessageStringContext
+{
+public:
+ /*! \brief
+ * Adds a context for the given object.
+ */
+ MessageStringContext(MessageStringCollector* collector, const char* name) :
+ collector_(*collector)
+ {
+ collector_.startContext(name);
+ }
+ /*! \brief
+ * Adds a context for the given object.
+ */
+ MessageStringContext(MessageStringCollector* collector, const std::string& name) :
+ collector_(*collector)
+ {
+ collector_.startContext(name);
+ }
+ /*! \brief
+ * Calls MessageStringCollector::finishContext() on the wrapped object.
+ */
+ ~MessageStringContext() { collector_.finishContext(); }
+
+private:
+ //! The wrapped object.
+ MessageStringCollector& collector_;
+
+ GMX_DISALLOW_COPY_AND_ASSIGN(MessageStringContext);
+};
+
+} // namespace gmx
+
+#endif // GMX_UTILITY_MESSAGE_STRING_COLLECTOR_H
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff