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, 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 /********************************************************************
  60  * AbstractSimpleHelpTopic
  61  */
  62
  63 bool AbstractSimpleHelpTopic::hasSubTopics() const
  64 {
  65     return false;
  66 }
  67
  68 const HelpTopicInterface *
  69 AbstractSimpleHelpTopic::findSubTopic(const char * /* name */) const
  70 {
  71     return NULL;
  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 mapping subtopic names to help topic objects.
  92         typedef std::map<std::string, HelpTopicPointer> SubTopicMap;
  93
  94         /*! \brief
  95          * Maps subtopic names to help topic objects.
  96          *
  97          * Owns the contained subtopics.
  98          */
  99         SubTopicMap             subtopics_;
 100 };
 101
 102 /********************************************************************
 103  * AbstractCompositeHelpTopic
 104  */
 105
 106 AbstractCompositeHelpTopic::AbstractCompositeHelpTopic()
 107     : impl_(new Impl)
 108 {
 109 }
 110
 111 AbstractCompositeHelpTopic::~AbstractCompositeHelpTopic()
 112 {
 113 }
 114
 115 bool AbstractCompositeHelpTopic::hasSubTopics() const
 116 {
 117     return !impl_->subtopics_.empty();
 118 }
 119
 120 const HelpTopicInterface *
 121 AbstractCompositeHelpTopic::findSubTopic(const char *name) const
 122 {
 123     Impl::SubTopicMap::const_iterator topic = impl_->subtopics_.find(name);
 124     if (topic == impl_->subtopics_.end())
 125     {
 126         return NULL;
 127     }
 128     return topic->second.get();
 129 }
 130
 131 void AbstractCompositeHelpTopic::writeHelp(const HelpWriterContext &context) const
 132 {
 133     context.writeTextBlock(helpText());
 134     writeSubTopicList(context, "\nAvailable subtopics:");
 135 }
 136
 137 bool
 138 AbstractCompositeHelpTopic::writeSubTopicList(const HelpWriterContext &context,
 139                                               const std::string       &title) const
 140 {
 141     if (context.outputFormat() != eHelpOutputFormat_Console)
 142     {
 143         // TODO: Implement once the situation with Redmine issue #969 is more
 144         // clear.
 145         GMX_THROW(NotImplementedError(
 146                           "Subtopic listing is not implemented for this output format"));
 147     }
 148     int maxNameLength = 0;
 149     Impl::SubTopicMap::const_iterator topic;
 150     for (topic = impl_->subtopics_.begin(); topic != impl_->subtopics_.end(); ++topic)
 151     {
 152         const char *title = topic->second->title();
 153         if (title == NULL || title[0] == '\0')
 154         {
 155             continue;
 156         }
 157         int nameLength = static_cast<int>(topic->first.length());
 158         if (nameLength > maxNameLength)
 159         {
 160             maxNameLength = nameLength;
 161         }
 162     }
 163     if (maxNameLength == 0)
 164     {
 165         return false;
 166     }
 167     File              &file = context.outputFile();
 168     TextTableFormatter formatter;
 169     formatter.addColumn(NULL, maxNameLength + 1, false);
 170     formatter.addColumn(NULL, 72 - maxNameLength, true);
 171     formatter.setFirstColumnIndent(4);
 172     file.writeLine(title);
 173     for (topic = impl_->subtopics_.begin(); topic != impl_->subtopics_.end(); ++topic)
 174     {
 175         const char *name  = topic->first.c_str();
 176         const char *title = topic->second->title();
 177         if (title != NULL && title[0] != '\0')
 178         {
 179             formatter.clear();
 180             formatter.addColumnLine(0, name);
 181             formatter.addColumnLine(1, title);
 182             file.writeString(formatter.formatRow());
 183         }
 184     }
 185     return true;
 186 }
 187
 188 void AbstractCompositeHelpTopic::addSubTopic(HelpTopicPointer topic)
 189 {
 190     GMX_ASSERT(impl_->subtopics_.find(topic->name()) == impl_->subtopics_.end(),
 191                "Attempted to register a duplicate help topic name");
 192     impl_->subtopics_.insert(std::make_pair(std::string(topic->name()),
 193                                             move(topic)));
 194 }
 195
 196 } // namespace gmx