src/gromacs/commandline/cmdlinemodulemanager.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 /*! \file
  36  * \brief
  37  * Declares gmx::CommandLineModuleManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_commandline
  42  */
  43 #ifndef GMX_COMMANDLINE_CMDLINEMODULEMANAGER_H
  44 #define GMX_COMMANDLINE_CMDLINEMODULEMANAGER_H
  45
  46 #include "../onlinehelp/helptopicinterface.h"
  47 #include "../utility/common.h"
  48 #include "../utility/uniqueptr.h"
  49
  50 namespace gmx
  51 {
  52
  53 class CommandLineModuleInterface;
  54 class ProgramInfo;
  55
  56 //! Smart pointer type for managing a CommandLineModuleInterface.
  57 typedef gmx_unique_ptr<CommandLineModuleInterface>::type
  58     CommandLineModulePointer;
  59
  60 /*! \brief
  61  * Implements a wrapper command-line interface for multiple modules.
  62  *
  63  * Typical usage:
  64  * \code
  65    int
  66    main(int argc, char *argv[])
  67    {
  68        const gmx::ProgramInfo &programInfo =
  69            gmx::ProgramInfo::init("gmx", argc, argv);
  70        CopyRight(stderr, argv[0]);
  71        try
  72        {
  73            gmx::CommandLineModuleManager manager(programInfo);
  74            // <register all necessary modules>
  75            return manager.run(argc, argv);
  76        }
  77        catch (const std::exception &ex)
  78        {
  79            gmx::printFatalErrorMessage(stderr, ex);
  80            return 1;
  81        }
  82    }
  83  * \endcode
  84  *
  85  * \inpublicapi
  86  * \ingroup module_commandline
  87  */
  88 class CommandLineModuleManager
  89 {
  90     public:
  91         /*! \brief
  92          * Initializes a command-line module manager.
  93          *
  94          * \param[in] programInfo  Program information for the running binary.
  95          * \throws    std::bad_alloc if out of memory.
  96          *
  97          * The binary name is used to detect when the binary is run through a
  98          * symlink, and automatically invoke a matching module in such a case.
  99          */
 100         explicit CommandLineModuleManager(const ProgramInfo &programInfo);
 101         ~CommandLineModuleManager();
 102
 103         /*! \brief
 104          * Adds a given module to this manager.
 105          *
 106          * \param   module  Module to add.
 107          * \throws  std::bad_alloc if out of memory.
 108          *
 109          * The manager takes ownership of the object.
 110          *
 111          * This method is public mostly for testing purposes; for typical uses,
 112          * registerModule() is a more convenient way of adding modules.
 113          *
 114          * \see registerModule()
 115          */
 116         void addModule(CommandLineModulePointer module);
 117         /*! \brief
 118          * Registers a module of a certain type to this manager.
 119          *
 120          * \tparam  Module  Type of module to register.
 121          * \throws  std::bad_alloc if out of memory.
 122          *
 123          * \p Module must be default-constructible and implement
 124          * CommandLineModuleInterface.
 125          *
 126          * This method is provided as a convenient alternative to addModule()
 127          * for cases where each module is implemented by a different type
 128          * (which should be the case for typical situations outside unit
 129          * tests).
 130          */
 131         template <class Module>
 132         void registerModule()
 133         {
 134             addModule(CommandLineModulePointer(new Module));
 135         }
 136
 137         /*! \brief
 138          * Make given help topic available through the manager's help module.
 139          *
 140          * \param[in]  topic  Help topic to add.
 141          * \throws     std::bad_alloc if out of memory.
 142          *
 143          * The manager takes ownership of the help topic.
 144          */
 145         void addHelpTopic(HelpTopicPointer topic);
 146
 147         /*! \brief
 148          * Runs a module based on given command line.
 149          *
 150          * \param[in] argc  Number of elements in \p argv.
 151          * \param[in] argv  Command-line arguments.
 152          * \throws   unspecified  Throws any exception that the selected module
 153          *      throws.
 154          * \returns  Exit code for the program.
 155          * \retval   0 on successful termination.
 156          * \retval   2 if no module is specified, or if the module is not found.
 157          *
 158          * Runs the module whose name matches \p argv[1].
 159          */
 160         int run(int argc, char *argv[]);
 161
 162     private:
 163         class Impl;
 164
 165         PrivateImplPointer<Impl> impl_;
 166 };
 167
 168 } // namespace gmx
 169
 170 #endif