src/gromacs/onlinehelp/helpmanager.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,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 gmx::HelpManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_onlinehelp
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "helpmanager.h"
  45
  46 #include <string>
  47 #include <vector>
  48
  49 #include "gromacs/onlinehelp/helpwritercontext.h"
  50 #include "gromacs/onlinehelp/ihelptopic.h"
  51 #include "gromacs/utility/exceptions.h"
  52 #include "gromacs/utility/stringutil.h"
  53
  54 namespace gmx
  55 {
  56
  57 /********************************************************************
  58  * HelpManager::Impl
  59  */
  60
  61 /*! \internal \brief
  62  * Private implementation class for HelpManager.
  63  *
  64  * \ingroup module_onlinehelp
  65  */
  66 class HelpManager::Impl
  67 {
  68     public:
  69         //! Container type for keeping the stack of active topics.
  70         typedef std::vector<const IHelpTopic *> TopicStack;
  71
  72         //! Initializes a new manager with the given context.
  73         explicit Impl(const HelpWriterContext &context)
  74             : rootContext_(context)
  75         {
  76         }
  77
  78         //! Whether the active topic is the root topic.
  79         bool isAtRootTopic() const { return topicStack_.size() == 1; }
  80         //! Returns the active topic.
  81         const IHelpTopic &currentTopic() const
  82         {
  83             return *topicStack_.back();
  84         }
  85         //! Formats the active topic as a string, including its parent topics.
  86         std::string currentTopicAsString() const;
  87
  88         //! Context with which the manager was initialized.
  89         const HelpWriterContext &rootContext_;
  90         /*! \brief
  91          * Stack of active topics.
  92          *
  93          * The first item is always the root topic, and each item is a subtopic
  94          * of the preceding item.  The last item is the currently active topic.
  95          */
  96         TopicStack               topicStack_;
  97 };
  98
  99 std::string HelpManager::Impl::currentTopicAsString() const
 100 {
 101     std::string                result;
 102     TopicStack::const_iterator topic;
 103     for (topic = topicStack_.begin() + 1; topic != topicStack_.end(); ++topic)
 104     {
 105         if (!result.empty())
 106         {
 107             result.append(" ");
 108         }
 109         result.append((*topic)->name());
 110     }
 111     return result;
 112 }
 113
 114 /********************************************************************
 115  * HelpManager
 116  */
 117
 118 HelpManager::HelpManager(const IHelpTopic         &rootTopic,
 119                          const HelpWriterContext  &context)
 120     : impl_(new Impl(context))
 121 {
 122     impl_->topicStack_.push_back(&rootTopic);
 123 }
 124
 125 HelpManager::~HelpManager()
 126 {
 127 }
 128
 129 void HelpManager::enterTopic(const char *name)
 130 {
 131     const IHelpTopic &topic = impl_->currentTopic();
 132     if (!topic.hasSubTopics())
 133     {
 134         GMX_THROW(InvalidInputError(
 135                           formatString("Help topic '%s' has no subtopics",
 136                                        impl_->currentTopicAsString().c_str())));
 137     }
 138     const IHelpTopic *newTopic = topic.findSubTopic(name);
 139     if (newTopic == nullptr)
 140     {
 141         if (impl_->isAtRootTopic())
 142         {
 143             GMX_THROW(InvalidInputError(
 144                               formatString("No help available for '%s'", name)));
 145         }
 146         else
 147         {
 148             GMX_THROW(InvalidInputError(
 149                               formatString("Help topic '%s' has no subtopic '%s'",
 150                                            impl_->currentTopicAsString().c_str(), name)));
 151         }
 152     }
 153     impl_->topicStack_.push_back(newTopic);
 154 }
 155
 156 void HelpManager::enterTopic(const std::string &name)
 157 {
 158     enterTopic(name.c_str());
 159 }
 160
 161 void HelpManager::writeCurrentTopic() const
 162 {
 163     const IHelpTopic         &topic = impl_->currentTopic();
 164     const char               *title = topic.title();
 165     HelpWriterContext         context(impl_->rootContext_);
 166     context.enterSubSection(title != nullptr ? title : "");
 167     topic.writeHelp(context);
 168 }
 169
 170 } // namespace gmx