src/gromacs/onlinehelp/helptopic.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
   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/file.h"
  53 #include "gromacs/utility/gmxassert.h"
  54 #include "gromacs/utility/stringutil.h"
  55
  56 namespace gmx
  57 {
  58
  59 /*! \cond libapi */
  60 void writeBasicHelpTopic(const HelpWriterContext  &context,
  61                          const HelpTopicInterface &topic,
  62                          const std::string        &text)
  63 {
  64     const char *title = topic.title();
  65     if (title != NULL && title[0] != '\0')
  66     {
  67         context.writeTitle(title);
  68     }
  69     context.writeTextBlock(text);
  70 }
  71 //! \endcond
  72
  73 /********************************************************************
  74  * AbstractSimpleHelpTopic
  75  */
  76
  77 bool AbstractSimpleHelpTopic::hasSubTopics() const
  78 {
  79     return false;
  80 }
  81
  82 const HelpTopicInterface *
  83 AbstractSimpleHelpTopic::findSubTopic(const char * /* name */) const
  84 {
  85     return NULL;
  86 }
  87
  88 void AbstractSimpleHelpTopic::writeHelp(const HelpWriterContext &context) const
  89 {
  90     writeBasicHelpTopic(context, *this, helpText());
  91 }
  92
  93 /********************************************************************
  94  * AbstractCompositeHelpTopic::Impl
  95  */
  96
  97 /*! \internal \brief
  98  * Private implementation class for AbstractCompositeHelpTopic.
  99  *
 100  * \ingroup module_onlinehelp
 101  */
 102 class AbstractCompositeHelpTopic::Impl
 103 {
 104     public:
 105         //! Container for mapping subtopic names to help topic objects.
 106         typedef std::map<std::string, HelpTopicPointer> SubTopicMap;
 107
 108         /*! \brief
 109          * Maps subtopic names to help topic objects.
 110          *
 111          * Owns the contained subtopics.
 112          */
 113         SubTopicMap             subtopics_;
 114 };
 115
 116 /********************************************************************
 117  * AbstractCompositeHelpTopic
 118  */
 119
 120 AbstractCompositeHelpTopic::AbstractCompositeHelpTopic()
 121     : impl_(new Impl)
 122 {
 123 }
 124
 125 AbstractCompositeHelpTopic::~AbstractCompositeHelpTopic()
 126 {
 127 }
 128
 129 bool AbstractCompositeHelpTopic::hasSubTopics() const
 130 {
 131     return !impl_->subtopics_.empty();
 132 }
 133
 134 const HelpTopicInterface *
 135 AbstractCompositeHelpTopic::findSubTopic(const char *name) const
 136 {
 137     Impl::SubTopicMap::const_iterator topic = impl_->subtopics_.find(name);
 138     if (topic == impl_->subtopics_.end())
 139     {
 140         return NULL;
 141     }
 142     return topic->second.get();
 143 }
 144
 145 void AbstractCompositeHelpTopic::writeHelp(const HelpWriterContext &context) const
 146 {
 147     writeBasicHelpTopic(context, *this, helpText());
 148     writeSubTopicList(context, "\nAvailable subtopics:");
 149 }
 150
 151 bool
 152 AbstractCompositeHelpTopic::writeSubTopicList(const HelpWriterContext &context,
 153                                               const std::string       &title) const
 154 {
 155     if (context.outputFormat() != eHelpOutputFormat_Console)
 156     {
 157         // TODO: Implement once the situation with Redmine issue #969 is more
 158         // clear.
 159         GMX_THROW(NotImplementedError(
 160                           "Subtopic listing is not implemented for this output format"));
 161     }
 162     int maxNameLength = 0;
 163     Impl::SubTopicMap::const_iterator topic;
 164     for (topic = impl_->subtopics_.begin(); topic != impl_->subtopics_.end(); ++topic)
 165     {
 166         const char *title = topic->second->title();
 167         if (title == NULL || title[0] == '\0')
 168         {
 169             continue;
 170         }
 171         int nameLength = static_cast<int>(topic->first.length());
 172         if (nameLength > maxNameLength)
 173         {
 174             maxNameLength = nameLength;
 175         }
 176     }
 177     if (maxNameLength == 0)
 178     {
 179         return false;
 180     }
 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)
 188     {
 189         const char *name  = topic->first.c_str();
 190         const char *title = topic->second->title();
 191         if (title != NULL && title[0] != '\0')
 192         {
 193             formatter.clear();
 194             formatter.addColumnLine(0, name);
 195             formatter.addColumnLine(1, title);
 196             file.writeString(formatter.formatRow());
 197         }
 198     }
 199     return true;
 200 }
 201
 202 void AbstractCompositeHelpTopic::addSubTopic(HelpTopicPointer topic)
 203 {
 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()),
 207                                             move(topic)));
 208 }
 209
 210 } // namespace gmx