src/gromacs/onlinehelp/helptopic.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2017, 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 classes and functions from helptopic.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_onlinehelp
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "helptopic.h"
  45
  46 #include <map>
  47 #include <utility>
  48
  49 #include "gromacs/onlinehelp/helpformat.h"
  50 #include "gromacs/onlinehelp/helpwritercontext.h"
  51 #include "gromacs/utility/exceptions.h"
  52 #include "gromacs/utility/gmxassert.h"
  53 #include "gromacs/utility/stringutil.h"
  54 #include "gromacs/utility/textwriter.h"
  55
  56 namespace gmx
  57 {
  58
  59 /********************************************************************
  60  * AbstractSimpleHelpTopic
  61  */
  62
  63 bool AbstractSimpleHelpTopic::hasSubTopics() const
  64 {
  65     return false;
  66 }
  67
  68 const IHelpTopic *
  69 AbstractSimpleHelpTopic::findSubTopic(const char * /* name */) const
  70 {
  71     return nullptr;
  72 }
  73
  74 void AbstractSimpleHelpTopic::writeHelp(const HelpWriterContext &context) const
  75 {
  76     context.writeTextBlock(helpText());
  77 }
  78
  79 /********************************************************************
  80  * AbstractCompositeHelpTopic::Impl
  81  */
  82
  83 /*! \internal \brief
  84  * Private implementation class for AbstractCompositeHelpTopic.
  85  *
  86  * \ingroup module_onlinehelp
  87  */
  88 class AbstractCompositeHelpTopic::Impl
  89 {
  90     public:
  91         //! Container for subtopics.
  92         typedef std::vector<HelpTopicPointer> SubTopicList;
  93         //! Container for mapping subtopic names to help topic objects.
  94         typedef std::map<std::string, const IHelpTopic *> SubTopicMap;
  95
  96         /*! \brief
  97          * Subtopics in the order they were added.
  98          *
  99          * Owns the contained subtopics.
 100          */
 101         SubTopicList            subTopics_;
 102         /*! \brief
 103          * Maps subtopic names to help topic objects.
 104          *
 105          * Points to objects in the \a subTopics_ map.
 106          */
 107         SubTopicMap             subTopicMap_;
 108 };
 109
 110 /********************************************************************
 111  * AbstractCompositeHelpTopic
 112  */
 113
 114 AbstractCompositeHelpTopic::AbstractCompositeHelpTopic()
 115     : impl_(new Impl)
 116 {
 117 }
 118
 119 AbstractCompositeHelpTopic::~AbstractCompositeHelpTopic()
 120 {
 121 }
 122
 123 bool AbstractCompositeHelpTopic::hasSubTopics() const
 124 {
 125     return !impl_->subTopics_.empty();
 126 }
 127
 128 const IHelpTopic *
 129 AbstractCompositeHelpTopic::findSubTopic(const char *name) const
 130 {
 131     Impl::SubTopicMap::const_iterator topic = impl_->subTopicMap_.find(name);
 132     if (topic == impl_->subTopicMap_.end())
 133     {
 134         return nullptr;
 135     }
 136     return topic->second;
 137 }
 138
 139 void AbstractCompositeHelpTopic::writeHelp(const HelpWriterContext &context) const
 140 {
 141     context.writeTextBlock(helpText());
 142     writeSubTopicList(context, "\nAvailable subtopics:");
 143 }
 144
 145 bool
 146 AbstractCompositeHelpTopic::writeSubTopicList(const HelpWriterContext &context,
 147                                               const std::string       &title) const
 148 {
 149     if (context.outputFormat() != eHelpOutputFormat_Console)
 150     {
 151         Impl::SubTopicList::const_iterator topic;
 152         for (topic = impl_->subTopics_.begin(); topic != impl_->subTopics_.end(); ++topic)
 153         {
 154             const char *const title = (*topic)->title();
 155             if (!isNullOrEmpty(title))
 156             {
 157                 context.paragraphBreak();
 158                 HelpWriterContext subContext(context);
 159                 subContext.enterSubSection(title);
 160                 (*topic)->writeHelp(subContext);
 161             }
 162         }
 163         return true;
 164     }
 165     int maxNameLength = 0;
 166     Impl::SubTopicMap::const_iterator topic;
 167     for (topic = impl_->subTopicMap_.begin(); topic != impl_->subTopicMap_.end(); ++topic)
 168     {
 169         const char *const title = topic->second->title();
 170         if (!isNullOrEmpty(title))
 171         {
 172             int nameLength = static_cast<int>(topic->first.length());
 173             if (nameLength > maxNameLength)
 174             {
 175                 maxNameLength = nameLength;
 176             }
 177         }
 178     }
 179     if (maxNameLength == 0)
 180     {
 181         return false;
 182     }
 183     TextWriter        &file = context.outputFile();
 184     TextTableFormatter formatter;
 185     formatter.addColumn(nullptr, maxNameLength + 1, false);
 186     formatter.addColumn(nullptr, 72 - maxNameLength, true);
 187     formatter.setFirstColumnIndent(4);
 188     file.writeLine(title);
 189     for (topic = impl_->subTopicMap_.begin(); topic != impl_->subTopicMap_.end(); ++topic)
 190     {
 191         const char *const name  = topic->first.c_str();
 192         const char *const title = topic->second->title();
 193         if (!isNullOrEmpty(title))
 194         {
 195             formatter.clear();
 196             formatter.addColumnLine(0, name);
 197             formatter.addColumnLine(1, title);
 198             file.writeString(formatter.formatRow());
 199         }
 200     }
 201     return true;
 202 }
 203
 204 void AbstractCompositeHelpTopic::addSubTopic(HelpTopicPointer topic)
 205 {
 206     GMX_ASSERT(impl_->subTopicMap_.find(topic->name()) == impl_->subTopicMap_.end(),
 207                "Attempted to register a duplicate help topic name");
 208     const IHelpTopic *topicPtr = topic.get();
 209     impl_->subTopics_.reserve(impl_->subTopics_.size() + 1);
 210     impl_->subTopicMap_.insert(std::make_pair(std::string(topicPtr->name()), topicPtr));
 211     impl_->subTopics_.push_back(std::move(topic));
 212 }
 213
 214 } // namespace gmx