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;
55 class IOptionsContainer;
59 * Settings to pass information between a CommandLineOptionsModule and generic
63 * \ingroup module_commandline
65 class ICommandLineOptionsModuleSettings
69 * Sets the help text for the module from string array.
71 * \param[in] help String array to set as the description.
72 * \throws std::bad_alloc if out of memory.
74 * Formatting for the help text is described on \ref page_onlinehelp.
78 const char *const desc[] = {
79 "This is the description",
83 settings->setHelpText(desc);
86 virtual void setHelpText(const ConstArrayRef<const char *> &help) = 0;
89 // Disallow deletion through the interface.
90 // (no need for the virtual, but some compilers warn otherwise)
91 virtual ~ICommandLineOptionsModuleSettings();
95 * Module that can be run from a command line and uses gmx::Options for
96 * argument processing.
98 * This class provides a higher-level interface on top of
99 * gmx::ICommandLineModule for cases where gmx::Options will be used
100 * for declaring the command-line arguments. The module only needs to declare
101 * the options it uses, and the framework takes care of command-line parsing
102 * and help output. The module typically consists of the following parts:
103 * - init() allows for some interaction between the module and the framework
104 * when running the module; see ICommandLineModule::init(). If no
105 * such customization is necessary, an empty implementation is sufficient.
106 * - initOptions() is called both for running the module and for printing help
107 * for the module, and it should add the options that the module
108 * understands. Values provided for the options are typically stored in
110 * - optionsFinished() can be implemented in case additional processing is
111 * needed (e.g., checking whether an option was set by the user).
112 * - run() is called when running the module, after command-line options have
113 * been parsed and their values stored in the corresponding member
116 * registerModule(), runAsMain(), or createModule() can be used to use modules
117 * of this type in all contexts where a gmx::ICommandLineModule is
118 * expected. These methods create a gmx::ICommandLineModule
119 * implementation that contains the common code needed to parse command-line
120 * options and write help, based on the information provided from the methods
124 * \ingroup module_commandline
126 class ICommandLineOptionsModule
130 * Function pointer to a factory method that returns an interface of
133 * \returns Module to run (should be allocated with `new`).
134 * \throws std::bad_alloc if out of memory.
136 * The caller takes responsibility to `delete` the returned pointer.
138 typedef ICommandLineOptionsModule *(*FactoryMethod)();
141 * Creates a ICommandLineModule to run the specified module.
143 * \param[in] name Name for the module.
144 * \param[in] description Short description for the module.
145 * \param[in] factory Factory that returns the module to run.
146 * \returns ICommandLineModule object that runs the module
147 * returned by \p factory. Caller must `delete` the object.
148 * \throws std::bad_alloc if out of memory.
150 * This is mainly used by tests that want to bypass
151 * CommandLineModuleManager.
153 static ICommandLineModule *
154 createModule(const char *name, const char *description,
155 FactoryMethod factory);
157 * Implements a main() method that runs a single module.
159 * \param argc \c argc passed to main().
160 * \param argv \c argv passed to main().
161 * \param[in] name Name for the module.
162 * \param[in] description Short description for the module.
163 * \param[in] factory Factory that returns the module to run.
165 * This method allows for uniform behavior for binaries that only
166 * contain a single module without duplicating any of the
167 * implementation from CommandLineModuleManager (startup headers,
168 * common options etc.).
170 * \see runCommandLineModule()
173 runAsMain(int argc, char *argv[], const char *name,
174 const char *description, FactoryMethod factory);
176 * Registers a module of a certain type to this manager.
178 * \param manager Manager to register to.
179 * \param[in] name Name for the module.
180 * \param[in] description Short description for the module.
181 * \param[in] factory Factory that returns the module to register.
182 * \throws std::bad_alloc if out of memory.
184 * This method internally creates a ICommandLineModule module
185 * with the given \p name and \p description, and adds that to
186 * \p manager. When run or asked to write the help, the module calls
187 * \p factory to get the actual module, and forwards the necessary
191 registerModule(CommandLineModuleManager *manager,
192 const char *name, const char *description,
193 FactoryMethod factory);
195 * Registers a module to this manager.
197 * \param manager Manager to register to.
198 * \param[in] name Name for the module.
199 * \param[in] description Short description for the module.
200 * \param[in] module Module to register.
201 * The method takes ownership (must have been allocated with `new`).
202 * \throws std::bad_alloc if out of memory.
204 * This method internally creates a ICommandLineModule module
205 * with the given \p name and \p description, and adds that to
208 * This method is mainly used by tests that need to have a reference to
209 * the ICommandLineOptionsModule instance (e.g., for mocking).
212 registerModule(CommandLineModuleManager *manager,
213 const char *name, const char *description,
214 ICommandLineOptionsModule *module);
216 virtual ~ICommandLineOptionsModule();
218 //! \copydoc gmx::ICommandLineModule::init()
219 virtual void init(CommandLineModuleSettings *settings) = 0;
221 * Initializes command-line arguments understood by the module.
223 * \param[in,out] options Options object to add the options to.
224 * \param[in,out] settings Settings to communicate information
225 * to/from generic code running the module.
227 * When running the module, this method is called after init().
228 * When printing help, there is no call to init(), and this is the only
230 * In both cases, the implementation should add options understood by
231 * the module to \p options. Output values from options should be
232 * stored in member variables.
234 virtual void initOptions(IOptionsContainer *options,
235 ICommandLineOptionsModuleSettings *settings) = 0;
237 * Called after all option values have been set.
239 * When running the module, this method is called after all
240 * command-line arguments have been parsed.
243 * Remove if no real need materializes.
245 virtual void optionsFinished() = 0;
250 * \throws unspecified May throw exceptions to indicate errors.
251 * \returns Exit code for the program.
252 * \retval 0 on successful termination.
254 * This method is called after optionsFinished() when running the
255 * module, and should do all the processing for the module.
257 virtual int run() = 0;