src/gromacs/utility/message_string_collector.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2011,2012,2014,2016,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 /*! \internal \file
  36  * \brief
  37  * Implements gmx::MessageStringCollector.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "message_string_collector.h"
  45
  46 #include <vector>
  47
  48 #include "gromacs/utility/gmxassert.h"
  49
  50 namespace gmx
  51 {
  52
  53 class MessageStringCollector::Impl
  54 {
  55 public:
  56     Impl() : prevContext_(0) {}
  57
  58     std::vector<std::string> contexts_;
  59     std::string              text_;
  60     size_t                   prevContext_;
  61 };
  62
  63 MessageStringCollector::MessageStringCollector() : impl_(new Impl) {}
  64
  65 MessageStringCollector::~MessageStringCollector() {}
  66
  67 void MessageStringCollector::startContext(const char* name)
  68 {
  69     impl_->contexts_.emplace_back(name);
  70 }
  71
  72 void MessageStringCollector::append(const std::string& message)
  73 {
  74     int indent = static_cast<int>(impl_->prevContext_ * 2);
  75     if (!impl_->contexts_.empty())
  76     {
  77         std::vector<std::string>::const_iterator ci;
  78         for (ci = impl_->contexts_.begin() + impl_->prevContext_; ci != impl_->contexts_.end(); ++ci)
  79         {
  80             impl_->text_.append(indent, ' ');
  81             impl_->text_.append(*ci);
  82             impl_->text_.append("\n");
  83             indent += 2;
  84         }
  85     }
  86     impl_->prevContext_ = impl_->contexts_.size();
  87
  88     // TODO: Put this into a more generic helper, could be useful elsewhere
  89     size_t pos = 0;
  90     while (pos < message.size())
  91     {
  92         size_t nextpos = message.find_first_of('\n', pos);
  93         impl_->text_.append(indent, ' ');
  94         impl_->text_.append(message.substr(pos, nextpos - pos));
  95         impl_->text_.append("\n");
  96         if (nextpos == std::string::npos)
  97         {
  98             break;
  99         }
 100         pos = nextpos + 1;
 101     }
 102 }
 103
 104 void MessageStringCollector::appendIf(bool condition, const char* message)
 105 {
 106     if (condition)
 107     {
 108         append(std::string(message));
 109     }
 110 }
 111
 112 void MessageStringCollector::appendIf(bool condition, const std::string& message)
 113 {
 114     if (condition)
 115     {
 116         append(message);
 117     }
 118 }
 119
 120 void MessageStringCollector::finishContext()
 121 {
 122     GMX_RELEASE_ASSERT(!impl_->contexts_.empty(), "finishContext() called without context");
 123     impl_->contexts_.pop_back();
 124     if (impl_->prevContext_ > impl_->contexts_.size())
 125     {
 126         impl_->prevContext_ = impl_->contexts_.size();
 127     }
 128 }
 129
 130 void MessageStringCollector::clear()
 131 {
 132     impl_->contexts_.clear();
 133     impl_->text_.clear();
 134     impl_->prevContext_ = 0;
 135 }
 136
 137 bool MessageStringCollector::isEmpty() const
 138 {
 139     return impl_->text_.empty();
 140 }
 141
 142 std::string MessageStringCollector::toString() const
 143 {
 144     return impl_->text_;
 145 }
 146
 147 } // namespace gmx