src/gromacs/commandline/cmdlinehelpmodule.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2018 by the GROMACS development team.
   5  * Copyright (c) 2019,2020,2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Declares gmx::CommandLineHelpModule.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_commandline
  42  */
  43 #ifndef GMX_COMMANDLINE_CMDLINEHELPMODULE_H
  44 #define GMX_COMMANDLINE_CMDLINEHELPMODULE_H
  45
  46 #include <memory>
  47
  48 #include "gromacs/commandline/cmdlinemodule.h"
  49 #include "gromacs/onlinehelp/ihelptopic.h"
  50
  51 #include "cmdlinemodulemanager_impl.h"
  52
  53 namespace gmx
  54 {
  55
  56 class CommandLineHelpContext;
  57 class IFileOutputRedirector;
  58 class IProgramContext;
  59
  60 class CommandLineHelpModuleImpl;
  61
  62 /*! \internal
  63  * \brief
  64  * Command-line module for producing help.
  65  *
  66  * This module implements the 'help' subcommand that is automatically added by
  67  * CommandLineModuleManager.
  68  *
  69  * \ingroup module_commandline
  70  */
  71 class CommandLineHelpModule : public ICommandLineModule
  72 {
  73 public:
  74     /*! \brief
  75      * Creates a command-line help module.
  76      *
  77      * \param[in] programContext Information about the running binary.
  78      * \param[in] binaryName     Name of the running binary
  79      *     (without Gromacs binary suffix or .exe on Windows).
  80      * \param[in] modules  List of modules for to use for module listings.
  81      * \param[in] groups   List of module groups.
  82      * \throws    std::bad_alloc if out of memory.
  83      */
  84     CommandLineHelpModule(const IProgramContext&            programContext,
  85                           const std::string&                binaryName,
  86                           const CommandLineModuleMap&       modules,
  87                           const CommandLineModuleGroupList& groups);
  88     ~CommandLineHelpModule() override;
  89
  90     /*! \brief
  91      * Creates a help topic for a command-line module.
  92      *
  93      * \param[in] module  Module the create the help topic for.
  94      * \throws    std::bad_alloc if out of memory.
  95      *
  96      * The caller should add the topic using addTopic() if that is desired.
  97      * This method is provided separately to allow for strong exception
  98      * safety in CommandLineModuleManager::addModule().
  99      */
 100     HelpTopicPointer createModuleHelpTopic(const ICommandLineModule& module) const;
 101     /*! \brief
 102      * Adds a top-level help topic.
 103      *
 104      * \param[in] topic     Help topic to add.
 105      * \param[in] bExported Whether this topic will be directly exported to
 106      *     the user guide.
 107      * \throws    std::bad_alloc if out of memory.
 108      */
 109     void addTopic(HelpTopicPointer topic, bool bExported);
 110     //! Sets whether hidden options will be shown in help.
 111     void setShowHidden(bool bHidden);
 112     /*! \brief
 113      * Sets an override to show the help for the given module.
 114      *
 115      * If called, the help module directly prints the help for the given
 116      * module when called, skipping any other processing.
 117      */
 118     void setModuleOverride(const ICommandLineModule& module);
 119
 120     /*! \brief
 121      * Sets a file redirector for writing help output.
 122      *
 123      * Used for unit testing; see
 124      * CommandLineModuleManager::setOutputRedirector() for more details.
 125      */
 126     void setOutputRedirector(IFileOutputRedirector* output);
 127
 128     const char* name() const override { return "help"; }
 129     const char* shortDescription() const override { return "Print help information"; }
 130
 131     void init(CommandLineModuleSettings* settings) override { settings->setDefaultNiceLevel(0); }
 132     int  run(int argc, char* argv[]) override;
 133     void writeHelp(const CommandLineHelpContext& context) const override;
 134
 135 private:
 136     typedef CommandLineHelpModuleImpl Impl;
 137
 138     std::unique_ptr<Impl> impl_;
 139 };
 140
 141 } // namespace gmx
 142
 143 #endif