src/gromacs/onlinehelp/helptopic.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,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 /*! \libinternal \file
  36  * \brief
  37  * Declares helper classes for implementing gmx::HelpTopicInterface.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_onlinehelp
  42  */
  43 #ifndef GMX_ONLINEHELP_HELPTOPIC_H
  44 #define GMX_ONLINEHELP_HELPTOPIC_H
  45
  46 #include "gromacs/onlinehelp/helptopicinterface.h"
  47 #include "gromacs/utility/classhelpers.h"
  48 #include "gromacs/utility/stringutil.h"
  49 #include "gromacs/utility/uniqueptr.h"
  50
  51 namespace gmx
  52 {
  53
  54 /*! \libinternal \brief
  55  * Abstract base class for help topics that have simple text and no subtopics.
  56  *
  57  * This class implements subtopic-related methods from HelpTopicInterface such
  58  * that there are no subtopics.  writeHelp() is also implemented such that it
  59  * uses HelpTopicContext::writeTextBlock() to write out the text returned by a
  60  * new virtual method helpText().
  61  *
  62  * \see SimpleHelpTopic
  63  *
  64  * \inlibraryapi
  65  * \ingroup module_onlinehelp
  66  */
  67 class AbstractSimpleHelpTopic : public HelpTopicInterface
  68 {
  69     public:
  70         virtual const char *name() const  = 0;
  71         virtual const char *title() const = 0;
  72
  73         virtual bool hasSubTopics() const;
  74         virtual const HelpTopicInterface *findSubTopic(const char *name) const;
  75
  76         virtual void writeHelp(const HelpWriterContext &context) const;
  77
  78     protected:
  79         /*! \brief
  80          * Returns the help text for this topic.
  81          *
  82          * writeHelp() calls this method to obtain the actual text to format
  83          * for the topic.  Markup substitution etc. is done automatically by
  84          * writeHelp().
  85          */
  86         virtual std::string helpText() const = 0;
  87 };
  88
  89 /*! \libinternal \brief
  90  * Abstract base class for help topics that have simple text and subtopics.
  91  *
  92  * This class implements an internal container for subtopics and provides
  93  * public methods for adding subtopics (as HelpTopicInterface objects).
  94  * Subtopic-related methods from HelpTopicInterface are implemented to access
  95  * the internal container.  writeHelp() is also implemented such that it
  96  * uses HelpTopicContext::writeTextBlock() to write out the text returned by a
  97  * new virtual method helpText(), and a list of subtopics is written after the
  98  * actual text.
  99  *
 100  * \see CompositeHelpTopic
 101  *
 102  * \inlibraryapi
 103  * \ingroup module_onlinehelp
 104  */
 105 class AbstractCompositeHelpTopic : public HelpTopicInterface
 106 {
 107     public:
 108         AbstractCompositeHelpTopic();
 109         virtual ~AbstractCompositeHelpTopic();
 110
 111         virtual const char *name() const  = 0;
 112         virtual const char *title() const = 0;
 113
 114         virtual bool hasSubTopics() const;
 115         virtual const HelpTopicInterface *findSubTopic(const char *name) const;
 116
 117         virtual void writeHelp(const HelpWriterContext &context) const;
 118
 119         /*! \brief
 120          * Adds a given topic as a subtopic of this topic.
 121          *
 122          * \param   topic  Topis to add.
 123          * \throws  std::bad_alloc if out of memory.
 124          *
 125          * This topic takes ownership of the object.
 126          *
 127          * \see registerSubTopic()
 128          */
 129         void addSubTopic(HelpTopicPointer topic);
 130         /*! \brief
 131          * Registers a subtopic of a certain type to this topic.
 132          *
 133          * \tparam  Topic  Type of topic to register.
 134          * \throws  std::bad_alloc if out of memory.
 135          *
 136          * \p Topic must be default-constructible and implement
 137          * HelpTopicInterface.
 138          *
 139          * This method is provided as a convenient alternative to addSubTopic()
 140          * for cases where each topic is implemented by a different type
 141          * (which is a common case outside unit tests).
 142          */
 143         template <class Topic>
 144         void registerSubTopic()
 145         {
 146             addSubTopic(HelpTopicPointer(new Topic));
 147         }
 148
 149     protected:
 150         //! \copydoc gmx::AbstractSimpleHelpTopic::helpText()
 151         virtual std::string helpText() const = 0;
 152
 153         /*! \brief
 154          * Writes the list of subtopics.
 155          *
 156          * \param[in] context Context for writing the help.
 157          * \param[in] title  Title for the written list.
 158          * \returns   true if anything was printed.
 159          * \throws    std::bad_alloc if out of memory.
 160          * \throws    FileIOError on any I/O error.
 161          *
 162          * Subtopics with empty titles are skipped from the list.
 163          * If there would be no subtopics in the list, \p title is not printed
 164          * either.
 165          *
 166          * This method is provided for cases where helpText() does not provide
 167          * the needed flexibility and the derived class needs to override
 168          * writeHelp().  This method can then be called to print the same
 169          * subtopic list that is printed by the default writeHelp()
 170          * implementation.
 171          */
 172         bool writeSubTopicList(const HelpWriterContext &context,
 173                                const std::string       &title) const;
 174
 175     private:
 176         class Impl;
 177
 178         PrivateImplPointer<Impl> impl_;
 179 };
 180
 181 /*! \cond libapi */
 182 /*! \libinternal \brief
 183  * Smart pointer type to manage a AbstractCompositeHelpTopic object.
 184  *
 185  * \inlibraryapi
 186  */
 187 typedef gmx_unique_ptr<AbstractCompositeHelpTopic>::type
 188     CompositeHelpTopicPointer;
 189 //! \endcond
 190
 191 /*! \libinternal \brief
 192  * Template for simple implementation of AbstractSimpleHelpTopic.
 193  *
 194  * \tparam HelpText Struct that defines the data for the topic.
 195  *
 196  * \p HelpText should have public static members \c "const char name[]",
 197  * \c "const char title[]" and \c "const char *const text[]".
 198  *
 199  * Typical use:
 200  * \code
 201    struct ExampleHelpText
 202    {
 203        static const char name[];
 204        static const char title[];
 205        static const char *const text[];
 206    };
 207
 208    const char ExampleHelpText::name[] = "example";
 209    const char ExampleHelpText::title[] =
 210        "Example title";
 211    const char *const ExampleHelpText::text[] = {
 212        "Text for the topic.",
 213        "More text for the topic."
 214    };
 215
 216    typedef SimpleHelpTopic<ExampleHelpText> ExampleHelpTopic;
 217  * \endcode
 218  *
 219  * \inlibraryapi
 220  * \ingroup module_onlinehelp
 221  */
 222 template <class HelpText>
 223 class SimpleHelpTopic : public AbstractSimpleHelpTopic
 224 {
 225     public:
 226         virtual const char *name() const
 227         {
 228             return HelpText::name;
 229         }
 230         virtual const char *title() const
 231         {
 232             return HelpText::title;
 233         }
 234
 235     protected:
 236         virtual std::string helpText() const
 237         {
 238             return joinStrings(HelpText::text, "\n");
 239         }
 240 };
 241
 242 /*! \libinternal \brief
 243  * Template for simple implementation of AbstractCompositeHelpTopic.
 244  *
 245  * \tparam HelpText Struct that defines the data for the topic.
 246  *
 247  * Used similarly to SimpleHelpTopic.
 248  * \p HelpText should satisfy the same criteria as for SimpleHelpTopic.
 249  *
 250  * \see SimpleHelpTopic
 251  *
 252  * \inlibraryapi
 253  * \ingroup module_onlinehelp
 254  */
 255 template <class HelpText>
 256 class CompositeHelpTopic : public AbstractCompositeHelpTopic
 257 {
 258     public:
 259         virtual const char *name() const
 260         {
 261             return HelpText::name;
 262         }
 263         virtual const char *title() const
 264         {
 265             return HelpText::title;
 266         }
 267
 268     protected:
 269         virtual std::string helpText() const
 270         {
 271             return joinStrings(HelpText::text, "\n");
 272         }
 273 };
 274
 275 } // namespace gmx
 276
 277 #endif