src/gromacs/commandline/cmdlinemodule.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 /*! \file
  36  * \brief
  37  * Declares gmx::CommandLineModuleInterface and supporting classes.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_commandline
  42  */
  43 #ifndef GMX_COMMANDLINE_CMDLINEMODULE_H
  44 #define GMX_COMMANDLINE_CMDLINEMODULE_H
  45
  46 #include "gromacs/utility/common.h"
  47
  48 namespace gmx
  49 {
  50
  51 class CommandLineHelpContext;
  52
  53 /*! \brief
  54  * Settings to pass information between a module and the general runner.
  55  *
  56  * Methods in this class do not throw, except that construction may throw
  57  * std::bad_alloc.
  58  *
  59  * \inpublicapi
  60  * \ingroup module_commandline
  61  */
  62 class CommandLineModuleSettings
  63 {
  64     public:
  65         CommandLineModuleSettings();
  66         ~CommandLineModuleSettings();
  67
  68         //! Returns the default nice level for this module.
  69         int defaultNiceLevel() const;
  70
  71         /*! \brief
  72          * Sets the default nice level for this module.
  73          *
  74          * If not called, the module will be niced.
  75          */
  76         void setDefaultNiceLevel(int niceLevel);
  77
  78     private:
  79         class Impl;
  80
  81         PrivateImplPointer<Impl> impl_;
  82 };
  83
  84 /*! \brief
  85  * Module that can be run from command line using CommandLineModuleManager.
  86  *
  87  * \see CommandLineModuleManager
  88  *
  89  * \inpublicapi
  90  * \ingroup module_commandline
  91  */
  92 class CommandLineModuleInterface
  93 {
  94     public:
  95         virtual ~CommandLineModuleInterface() {}
  96
  97         //! Returns the name of the module.
  98         virtual const char *name() const = 0;
  99         //! Returns a one-line description of the module.
 100         virtual const char *shortDescription() const = 0;
 101
 102         /*! \brief
 103          * Initializes the module and provides settings for the runner.
 104          *
 105          * This will be called before run(), and can be used to adjust
 106          * initialization that the runner does.
 107          */
 108         virtual void init(CommandLineModuleSettings *settings) = 0;
 109         /*! \brief
 110          * Runs the module with the given arguments.
 111          *
 112          * \param[in] argc  Number of elements in \p argv.
 113          * \param[in] argv  Command-line arguments.
 114          * \throws   unspecified  May throw exceptions to indicate errors.
 115          * \returns  Exit code for the program.
 116          * \retval   0 on successful termination.
 117          *
 118          * \p argv[0] is the name of the module, i.e., the arguments are as if
 119          * the module was run as a standalone executable.
 120          */
 121         virtual int run(int argc, char *argv[]) = 0;
 122         /*! \brief
 123          * Prints help for the module.
 124          *
 125          * \param[in] context  Context object for writing the help.
 126          * \throws    std::bad_alloc if out of memory.
 127          * \throws    FileIOError on any I/O error.
 128          *
 129          * Note that for MPI-enabled builds, this is called only on the master
 130          * rank.
 131          */
 132         virtual void writeHelp(const CommandLineHelpContext &context) const = 0;
 133 };
 134
 135 //! \cond libapi
 136 /*! \libinternal \brief
 137  * Helper to implement CommandLineModuleInterface::writeHelp() with a C-like
 138  * main() function that calls parse_common_args().
 139  *
 140  * \param[in] context      Context object for writing the help.
 141  * \param[in] name         Name of the module.
 142  * \param[in] mainFunction C-like main() function that calls parse_common_args().
 143  *
 144  * \ingroup module_commandline
 145  */
 146 void writeCommandLineHelpCMain(
 147         const CommandLineHelpContext &context, const char *name,
 148         int (*mainFunction)(int argc, char *argv[]));
 149 //! \endcond
 150
 151 } // namespace gmx
 152
 153 #endif