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, 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 "gromacs/commandline/cmdlinemodule.h"
  47 #include "gromacs/onlinehelp/ihelptopic.h"
  48 #include "gromacs/utility/classhelpers.h"
  49
  50 #include "cmdlinemodulemanager_impl.h"
  51
  52 namespace gmx
  53 {
  54
  55 class CommandLineHelpContext;
  56 class IFileOutputRedirector;
  57 class IProgramContext;
  58
  59 class CommandLineHelpModuleImpl;
  60
  61 /*! \internal
  62  * \brief
  63  * Command-line module for producing help.
  64  *
  65  * This module implements the 'help' subcommand that is automatically added by
  66  * CommandLineModuleManager.
  67  *
  68  * \ingroup module_commandline
  69  */
  70 class CommandLineHelpModule : public ICommandLineModule
  71 {
  72 public:
  73     /*! \brief
  74      * Creates a command-line help module.
  75      *
  76      * \param[in] programContext Information about the running binary.
  77      * \param[in] binaryName     Name of the running binary
  78      *     (without Gromacs binary suffix or .exe on Windows).
  79      * \param[in] modules  List of modules for to use for module listings.
  80      * \param[in] groups   List of module groups.
  81      * \throws    std::bad_alloc if out of memory.
  82      */
  83     CommandLineHelpModule(const IProgramContext&            programContext,
  84                           const std::string&                binaryName,
  85                           const CommandLineModuleMap&       modules,
  86                           const CommandLineModuleGroupList& groups);
  87     ~CommandLineHelpModule() override;
  88
  89     /*! \brief
  90      * Creates a help topic for a command-line module.
  91      *
  92      * \param[in] module  Module the create the help topic for.
  93      * \throws    std::bad_alloc if out of memory.
  94      *
  95      * The caller should add the topic using addTopic() if that is desired.
  96      * This method is provided separately to allow for strong exception
  97      * safety in CommandLineModuleManager::addModule().
  98      */
  99     HelpTopicPointer createModuleHelpTopic(const ICommandLineModule& module) const;
 100     /*! \brief
 101      * Adds a top-level help topic.
 102      *
 103      * \param[in] topic     Help topic to add.
 104      * \param[in] bExported Whether this topic will be directly exported to
 105      *     the user guide.
 106      * \throws    std::bad_alloc if out of memory.
 107      */
 108     void addTopic(HelpTopicPointer topic, bool bExported);
 109     //! Sets whether hidden options will be shown in help.
 110     void setShowHidden(bool bHidden);
 111     /*! \brief
 112      * Sets an override to show the help for the given module.
 113      *
 114      * If called, the help module directly prints the help for the given
 115      * module when called, skipping any other processing.
 116      */
 117     void setModuleOverride(const ICommandLineModule& module);
 118
 119     /*! \brief
 120      * Sets a file redirector for writing help output.
 121      *
 122      * Used for unit testing; see
 123      * CommandLineModuleManager::setOutputRedirector() for more details.
 124      */
 125     void setOutputRedirector(IFileOutputRedirector* output);
 126
 127     const char* name() const override { return "help"; }
 128     const char* shortDescription() const override { return "Print help information"; }
 129
 130     void init(CommandLineModuleSettings* settings) override { settings->setDefaultNiceLevel(0); }
 131     int  run(int argc, char* argv[]) override;
 132     void writeHelp(const CommandLineHelpContext& context) const override;
 133
 134 private:
 135     typedef CommandLineHelpModuleImpl Impl;
 136
 137     PrivateImplPointer<Impl> impl_;
 138 };
 139
 140 } // namespace gmx
 141
 142 #endif