src/gromacs/commandline/cmdlinemodule.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,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 /*! \file
  36  * \brief
  37  * Declares gmx::ICommandLineModule 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/classhelpers.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  * \see CommandLineOptionsModule
  89  *
  90  * \inpublicapi
  91  * \ingroup module_commandline
  92  */
  93 class ICommandLineModule
  94 {
  95 public:
  96     virtual ~ICommandLineModule() {}
  97
  98     //! Returns the name of the module.
  99     virtual const char* name() const = 0;
 100     //! Returns a one-line description of the module.
 101     virtual const char* shortDescription() const = 0;
 102
 103     /*! \brief
 104      * Initializes the module and provides settings for the runner.
 105      *
 106      * This will be called before run(), and can be used to adjust
 107      * initialization that the runner does.
 108      *
 109      * This method is currently not called when writing the help.
 110      */
 111     virtual void init(CommandLineModuleSettings* settings) = 0;
 112     /*! \brief
 113      * Runs the module with the given arguments.
 114      *
 115      * \param[in] argc  Number of elements in \p argv.
 116      * \param[in] argv  Command-line arguments.
 117      * \throws   unspecified  May throw exceptions to indicate errors.
 118      * \returns  Exit code for the program.
 119      * \retval   0 on successful termination.
 120      *
 121      * \p argv[0] is the name of the module, i.e., the arguments are as if
 122      * the module was run as a standalone executable.
 123      */
 124     virtual int run(int argc, char* argv[]) = 0;
 125     /*! \brief
 126      * Prints help for the module.
 127      *
 128      * \param[in] context  Context object for writing the help.
 129      * \throws    std::bad_alloc if out of memory.
 130      * \throws    FileIOError on any I/O error.
 131      *
 132      * Note that for MPI-enabled builds, this is called only on the master
 133      * rank.
 134      */
 135     virtual void writeHelp(const CommandLineHelpContext& context) const = 0;
 136 };
 137
 138 //! \cond libapi
 139 /*! \libinternal \brief
 140  * Helper to implement ICommandLineModule::writeHelp() with a C-like
 141  * main() function that calls parse_common_args().
 142  *
 143  * \param[in] context      Context object for writing the help.
 144  * \param[in] name         Name of the module.
 145  * \param[in] mainFunction C-like main() function that calls parse_common_args().
 146  *
 147  * \ingroup module_commandline
 148  */
 149 void writeCommandLineHelpCMain(const CommandLineHelpContext& context,
 150                                const char*                   name,
 151                                int (*mainFunction)(int argc, char* argv[]));
 152 //! \endcond
 153
 154 } // namespace gmx
 155
 156 #endif