src/gromacs/utility/message_string_collector.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2011,2012,2013,2014,2019,2021, 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::MessageStringCollector.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_MESSAGE_STRING_COLLECTOR_H
  44 #define GMX_UTILITY_MESSAGE_STRING_COLLECTOR_H
  45
  46 #include <memory>
  47 #include <string>
  48
  49 #include "gromacs/utility/classhelpers.h"
  50
  51 namespace gmx
  52 {
  53
  54 /*! \libinternal \brief
  55  * Helper class for collecting message strings, optionally with context.
  56  *
  57  * After strings have been collected, they can be formatted into one long
  58  * string for, e.g., printing out or for including in an exception.
  59  *
  60  * \inlibraryapi
  61  * \ingroup module_utility
  62  */
  63 class MessageStringCollector
  64 {
  65 public:
  66     MessageStringCollector();
  67     ~MessageStringCollector();
  68
  69     /*! \brief
  70      * Starts a context for messages.
  71      *
  72      * \param[in] name  Short description of the context.
  73      *
  74      * \see finishContext()
  75      * \see MessageStringContext
  76      */
  77     void startContext(const char* name);
  78     /*! \brief
  79      * Convenience wrapper for startContext(const char *).
  80      */
  81     void startContext(const std::string& name) { startContext(name.c_str()); }
  82     /*! \brief
  83      * Adds a new message.
  84      */
  85     void append(const char* message) { append(std::string(message)); }
  86     /*! \brief
  87      * Adds a new message.
  88      */
  89     void append(const std::string& message);
  90     /*! \brief
  91      * Adds a new message if the condition is satisfied..
  92      */
  93     void appendIf(bool condition, const char* message);
  94     /*! \brief
  95      * Adds a new message if the condition is satisfied.
  96      */
  97     void appendIf(bool condition, const std::string& message);
  98     /*! \brief
  99      * Ends a context started with startContext().
 100      *
 101      * \see MessageStringContext
 102      */
 103     void finishContext();
 104     /*! \brief
 105      * Clears all collected messages.
 106      */
 107     void clear();
 108
 109     /*! \brief
 110      * Returns false if any messages have been added.
 111      *
 112      * \returns false if append() has been called at least once.
 113      *
 114      * The return value is identical to `toString().empty()`.
 115      * Calls to startContext() or finishContext() do not affect the
 116      * return value of this function.
 117      */
 118     bool isEmpty() const;
 119     /*! \brief
 120      * Returns all collected messages as one string.
 121      */
 122     std::string toString() const;
 123
 124 private:
 125     class Impl;
 126
 127     std::unique_ptr<Impl> impl_;
 128 };
 129
 130 /*! \libinternal \brief
 131  * Convenience class for creating a message context.
 132  *
 133  * This class provides a RAII-style interface to the
 134  * MessageStringCollector::startContext() and
 135  * MessageStringCollector::finishContext() methods: finishContext() is called
 136  * upon destruction of the object.  This avoids the need to call
 137  * MessageStringCollector::finishContext() on every possible exit point.
 138  *
 139  * Example usage:
 140  * \code
 141    bool function(::gmx::MessageStringCollector *errors)
 142    {
 143        ::gmx::MessageStringContext errcontext(errors, "In function()");
 144        bool bOk = function2(errors);
 145        bOk = function3(errors) && bOk;
 146        // <more processing>
 147        return bOk;
 148    }
 149    \endcode
 150  *
 151  * \see MessageStringCollector
 152  * \inlibraryapi
 153  * \ingroup module_utility
 154  */
 155 class MessageStringContext
 156 {
 157 public:
 158     /*! \brief
 159      * Adds a context for the given object.
 160      */
 161     MessageStringContext(MessageStringCollector* collector, const char* name) :
 162         collector_(*collector)
 163     {
 164         collector_.startContext(name);
 165     }
 166     /*! \brief
 167      * Adds a context for the given object.
 168      */
 169     MessageStringContext(MessageStringCollector* collector, const std::string& name) :
 170         collector_(*collector)
 171     {
 172         collector_.startContext(name);
 173     }
 174     /*! \brief
 175      * Calls MessageStringCollector::finishContext() on the wrapped object.
 176      */
 177     ~MessageStringContext() { collector_.finishContext(); }
 178
 179 private:
 180     //! The wrapped object.
 181     MessageStringCollector& collector_;
 182
 183     GMX_DISALLOW_COPY_AND_ASSIGN(MessageStringContext);
 184 };
 185
 186 } // namespace gmx
 187
 188 #endif // GMX_UTILITY_MESSAGE_STRING_COLLECTOR_H