src/gromacs/onlinehelp/ihelptopic.h

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