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