src/gromacs/utility/messagestringcollector.h

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