src/gromacs/onlinehelp/helpmanager.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2014,2015,2019,2021, 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::HelpManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_onlinehelp
  42  */
  43 #ifndef GMX_ONLINEHELP_HELPMANAGER_H
  44 #define GMX_ONLINEHELP_HELPMANAGER_H
  45
  46 #include <memory>
  47 #include <string>
  48
  49 namespace gmx
  50 {
  51
  52 class HelpWriterContext;
  53 class IHelpTopic;
  54
  55 /*! \libinternal \brief
  56  * Helper for providing interactive online help.
  57  *
  58  * \inlibraryapi
  59  * \ingroup module_onlinehelp
  60  */
  61 class HelpManager
  62 {
  63 public:
  64     /*! \brief
  65      * Creates a manager that uses a given root topic.
  66      *
  67      * \param[in] rootTopic  Help topic that can be accessed through this
  68      *      manager.
  69      * \param[in] context    Context object for writing the help.
  70      * \throws    std::bad_alloc if out of memory.
  71      *
  72      * The provided topic and context objects must remain valid for the
  73      * lifetime of this manager object.
  74      */
  75     HelpManager(const IHelpTopic& rootTopic, const HelpWriterContext& context);
  76     ~HelpManager();
  77
  78     /*! \brief
  79      * Enters a subtopic with the given name under the active topic.
  80      *
  81      * \param[in] name  Subtopic name to enter.
  82      * \throws    std::bad_allod if out of memory.
  83      * \throws    InvalidInputError if topic with \p name is not found.
  84      */
  85     void enterTopic(const char* name);
  86     //! \copydoc enterTopic(const char *)
  87     void enterTopic(const std::string& name);
  88
  89     /*! \brief
  90      * Writes out the help for the currently active topic.
  91      *
  92      * \throws  std::bad_alloc if out of memory.
  93      * \throws  FileIOError on any I/O error.
  94      */
  95     void writeCurrentTopic() const;
  96
  97 private:
  98     class Impl;
  99
 100     std::unique_ptr<Impl> impl_;
 101 };
 102
 103 } // namespace gmx
 104
 105 #endif