src/gromacs/onlinehelp/helptopicinterface.h

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