/*
+ * This file is part of the GROMACS molecular simulation package.
*
- * This source code is part of
+ * Copyright (c) 2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
*
- * G R O M A C S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
*
- * GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
*
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
*/
-/*! \file
+/*! \libinternal \file
* \brief
* Declares gmx::CommandLineModuleManager.
*
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
- * \inpublicapi
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
+ * \inlibraryapi
* \ingroup module_commandline
*/
#ifndef GMX_COMMANDLINE_CMDLINEMODULEMANAGER_H
#define GMX_COMMANDLINE_CMDLINEMODULEMANAGER_H
-#include "../utility/common.h"
-#include "../utility/uniqueptr.h"
+#include "gromacs/onlinehelp/helptopicinterface.h"
+#include "gromacs/utility/common.h"
+#include "gromacs/utility/uniqueptr.h"
namespace gmx
{
+class CommandLineModuleGroup;
+class CommandLineModuleGroupData;
class CommandLineModuleInterface;
-class ProgramInfo;
+class CommandLineProgramContext;
+class File;
+
+//! \addtogroup module_commandline
+//! \{
//! Smart pointer type for managing a CommandLineModuleInterface.
typedef gmx_unique_ptr<CommandLineModuleInterface>::type
- CommandLineModulePointer;
-
-namespace internal
-{
-class CommandLineHelpModule;
-}
+ CommandLineModulePointer;
-/*! \brief
+/*! \libinternal \brief
* Implements a wrapper command-line interface for multiple modules.
*
* Typical usage:
* \code
-int
-main(int argc, char *argv[])
-{
- const gmx::ProgramInfo &programInfo =
- gmx::ProgramInfo::init("g_ana", argc, argv);
- CopyRight(stderr, argv[0]);
- try
- {
- gmx::CommandLineModuleManager manager(programInfo);
- // <register all necessary modules>
- return manager.run(argc, argv);
- }
- catch (const std::exception &ex)
- {
- fprintf(stderr, "%s", gmx::formatErrorMessage(ex).c_str());
- return 1;
- }
-}
+ int main(int argc, char *argv[])
+ {
+ gmx::CommandLineProgramContext &programContext = gmx::initForCommandLine(&argc, &argv);
+ try
+ {
+ gmx::CommandLineModuleManager manager("gmx", &programContext);
+ // <register all necessary modules>
+ int rc = manager.run(argc, argv);
+ gmx::finalizeForCommandLine();
+ return rc;
+ }
+ catch (const std::exception &ex)
+ {
+ gmx::printFatalErrorMessage(stderr, ex);
+ return gmx::processExceptionAtExit(ex);
+ }
+ }
* \endcode
*
- * \inpublicapi
- * \ingroup module_commandline
+ * \see page_wrapperbinary
+ * \inlibraryapi
*/
class CommandLineModuleManager
{
public:
+ //! Function pointer type for a C main function.
+ typedef int (*CMainFunction)(int argc, char *argv[]);
+
+ /*! \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 module 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.).
+ *
+ * The signature assumes that \p module construction does not throw
+ * (because otherwise the caller would need to duplicate all the
+ * exception handling code). It is possible to move the construction
+ * inside the try/catch in this method using an indirection similar to
+ * TrajectoryAnalysisCommandLineRunner::runAsMain(), but until that is
+ * necessary, the current approach leads to simpler code.
+ *
+ * Usage:
+ * \code
+ int main(int argc, char *argv[])
+ {
+ CustomCommandLineModule module;
+ return gmx::CommandLineModuleManager::runAsMainSingleModule(argc, argv, &module);
+ }
+ * \endcode
+ *
+ * Does not throw. All exceptions are caught and handled internally.
+ */
+ static int runAsMainSingleModule(int argc, char *argv[],
+ CommandLineModuleInterface *module);
+ /*! \brief
+ * Implements a main() method that runs a given function.
+ *
+ * \param argc \c argc passed to main().
+ * \param argv \c argv passed to main().
+ * \param mainFunction The main()-like method to wrap.
+ *
+ * This method creates a dummy command-line module that does its
+ * processing by calling \p mainFunction; see addModuleCMain() for
+ * details. It then runs this module with runAsMainSingleModule().
+ * This allows the resulting executable to handle common options and do
+ * other common actions (e.g., startup headers) without duplicate code
+ * in the main methods.
+ *
+ * Usage:
+ * \code
+ int my_main(int argc, char *argv[])
+ {
+ // <...>
+ }
+
+ int main(int argc, char *argv[])
+ {
+ return gmx::CommandLineModuleManager::runAsMainCMain(argc, argv, &my_main);
+ }
+ * \endcode
+ *
+ * Does not throw. All exceptions are caught and handled internally.
+ */
+ static int runAsMainCMain(int argc, char *argv[],
+ CMainFunction mainFunction);
+
/*! \brief
* Initializes a command-line module manager.
*
- * \param[in] programInfo Program information for the running binary.
+ * \param[in] binaryName Name of the running binary
+ * (without Gromacs binary suffix or .exe on Windows).
+ * \param programContext Program information for the running binary.
* \throws std::bad_alloc if out of memory.
*
- * The binary name is used to detect when the binary is run through a
+ * \p binaryName is used to detect when the binary is run through a
* symlink, and automatically invoke a matching module in such a case.
+ *
+ * \p programInfo is non-const to allow the manager to amend it based
+ * on the actual module that is getting executed.
*/
- explicit CommandLineModuleManager(const ProgramInfo &programInfo);
+ CommandLineModuleManager(const char *binaryName,
+ CommandLineProgramContext *programContext);
~CommandLineModuleManager();
+ /*! \brief
+ * Sets the module manager to quiet mode: don't print anything.
+ *
+ * \param[in] bQuiet Whether the module manager should remain silent.
+ *
+ * Normally, the module manager prints out some information to `stderr`
+ * before it starts the module and after it finishes. This removes
+ * that output, which is useful in particular for unit tests so that
+ * they don't spam `stderr`.
+ */
+ void setQuiet(bool bQuiet);
+ /*! \brief
+ * Redirects the output of the module manager to a file.
+ *
+ * \param[in] output File to write the output to.
+ *
+ * Normally, the module manager prints explicitly requested text such
+ * as help output to `stdout`, but this method can be used to redirect
+ * that output to a file. This is used for unit tests, either to keep
+ * them quiet or to verify that output. To keep implementation options
+ * open, behavior with `output == NULL` is undefined and should not be
+ * relied on. For tests, there should only be need to call this a
+ * single time, right after creating the manager.
+ */
+ void setOutputRedirect(File *output);
+
+ /*! \brief
+ * Makes the manager always run a single module.
+ *
+ * \param module Module to run.
+ *
+ * This method disables all mechanisms for selecting a module, and
+ * directly passes all command-line arguments to \p module.
+ * Help arguments are an exception: these are still recognized by the
+ * manager and translated into a call to
+ * CommandLineModuleInterface::writeHelp().
+ *
+ * This is public mainly for unit testing purposes; for other code,
+ * runAsMainSingleModule() typically provides the desired
+ * functionality.
+ *
+ * Does not throw.
+ */
+ void setSingleModule(CommandLineModuleInterface *module);
/*! \brief
* Adds a given module to this manager.
*
* \see registerModule()
*/
void addModule(CommandLineModulePointer module);
+ /*! \brief
+ * Adds a module that runs a given main()-like function.
+ *
+ * \param[in] name Name for the module.
+ * \param[in] shortDescription One-line description for the module.
+ * \param[in] mainFunction Main function to wrap.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * There is normally no need to call this method outside the Gromacs
+ * library. User code usually wants to use runAsMainCMain().
+ *
+ * \p name and \p shortDescription should be string constants, or the
+ * caller should otherwise ensure that they stay in scope for the
+ * duration the CommandLineModuleManager object exists.
+ * \p mainFunction should call parse_common_args() to process its
+ * command-line arguments.
+ */
+ void addModuleCMain(const char *name, const char *shortDescription,
+ CMainFunction mainFunction);
/*! \brief
* Registers a module of a certain type to this manager.
*
addModule(CommandLineModulePointer(new Module));
}
+ /*! \brief
+ * Adds a group for modules to use in help output.
+ *
+ * \param[in] title Short title for the group.
+ * \returns Handle that can be used to add modules to the group.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * Creates a group that is used to structure the list of all modules in
+ * help output. Modules are added to the group using the returned
+ * object.
+ */
+ CommandLineModuleGroup addModuleGroup(const char *title);
+
+ /*! \brief
+ * Makes given help topic available through the manager's help module.
+ *
+ * \param[in] topic Help topic to add.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * The manager takes ownership of the help topic.
+ */
+ void addHelpTopic(HelpTopicPointer topic);
+
/*! \brief
* Runs a module based on given command line.
*
class Impl;
PrivateImplPointer<Impl> impl_;
+};
+
+/*! \libinternal \brief
+ * Handle to add content to a group added with
+ * CommandLineModuleManager::addModuleGroup().
+ *
+ * This class only provides a public interface to construct a module group for
+ * CommandLineModuleManager, and has semantics similar to a pointer: copies all
+ * point to the same group. The actual state of the group is maintained in an
+ * internal implementation class.
+ *
+ * \inlibraryapi
+ */
+class CommandLineModuleGroup
+{
+ public:
+ /*! \cond internal */
+ //! Shorthand for the implementation type that holds all the data.
+ typedef CommandLineModuleGroupData Impl;
+
+ //! Creates a new group (only called by CommandLineModuleManager).
+ explicit CommandLineModuleGroup(Impl *impl) : impl_(impl) {}
+ //! \endcond
/*! \brief
- * Needed to access information about registered modules etc.
+ * Adds a module to this group.
+ *
+ * \param[in] name Name of the module.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * This works as addModuleWithDescription(), but uses the short
+ * description of the module itself as the description.
+ *
+ * \see addModuleWithDescription()
*/
- friend class internal::CommandLineHelpModule;
+ void addModule(const char *name);
+ /*! \brief
+ * Adds a module to this group with a custom description.
+ *
+ * \param[in] name Name of the module.
+ * \param[in] description Description of the module in this group.
+ * \throws std::bad_alloc if out of memory.
+ *
+ * \p name must name a module added into the CommandLineModuleManager.
+ * It is possible to add the same module into multiple groups.
+ */
+ void addModuleWithDescription(const char *name, const char *description);
+
+ private:
+ //! Pointer to the data owned by CommandLineModuleManager.
+ Impl *impl_;
};
+//! \}
+
} // namespace gmx
#endif
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff