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 ProgramInfo;
  56
  57 class CommandLineHelpModuleImpl;
  58
  59 /*! \internal
  60  * \brief
  61  * Command-line module for producing help.
  62  *
  63  * This module implements the 'help' subcommand that is automatically added by
  64  * CommandLineModuleManager.
  65  *
  66  * \ingroup module_commandline
  67  */
  68 class CommandLineHelpModule : public CommandLineModuleInterface
  69 {
  70     public:
  71         /*! \brief
  72          * Creates a command-line help module.
  73          *
  74          * \param[in] programInfo Information about the running binary.
  75          * \param[in] modules  List of modules for to use for module listings.
  76          * \param[in] groups   List of module groups.
  77          * \throws    std::bad_alloc if out of memory.
  78          */
  79         CommandLineHelpModule(const ProgramInfo                &programInfo,
  80                               const CommandLineModuleMap       &modules,
  81                               const CommandLineModuleGroupList &groups);
  82         ~CommandLineHelpModule();
  83
  84         /*! \brief
  85          * Creates a help topic for a command-line module.
  86          *
  87          * \param[in] module  Module the create the help topic for.
  88          * \throws    std::bad_alloc if out of memory.
  89          *
  90          * The caller should add the topic using addTopic() if that is desired.
  91          * This method is provided separately to allow for strong exception
  92          * safety in CommandLineModuleManager::addModule().
  93          */
  94         HelpTopicPointer
  95         createModuleHelpTopic(const CommandLineModuleInterface &module) const;
  96         /*! \brief
  97          * Adds a top-level help topic.
  98          *
  99          * \param[in] topic  Help topic to add.
 100          * \throws    std::bad_alloc if out of memory.
 101          */
 102         void addTopic(HelpTopicPointer topic);
 103         //! Sets whether hidden options will be shown in help.
 104         void setShowHidden(bool bHidden);
 105         /*! \brief
 106          * Sets an override to show the help for the given module.
 107          *
 108          * If called, the help module directly prints the help for the given
 109          * module when called, skipping any other processing.
 110          */
 111         void setModuleOverride(const CommandLineModuleInterface &module);
 112
 113         virtual const char *name() const { return "help"; }
 114         virtual const char *shortDescription() const
 115         {
 116             return "Print help information";
 117         }
 118
 119         virtual int run(int argc, char *argv[]);
 120         virtual void writeHelp(const CommandLineHelpContext &context) const;
 121
 122     private:
 123         typedef CommandLineHelpModuleImpl Impl;
 124
 125         PrivateImplPointer<Impl> impl_;
 126 };
 127
 128 } // namespace gmx
 129
 130 #endif