2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
37 * Implements gmx::MessageStringCollector.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_utility
44 #include "message_string_collector.h"
48 #include "gromacs/utility/gmxassert.h"
53 class MessageStringCollector::Impl
56 Impl() : prevContext_(0) {}
58 std::vector<std::string> contexts_;
63 MessageStringCollector::MessageStringCollector() : impl_(new Impl) {}
65 MessageStringCollector::~MessageStringCollector() = default;
66 MessageStringCollector::MessageStringCollector(MessageStringCollector&&) noexcept = default;
67 MessageStringCollector& MessageStringCollector::operator=(MessageStringCollector&&) noexcept = default;
69 void MessageStringCollector::startContext(const char* name)
71 impl_->contexts_.emplace_back(name);
74 void MessageStringCollector::append(const std::string& message)
76 int indent = static_cast<int>(impl_->prevContext_ * 2);
77 if (!impl_->contexts_.empty())
79 std::vector<std::string>::const_iterator ci;
80 for (ci = impl_->contexts_.begin() + impl_->prevContext_; ci != impl_->contexts_.end(); ++ci)
82 impl_->text_.append(indent, ' ');
83 impl_->text_.append(*ci);
84 impl_->text_.append("\n");
88 impl_->prevContext_ = impl_->contexts_.size();
90 // TODO: Put this into a more generic helper, could be useful elsewhere
92 while (pos < message.size())
94 size_t nextpos = message.find_first_of('\n', pos);
95 impl_->text_.append(indent, ' ');
96 impl_->text_.append(message.substr(pos, nextpos - pos));
97 impl_->text_.append("\n");
98 if (nextpos == std::string::npos)
106 void MessageStringCollector::appendIf(bool condition, const char* message)
110 append(std::string(message));
114 void MessageStringCollector::appendIf(bool condition, const std::string& message)
122 void MessageStringCollector::finishContext()
124 GMX_RELEASE_ASSERT(!impl_->contexts_.empty(), "finishContext() called without context");
125 impl_->contexts_.pop_back();
126 if (impl_->prevContext_ > impl_->contexts_.size())
128 impl_->prevContext_ = impl_->contexts_.size();
132 void MessageStringCollector::clear()
134 impl_->contexts_.clear();
135 impl_->text_.clear();
136 impl_->prevContext_ = 0;
139 bool MessageStringCollector::isEmpty() const
141 return impl_->text_.empty();
144 std::string MessageStringCollector::toString() const