2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2014,2015, 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.
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.
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.
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.
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.
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.
37 * Declares gmx::ICommandLineOptionsModule and supporting routines.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_commandline
43 #ifndef GMX_COMMANDLINE_CMDLINEOPTIONSMODULE_H
44 #define GMX_COMMANDLINE_CMDLINEOPTIONSMODULE_H
46 #include "gromacs/commandline/cmdlinemodule.h"
51 template <typename T> class ConstArrayRef;
53 class CommandLineModuleManager;
54 class ICommandLineModule;
58 * Settings to pass information between a CommandLineOptionsModule and generic
62 * \ingroup module_commandline
64 class ICommandLineOptionsModuleSettings
68 * Sets the help text for the module from string array.
70 * \param[in] help String array to set as the description.
71 * \throws std::bad_alloc if out of memory.
73 * Formatting for the help text is described on \ref page_onlinehelp.
77 const char *const desc[] = {
78 "This is the description",
82 settings->setHelpText(desc);
85 virtual void setHelpText(const ConstArrayRef<const char *> &help) = 0;
88 // Disallow deletion through the interface.
89 // (no need for the virtual, but some compilers warn otherwise)
90 virtual ~ICommandLineOptionsModuleSettings();
94 * Module that can be run from a command line and uses gmx::Options for
95 * argument processing.
97 * This class provides a higher-level interface on top of
98 * gmx::ICommandLineModule for cases where gmx::Options will be used
99 * for declaring the command-line arguments. The module only needs to declare
100 * the options it uses, and the framework takes care of command-line parsing
101 * and help output. The module typically consists of the following parts:
102 * - init() allows for some interaction between the module and the framework
103 * when running the module; see ICommandLineModule::init(). If no
104 * such customization is necessary, an empty implementation is sufficient.
105 * - initOptions() is called both for running the module and for printing help
106 * for the module, and it should add the options that the module
107 * understands. Values provided for the options are typically stored in
109 * - optionsFinished() can be implemented in case additional processing is
110 * needed (e.g., checking whether an option was set by the user).
111 * - run() is called when running the module, after command-line options have
112 * been parsed and their values stored in the corresponding member
115 * registerModule(), runAsMain(), or createModule() can be used to use modules
116 * of this type in all contexts where a gmx::ICommandLineModule is
117 * expected. These methods create a gmx::ICommandLineModule
118 * implementation that contains the common code needed to parse command-line
119 * options and write help, based on the information provided from the methods
123 * \ingroup module_commandline
125 class ICommandLineOptionsModule
129 * Function pointer to a factory method that returns an interface of
132 * \returns Module to run (should be allocated with `new`).
133 * \throws std::bad_alloc if out of memory.
135 * The caller takes responsibility to `delete` the returned pointer.
137 typedef ICommandLineOptionsModule *(*FactoryMethod)();
140 * Creates a ICommandLineModule to run the specified module.
142 * \param[in] name Name for the module.
143 * \param[in] description Short description for the module.
144 * \param[in] factory Factory that returns the module to run.
145 * \returns ICommandLineModule object that runs the module
146 * returned by \p factory. Caller must `delete` the object.
147 * \throws std::bad_alloc if out of memory.
149 * This is mainly used by tests that want to bypass
150 * CommandLineModuleManager.
152 static ICommandLineModule *
153 createModule(const char *name, const char *description,
154 FactoryMethod factory);
156 * Implements a main() method that runs a single module.
158 * \param argc \c argc passed to main().
159 * \param argv \c argv passed to main().
160 * \param[in] name Name for the module.
161 * \param[in] description Short description for the module.
162 * \param[in] factory Factory that returns the module to run.
164 * This method allows for uniform behavior for binaries that only
165 * contain a single module without duplicating any of the
166 * implementation from CommandLineModuleManager (startup headers,
167 * common options etc.).
169 * \see runCommandLineModule()
172 runAsMain(int argc, char *argv[], const char *name,
173 const char *description, FactoryMethod factory);
175 * Registers a module of a certain type to this manager.
177 * \param manager Manager to register to.
178 * \param[in] name Name for the module.
179 * \param[in] description Short description for the module.
180 * \param[in] factory Factory that returns the module to register.
181 * \throws std::bad_alloc if out of memory.
183 * This method internally creates a ICommandLineModule module
184 * with the given \p name and \p description, and adds that to
185 * \p manager. When run or asked to write the help, the module calls
186 * \p factory to get the actual module, and forwards the necessary
190 registerModule(CommandLineModuleManager *manager,
191 const char *name, const char *description,
192 FactoryMethod factory);
194 * Registers a module to this manager.
196 * \param manager Manager to register to.
197 * \param[in] name Name for the module.
198 * \param[in] description Short description for the module.
199 * \param[in] module Module to register.
200 * The method takes ownership (must have been allocated with `new`).
201 * \throws std::bad_alloc if out of memory.
203 * This method internally creates a ICommandLineModule module
204 * with the given \p name and \p description, and adds that to
207 * This method is mainly used by tests that need to have a reference to
208 * the ICommandLineOptionsModule instance (e.g., for mocking).
211 registerModule(CommandLineModuleManager *manager,
212 const char *name, const char *description,
213 ICommandLineOptionsModule *module);
215 virtual ~ICommandLineOptionsModule();
217 //! \copydoc gmx::ICommandLineModule::init()
218 virtual void init(CommandLineModuleSettings *settings) = 0;
220 * Initializes command-line arguments understood by the module.
222 * \param[in,out] options Options object to add the options to.
223 * \param[in,out] settings Settings to communicate information
224 * to/from generic code running the module.
226 * When running the module, this method is called after init().
227 * When printing help, there is no call to init(), and this is the only
229 * In both cases, the implementation should add options understood by
230 * the module to \p options. Output values from options should be
231 * stored in member variables.
233 virtual void initOptions(Options *options,
234 ICommandLineOptionsModuleSettings *settings) = 0;
236 * Called after all option values have been set.
238 * \param[in,out] options Options object in which options are stored.
240 * When running the module, this method is called after all
241 * command-line arguments have been parsed, but while the Options
242 * object still exists.
244 * If the module needs to call, e.g., Options::isSet(), this is the
247 virtual void optionsFinished(Options *options) = 0;
252 * \throws unspecified May throw exceptions to indicate errors.
253 * \returns Exit code for the program.
254 * \retval 0 on successful termination.
256 * This method is called after optionsFinished() when running the
257 * module, and should do all the processing for the module.
259 virtual int run() = 0;