namespace gmx
{
-template <typename T> class ArrayRef;
+template<typename T>
+class ArrayRef;
class CommandLineModuleManager;
class ICommandLineModule;
class IOptionsContainer;
//! Smart pointer to manage an ICommandLineOptionsModule.
-typedef std::unique_ptr<ICommandLineOptionsModule>
- ICommandLineOptionsModulePointer;
+typedef std::unique_ptr<ICommandLineOptionsModule> ICommandLineOptionsModulePointer;
/*! \brief
* Settings to pass information between a CommandLineOptionsModule and generic
*/
class ICommandLineOptionsModuleSettings
{
- public:
- /*! \brief
- * Sets the help text for the module from string array.
- *
- * \param[in] help String array to set as the description.
- * \throws std::bad_alloc if out of memory.
- *
- * Formatting for the help text is described on \ref page_onlinehelp.
- *
- * Example usage:
- * \code
- const char *const desc[] = {
- "This is the description",
- "for the options"
- };
+public:
+ /*! \brief
+ * Sets the help text for the module from string array.
+ *
+ * \param[in] help String array to set as the description.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * Formatting for the help text is described on \ref page_onlinehelp.
+ *
+ * Example usage:
+ * \code
+ const char *const desc[] = {
+ "This is the description",
+ "for the options"
+ };
- settings->setHelpText(desc);
- \endcode
- */
- virtual void setHelpText(const ArrayRef<const char *const> &help) = 0;
- /*! \brief
- * Set text indicating buggy behaviour of a module from string array.
- *
- * \param[in] bug String array to set as the bug text.
- * \throws std::bad_alloc if out of memory.
- *
- * Formatting for the text is described on \ref page_onlinehelp.
- */
- virtual void setBugText(const ArrayRef<const char *const> &bug) = 0;
- /*! \brief
- * Adds an option behavior that performs actions before
- * ICommandLineOptionsModule::run() is called.
- *
- * For now, this takes a shared_ptr to make it easier for the caller to
- * keep a reference to the behavior, but the behavior should be treated
- * as owned by the options module after this call.
- */
- virtual void addOptionsBehavior(
- const std::shared_ptr<IOptionsBehavior> &behavior) = 0;
+ settings->setHelpText(desc);
+ \endcode
+ */
+ virtual void setHelpText(const ArrayRef<const char* const>& help) = 0;
+ /*! \brief
+ * Set text indicating buggy behaviour of a module from string array.
+ *
+ * \param[in] bug String array to set as the bug text.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * Formatting for the text is described on \ref page_onlinehelp.
+ */
+ virtual void setBugText(const ArrayRef<const char* const>& bug) = 0;
+ /*! \brief
+ * Adds an option behavior that performs actions before
+ * ICommandLineOptionsModule::run() is called.
+ *
+ * For now, this takes a shared_ptr to make it easier for the caller to
+ * keep a reference to the behavior, but the behavior should be treated
+ * as owned by the options module after this call.
+ */
+ virtual void addOptionsBehavior(const std::shared_ptr<IOptionsBehavior>& behavior) = 0;
- protected:
- // Disallow deletion through the interface.
- // (no need for the virtual, but some compilers warn otherwise)
- virtual ~ICommandLineOptionsModuleSettings();
+protected:
+ // Disallow deletion through the interface.
+ // (no need for the virtual, but some compilers warn otherwise)
+ virtual ~ICommandLineOptionsModuleSettings();
};
/*! \brief
*/
class ICommandLineOptionsModule
{
- public:
- /*! \brief
- * Function pointer to a factory method that returns an interface of
- * this type.
- *
- * \returns Module to run.
- * \throws std::bad_alloc if out of memory.
- */
- typedef std::function<ICommandLineOptionsModulePointer()> FactoryMethod;
+public:
+ /*! \brief
+ * Function pointer to a factory method that returns an interface of
+ * this type.
+ *
+ * \returns Module to run.
+ * \throws std::bad_alloc if out of memory.
+ */
+ typedef std::function<ICommandLineOptionsModulePointer()> FactoryMethod;
- /*! \brief
- * Creates a ICommandLineModule to run the specified module.
- *
- * \param[in] name Name for the module.
- * \param[in] description Short description for the module.
- * \param[in] module Module to run.
- * \returns ICommandLineModule object that runs \p module module.
- * \throws std::bad_alloc if out of memory.
- */
- static std::unique_ptr<ICommandLineModule>
- createModule(const char *name, const char *description,
- ICommandLineOptionsModulePointer module);
- /*! \brief
- * Implements a main() method that runs a single module.
- *
- * \param argc \c argc passed to main().
- * \param argv \c argv passed to main().
- * \param[in] name Name for the module.
- * \param[in] description Short description for the module.
- * \param[in] factory Factory that returns the module to run.
- *
- * This method allows for uniform behavior for binaries that only
- * contain a single module without duplicating any of the
- * implementation from CommandLineModuleManager (startup headers,
- * common options etc.).
- *
- * \see runCommandLineModule()
- */
- static int
- runAsMain(int argc, char *argv[], const char *name,
- const char *description, FactoryMethod factory);
- /*! \brief
- * Registers a module of a certain type to this manager.
- *
- * \param manager Manager to register to.
- * \param[in] name Name for the module.
- * \param[in] description Short description for the module.
- * \param[in] factory Factory that returns the module to register.
- * \throws std::bad_alloc if out of memory.
- *
- * This method internally creates a ICommandLineModule module
- * with the given \p name and \p description, and adds that to
- * \p manager. When run or asked to write the help, the module calls
- * \p factory to get the actual module, and forwards the necessary
- * calls.
- */
- static void
- registerModuleFactory(CommandLineModuleManager *manager,
- const char *name, const char *description,
- FactoryMethod factory);
- /*! \brief
- * Registers a module to this manager.
- *
- * \param manager Manager to register to.
- * \param[in] name Name for the module.
- * \param[in] description Short description for the module.
- * \param[in] module Module to register.
- * \throws std::bad_alloc if out of memory.
- *
- * This method internally creates a ICommandLineModule module
- * with the given \p name and \p description, and adds that to
- * \p manager.
- *
- * This method is mainly used by tests that need to have a reference to
- * the ICommandLineOptionsModule instance (e.g., for mocking).
- */
- static void
- registerModuleDirect(CommandLineModuleManager *manager,
- const char *name, const char *description,
- ICommandLineOptionsModulePointer module);
+ /*! \brief
+ * Creates a ICommandLineModule to run the specified module.
+ *
+ * \param[in] name Name for the module.
+ * \param[in] description Short description for the module.
+ * \param[in] module Module to run.
+ * \returns ICommandLineModule object that runs \p module module.
+ * \throws std::bad_alloc if out of memory.
+ */
+ static std::unique_ptr<ICommandLineModule> createModule(const char* name,
+ const char* description,
+ ICommandLineOptionsModulePointer module);
+ /*! \brief
+ * Implements a main() method that runs a single module.
+ *
+ * \param argc \c argc passed to main().
+ * \param argv \c argv passed to main().
+ * \param[in] name Name for the module.
+ * \param[in] description Short description for the module.
+ * \param[in] factory Factory that returns the module to run.
+ *
+ * This method allows for uniform behavior for binaries that only
+ * contain a single module without duplicating any of the
+ * implementation from CommandLineModuleManager (startup headers,
+ * common options etc.).
+ *
+ * \see runCommandLineModule()
+ */
+ static int runAsMain(int argc, char* argv[], const char* name, const char* description, FactoryMethod factory);
+ /*! \brief
+ * Registers a module of a certain type to this manager.
+ *
+ * \param manager Manager to register to.
+ * \param[in] name Name for the module.
+ * \param[in] description Short description for the module.
+ * \param[in] factory Factory that returns the module to register.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * This method internally creates a ICommandLineModule module
+ * with the given \p name and \p description, and adds that to
+ * \p manager. When run or asked to write the help, the module calls
+ * \p factory to get the actual module, and forwards the necessary
+ * calls.
+ */
+ static void registerModuleFactory(CommandLineModuleManager* manager,
+ const char* name,
+ const char* description,
+ FactoryMethod factory);
+ /*! \brief
+ * Registers a module to this manager.
+ *
+ * \param manager Manager to register to.
+ * \param[in] name Name for the module.
+ * \param[in] description Short description for the module.
+ * \param[in] module Module to register.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * This method internally creates a ICommandLineModule module
+ * with the given \p name and \p description, and adds that to
+ * \p manager.
+ *
+ * This method is mainly used by tests that need to have a reference to
+ * the ICommandLineOptionsModule instance (e.g., for mocking).
+ */
+ static void registerModuleDirect(CommandLineModuleManager* manager,
+ const char* name,
+ const char* description,
+ ICommandLineOptionsModulePointer module);
- virtual ~ICommandLineOptionsModule();
+ virtual ~ICommandLineOptionsModule();
- //! \copydoc gmx::ICommandLineModule::init()
- virtual void init(CommandLineModuleSettings *settings) = 0;
- /*! \brief
- * Initializes command-line arguments understood by the module.
- *
- * \param[in,out] options Options object to add the options to.
- * \param[in,out] settings Settings to communicate information
- * to/from generic code running the module.
- *
- * When running the module, this method is called after init().
- * When printing help, there is no call to init(), and this is the only
- * method called.
- * In both cases, the implementation should add options understood by
- * the module to \p options. Output values from options should be
- * stored in member variables.
- */
- virtual void initOptions(IOptionsContainer *options,
- ICommandLineOptionsModuleSettings *settings) = 0;
- /*! \brief
- * Called after all option values have been set.
- *
- * When running the module, this method is called after all
- * command-line arguments have been parsed.
- */
- virtual void optionsFinished() = 0;
+ //! \copydoc gmx::ICommandLineModule::init()
+ virtual void init(CommandLineModuleSettings* settings) = 0;
+ /*! \brief
+ * Initializes command-line arguments understood by the module.
+ *
+ * \param[in,out] options Options object to add the options to.
+ * \param[in,out] settings Settings to communicate information
+ * to/from generic code running the module.
+ *
+ * When running the module, this method is called after init().
+ * When printing help, there is no call to init(), and this is the only
+ * method called.
+ * In both cases, the implementation should add options understood by
+ * the module to \p options. Output values from options should be
+ * stored in member variables.
+ */
+ virtual void initOptions(IOptionsContainer* options, ICommandLineOptionsModuleSettings* settings) = 0;
+ /*! \brief
+ * Called after all option values have been set.
+ *
+ * When running the module, this method is called after all
+ * command-line arguments have been parsed.
+ */
+ virtual void optionsFinished() = 0;
- /*! \brief
- * Runs the module.
- *
- * \throws unspecified May throw exceptions to indicate errors.
- * \returns Exit code for the program.
- * \retval 0 on successful termination.
- *
- * This method is called after optionsFinished() when running the
- * module, and should do all the processing for the module.
- */
- virtual int run() = 0;
+ /*! \brief
+ * Runs the module.
+ *
+ * \throws unspecified May throw exceptions to indicate errors.
+ * \returns Exit code for the program.
+ * \retval 0 on successful termination.
+ *
+ * This method is called after optionsFinished() when running the
+ * module, and should do all the processing for the module.
+ */
+ virtual int run() = 0;
};
} // namespace gmx
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff