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.
   5  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Implements classes and functions from helptopic.h.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_onlinehelp
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "helptopic.h"
  46
  47 #include <map>
  48 #include <utility>
  49
  50 #include "gromacs/onlinehelp/helpformat.h"
  51 #include "gromacs/onlinehelp/helpwritercontext.h"
  52 #include "gromacs/utility/exceptions.h"
  53 #include "gromacs/utility/gmxassert.h"
  54 #include "gromacs/utility/stringutil.h"
  55 #include "gromacs/utility/textwriter.h"
  56
  57 namespace gmx
  58 {
  59
  60 /********************************************************************
  61  * AbstractSimpleHelpTopic
  62  */
  63
  64 bool AbstractSimpleHelpTopic::hasSubTopics() const
  65 {
  66     return false;
  67 }
  68
  69 const IHelpTopic* 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() : impl_(new Impl) {}
 115
 116 AbstractCompositeHelpTopic::~AbstractCompositeHelpTopic() {}
 117
 118 bool AbstractCompositeHelpTopic::hasSubTopics() const
 119 {
 120     return !impl_->subTopics_.empty();
 121 }
 122
 123 const IHelpTopic* AbstractCompositeHelpTopic::findSubTopic(const char* name) const
 124 {
 125     Impl::SubTopicMap::const_iterator topic = impl_->subTopicMap_.find(name);
 126     if (topic == impl_->subTopicMap_.end())
 127     {
 128         return nullptr;
 129     }
 130     return topic->second;
 131 }
 132
 133 void AbstractCompositeHelpTopic::writeHelp(const HelpWriterContext& context) const
 134 {
 135     context.writeTextBlock(helpText());
 136     writeSubTopicList(context, "\nAvailable subtopics:");
 137 }
 138
 139 bool AbstractCompositeHelpTopic::writeSubTopicList(const HelpWriterContext& context,
 140                                                    const std::string&       title) const
 141 {
 142     if (context.outputFormat() != eHelpOutputFormat_Console)
 143     {
 144         Impl::SubTopicList::const_iterator topic;
 145         for (topic = impl_->subTopics_.begin(); topic != impl_->subTopics_.end(); ++topic)
 146         {
 147             const char* const title = (*topic)->title();
 148             if (!isNullOrEmpty(title))
 149             {
 150                 context.paragraphBreak();
 151                 HelpWriterContext subContext(context);
 152                 subContext.enterSubSection(title);
 153                 (*topic)->writeHelp(subContext);
 154             }
 155         }
 156         return true;
 157     }
 158     int                               maxNameLength = 0;
 159     Impl::SubTopicMap::const_iterator topic;
 160     for (topic = impl_->subTopicMap_.begin(); topic != impl_->subTopicMap_.end(); ++topic)
 161     {
 162         const char* const title = topic->second->title();
 163         if (!isNullOrEmpty(title))
 164         {
 165             int nameLength = static_cast<int>(topic->first.length());
 166             if (nameLength > maxNameLength)
 167             {
 168                 maxNameLength = nameLength;
 169             }
 170         }
 171     }
 172     if (maxNameLength == 0)
 173     {
 174         return false;
 175     }
 176     TextWriter&        file = context.outputFile();
 177     TextTableFormatter formatter;
 178     formatter.addColumn(nullptr, maxNameLength + 1, false);
 179     formatter.addColumn(nullptr, 72 - maxNameLength, true);
 180     formatter.setFirstColumnIndent(4);
 181     file.writeLine(title);
 182     for (topic = impl_->subTopicMap_.begin(); topic != impl_->subTopicMap_.end(); ++topic)
 183     {
 184         const char* const name  = topic->first.c_str();
 185         const char* const title = topic->second->title();
 186         if (!isNullOrEmpty(title))
 187         {
 188             formatter.clear();
 189             formatter.addColumnLine(0, name);
 190             formatter.addColumnLine(1, title);
 191             file.writeString(formatter.formatRow());
 192         }
 193     }
 194     return true;
 195 }
 196
 197 void AbstractCompositeHelpTopic::addSubTopic(HelpTopicPointer topic)
 198 {
 199     GMX_ASSERT(impl_->subTopicMap_.find(topic->name()) == impl_->subTopicMap_.end(),
 200                "Attempted to register a duplicate help topic name");
 201     const IHelpTopic* topicPtr = topic.get();
 202     impl_->subTopics_.reserve(impl_->subTopics_.size() + 1);
 203     impl_->subTopicMap_.insert(std::make_pair(std::string(topicPtr->name()), topicPtr));
 204     impl_->subTopics_.push_back(std::move(topic));
 205 }
 206
 207 } // namespace gmx