src/gromacs/commandline/cmdlinehelpmodule.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,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 /*! \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 "cmdlinemodule.h"
  46 #include "cmdlinemodulemanager-impl.h"
  47
  48 #include "gromacs/onlinehelp/helptopicinterface.h"
  49 #include "gromacs/utility/common.h"
  50
  51 namespace gmx
  52 {
  53
  54 class CommandLineHelpContext;
  55 class File;
  56 class Options;
  57 class ProgramContextInterface;
  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 CommandLineModuleInterface
  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 ProgramContextInterface    &programContext,
  84                               const std::string                &binaryName,
  85                               const CommandLineModuleMap       &modules,
  86                               const CommandLineModuleGroupList &groups);
  87         ~CommandLineHelpModule();
  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
 100         createModuleHelpTopic(const CommandLineModuleInterface &module) const;
 101         /*! \brief
 102          * Adds a top-level help topic.
 103          *
 104          * \param[in] topic  Help topic to add.
 105          * \throws    std::bad_alloc if out of memory.
 106          */
 107         void addTopic(HelpTopicPointer topic);
 108         //! Sets whether hidden options will be shown in help.
 109         void setShowHidden(bool bHidden);
 110         //! Sets the common options for the wrapper binary.
 111         void setCommonOptions(const Options *options);
 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 CommandLineModuleInterface &module);
 119
 120         /*! \brief
 121          * Sets a file to write help output to instead of default `stdout`.
 122          *
 123          * Used for unit testing; see
 124          * CommandLineModuleManager::setOutputRedirect() for more details.
 125          */
 126         void setOutputRedirect(File *output);
 127
 128         virtual const char *name() const { return "help"; }
 129         virtual const char *shortDescription() const
 130         {
 131             return "Print help information";
 132         }
 133
 134         virtual int run(int argc, char *argv[]);
 135         virtual void writeHelp(const CommandLineHelpContext &context) const;
 136
 137     private:
 138         typedef CommandLineHelpModuleImpl Impl;
 139
 140         PrivateImplPointer<Impl> impl_;
 141 };
 142
 143 } // namespace gmx
 144
 145 #endif