src/gromacs/onlinehelp/helptopicinterface.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 /*! \file
  36  * \brief
  37  * Declares gmx::HelpTopicInterface.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_onlinehelp
  42  */
  43 #ifndef GMX_ONLINEHELP_HELPTOPICINTERFACE_H
  44 #define GMX_ONLINEHELP_HELPTOPICINTERFACE_H
  45
  46 #include "../utility/uniqueptr.h"
  47
  48 namespace gmx
  49 {
  50
  51 class HelpWriterContext;
  52
  53 /*! \brief
  54  * Provides a single online help topic.
  55  *
  56  * \if libapi
  57  * Implementations of these methods should not throw, except that writeHelp()
  58  * is allowed to throw on out-of-memory or I/O errors since those it cannot
  59  * avoid.
  60  *
  61  * Header helptopic.h contains classes that implement this interface and make
  62  * it simple to write concrete help topic classes.
  63  * \endif
  64  *
  65  * This class is in a public header, and exposed through HelpTopicPointer, but
  66  * it is not intended to be used outside the library.  To access a help topic
  67  * with public API methods, use HelpManager.
  68  *
  69  * \inlibraryapi
  70  * \ingroup module_onlinehelp
  71  */
  72 class HelpTopicInterface
  73 {
  74     public:
  75         virtual ~HelpTopicInterface() {}
  76
  77         /*! \brief
  78          * Returns the name of the topic.
  79          *
  80          * This should be a single lowercase word, used to identify the topic.
  81          * It is not used for the root of the help topic tree.
  82          */
  83         virtual const char *name() const = 0;
  84         /*! \brief
  85          * Returns a title for the topic.
  86          *
  87          * May return NULL, in which case the topic is omitted from normal
  88          * subtopic lists and no title is printed by the methods provided in
  89          * helptopic.h.
  90          */
  91         virtual const char *title() const = 0;
  92
  93         //! Returns whether the topic has any subtopics.
  94         virtual bool hasSubTopics() const = 0;
  95         /*! \brief
  96          * Finds a subtopic by name.
  97          *
  98          * \param[in] name  Name of subtopic to find.
  99          * \returns   Pointer to the found subtopic, or NULL if matching topic
 100          *      is not found.
 101          */
 102         virtual const HelpTopicInterface *findSubTopic(const char *name) const = 0;
 103
 104         /*! \brief
 105          * Prints the help text for this topic.
 106          *
 107          * \param[in] context  Context object for writing the help.
 108          * \throws    std::bad_alloc if out of memory.
 109          * \throws    FileIOError on any I/O error.
 110          */
 111         virtual void writeHelp(const HelpWriterContext &context) const = 0;
 112 };
 113
 114 //! Smart pointer type to manage a HelpTopicInterface object.
 115 typedef gmx_unique_ptr<HelpTopicInterface>::type HelpTopicPointer;
 116
 117 } // namespace gmx
 118
 119 #endif