2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014, 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 classes and functions from helptopic.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_onlinehelp
44 #include "helptopic.h"
49 #include "gromacs/onlinehelp/helpformat.h"
50 #include "gromacs/onlinehelp/helpwritercontext.h"
51 #include "gromacs/utility/exceptions.h"
52 #include "gromacs/utility/file.h"
53 #include "gromacs/utility/gmxassert.h"
54 #include "gromacs/utility/stringutil.h"
60 void writeBasicHelpTopic(const HelpWriterContext &context,
61 const HelpTopicInterface &topic,
62 const std::string &text)
64 const char *title = topic.title();
65 if (title != NULL && title[0] != '\0')
67 context.writeTitle(title);
69 context.writeTextBlock(text);
73 /********************************************************************
74 * AbstractSimpleHelpTopic
77 bool AbstractSimpleHelpTopic::hasSubTopics() const
82 const HelpTopicInterface *
83 AbstractSimpleHelpTopic::findSubTopic(const char * /* name */) const
88 void AbstractSimpleHelpTopic::writeHelp(const HelpWriterContext &context) const
90 writeBasicHelpTopic(context, *this, helpText());
93 /********************************************************************
94 * AbstractCompositeHelpTopic::Impl
98 * Private implementation class for AbstractCompositeHelpTopic.
100 * \ingroup module_onlinehelp
102 class AbstractCompositeHelpTopic::Impl
105 //! Container for mapping subtopic names to help topic objects.
106 typedef std::map<std::string, HelpTopicPointer> SubTopicMap;
109 * Maps subtopic names to help topic objects.
111 * Owns the contained subtopics.
113 SubTopicMap subtopics_;
116 /********************************************************************
117 * AbstractCompositeHelpTopic
120 AbstractCompositeHelpTopic::AbstractCompositeHelpTopic()
125 AbstractCompositeHelpTopic::~AbstractCompositeHelpTopic()
129 bool AbstractCompositeHelpTopic::hasSubTopics() const
131 return !impl_->subtopics_.empty();
134 const HelpTopicInterface *
135 AbstractCompositeHelpTopic::findSubTopic(const char *name) const
137 Impl::SubTopicMap::const_iterator topic = impl_->subtopics_.find(name);
138 if (topic == impl_->subtopics_.end())
142 return topic->second.get();
145 void AbstractCompositeHelpTopic::writeHelp(const HelpWriterContext &context) const
147 writeBasicHelpTopic(context, *this, helpText());
148 writeSubTopicList(context, "\nAvailable subtopics:");
152 AbstractCompositeHelpTopic::writeSubTopicList(const HelpWriterContext &context,
153 const std::string &title) const
155 if (context.outputFormat() != eHelpOutputFormat_Console)
157 // TODO: Implement once the situation with Redmine issue #969 is more
159 GMX_THROW(NotImplementedError(
160 "Subtopic listing is not implemented for this output format"));
162 int maxNameLength = 0;
163 Impl::SubTopicMap::const_iterator topic;
164 for (topic = impl_->subtopics_.begin(); topic != impl_->subtopics_.end(); ++topic)
166 const char *title = topic->second->title();
167 if (title == NULL || title[0] == '\0')
171 int nameLength = static_cast<int>(topic->first.length());
172 if (nameLength > maxNameLength)
174 maxNameLength = nameLength;
177 if (maxNameLength == 0)
181 File &file = context.outputFile();
182 TextTableFormatter formatter;
183 formatter.addColumn(NULL, maxNameLength + 1, false);
184 formatter.addColumn(NULL, 72 - maxNameLength, true);
185 formatter.setFirstColumnIndent(4);
186 file.writeLine(title);
187 for (topic = impl_->subtopics_.begin(); topic != impl_->subtopics_.end(); ++topic)
189 const char *name = topic->first.c_str();
190 const char *title = topic->second->title();
191 if (title != NULL && title[0] != '\0')
194 formatter.addColumnLine(0, name);
195 formatter.addColumnLine(1, title);
196 file.writeString(formatter.formatRow());
202 void AbstractCompositeHelpTopic::addSubTopic(HelpTopicPointer topic)
204 GMX_ASSERT(impl_->subtopics_.find(topic->name()) == impl_->subtopics_.end(),
205 "Attempted to register a duplicate help topic name");
206 impl_->subtopics_.insert(std::make_pair(std::string(topic->name()),