src/gromacs/commandline/cmdlinemodulemanager.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014, 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 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::CommandLineModuleManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_commandline
  42  */
  43 #ifndef GMX_COMMANDLINE_CMDLINEMODULEMANAGER_H
  44 #define GMX_COMMANDLINE_CMDLINEMODULEMANAGER_H
  45
  46 #include "gromacs/onlinehelp/helptopicinterface.h"
  47 #include "gromacs/utility/common.h"
  48 #include "gromacs/utility/uniqueptr.h"
  49
  50 namespace gmx
  51 {
  52
  53 class CommandLineModuleGroup;
  54 class CommandLineModuleGroupData;
  55 class CommandLineModuleInterface;
  56 class CommandLineProgramContext;
  57 class File;
  58
  59 //! \addtogroup module_commandline
  60 //! \{
  61
  62 //! Smart pointer type for managing a CommandLineModuleInterface.
  63 typedef gmx_unique_ptr<CommandLineModuleInterface>::type
  64     CommandLineModulePointer;
  65
  66 /*! \libinternal \brief
  67  * Implements a wrapper command-line interface for multiple modules.
  68  *
  69  * Typical usage:
  70  * \code
  71    int main(int argc, char *argv[])
  72    {
  73        gmx::CommandLineProgramContext &programContext = gmx::initForCommandLine(&argc, &argv);
  74        try
  75        {
  76            gmx::CommandLineModuleManager manager("gmx", &programContext);
  77            // <register all necessary modules>
  78            int rc = manager.run(argc, argv);
  79            gmx::finalizeForCommandLine();
  80            return rc;
  81        }
  82        catch (const std::exception &ex)
  83        {
  84            gmx::printFatalErrorMessage(stderr, ex);
  85            return gmx::processExceptionAtExitForCommandLine(ex);
  86        }
  87    }
  88  * \endcode
  89  *
  90  * \see page_wrapperbinary
  91  * \inlibraryapi
  92  */
  93 class CommandLineModuleManager
  94 {
  95     public:
  96         //! Function pointer type for a C main function.
  97         typedef int (*CMainFunction)(int argc, char *argv[]);
  98
  99         /*! \brief
 100          * Implements a main() method that runs a single module.
 101          *
 102          * \param argc   \c argc passed to main().
 103          * \param argv   \c argv passed to main().
 104          * \param module Module to run.
 105          *
 106          * This method allows for uniform behavior for binaries that only
 107          * contain a single module without duplicating any of the
 108          * implementation from CommandLineModuleManager (startup headers,
 109          * common options etc.).
 110          *
 111          * The signature assumes that \p module construction does not throw
 112          * (because otherwise the caller would need to duplicate all the
 113          * exception handling code).  It is possible to move the construction
 114          * inside the try/catch in this method using an indirection similar to
 115          * TrajectoryAnalysisCommandLineRunner::runAsMain(), but until that is
 116          * necessary, the current approach leads to simpler code.
 117          *
 118          * Usage:
 119          * \code
 120            int main(int argc, char *argv[])
 121            {
 122                CustomCommandLineModule module;
 123                return gmx::CommandLineModuleManager::runAsMainSingleModule(argc, argv, &module);
 124            }
 125          * \endcode
 126          *
 127          * Does not throw.  All exceptions are caught and handled internally.
 128          */
 129         static int runAsMainSingleModule(int argc, char *argv[],
 130                                          CommandLineModuleInterface *module);
 131         /*! \brief
 132          * Implements a main() method that runs a given function.
 133          *
 134          * \param argc         \c argc passed to main().
 135          * \param argv         \c argv passed to main().
 136          * \param mainFunction The main()-like method to wrap.
 137          *
 138          * This method creates a dummy command-line module that does its
 139          * processing by calling \p mainFunction; see addModuleCMain() for
 140          * details.  It then runs this module with runAsMainSingleModule().
 141          * This allows the resulting executable to handle common options and do
 142          * other common actions (e.g., startup headers) without duplicate code
 143          * in the main methods.
 144          *
 145          * Usage:
 146          * \code
 147            int my_main(int argc, char *argv[])
 148            {
 149                // <...>
 150            }
 151
 152            int main(int argc, char *argv[])
 153            {
 154                return gmx::CommandLineModuleManager::runAsMainCMain(argc, argv, &my_main);
 155            }
 156          * \endcode
 157          *
 158          * Does not throw.  All exceptions are caught and handled internally.
 159          */
 160         static int runAsMainCMain(int argc, char *argv[],
 161                                   CMainFunction mainFunction);
 162
 163         /*! \brief
 164          * Initializes a command-line module manager.
 165          *
 166          * \param[in] binaryName     Name of the running binary
 167          *     (without Gromacs binary suffix or .exe on Windows).
 168          * \param     programContext Program information for the running binary.
 169          * \throws    std::bad_alloc if out of memory.
 170          *
 171          * \p binaryName is used to detect when the binary is run through a
 172          * symlink, and automatically invoke a matching module in such a case.
 173          *
 174          * \p programInfo is non-const to allow the manager to amend it based
 175          * on the actual module that is getting executed.
 176          */
 177         CommandLineModuleManager(const char                *binaryName,
 178                                  CommandLineProgramContext *programContext);
 179         ~CommandLineModuleManager();
 180
 181         /*! \brief
 182          * Sets the module manager to quiet mode: don't print anything.
 183          *
 184          * \param[in] bQuiet  Whether the module manager should remain silent.
 185          *
 186          * Normally, the module manager prints out some information to `stderr`
 187          * before it starts the module and after it finishes.  This removes
 188          * that output, which is useful in particular for unit tests so that
 189          * they don't spam `stderr`.
 190          */
 191         void setQuiet(bool bQuiet);
 192         /*! \brief
 193          * Redirects the output of the module manager to a file.
 194          *
 195          * \param[in] output  File to write the output to.
 196          *
 197          * Normally, the module manager prints explicitly requested text such
 198          * as help output to `stdout`, but this method can be used to redirect
 199          * that output to a file.  This is used for unit tests, either to keep
 200          * them quiet or to verify that output.  To keep implementation options
 201          * open, behavior with `output == NULL` is undefined and should not be
 202          * relied on.  For tests, there should only be need to call this a
 203          * single time, right after creating the manager.
 204          */
 205         void setOutputRedirect(File *output);
 206
 207         /*! \brief
 208          * Makes the manager always run a single module.
 209          *
 210          * \param     module  Module to run.
 211          *
 212          * This method disables all mechanisms for selecting a module, and
 213          * directly passes all command-line arguments to \p module.
 214          * Help arguments are an exception: these are still recognized by the
 215          * manager and translated into a call to
 216          * CommandLineModuleInterface::writeHelp().
 217          *
 218          * This is public mainly for unit testing purposes; for other code,
 219          * runAsMainSingleModule() typically provides the desired
 220          * functionality.
 221          *
 222          * Does not throw.
 223          */
 224         void setSingleModule(CommandLineModuleInterface *module);
 225         /*! \brief
 226          * Adds a given module to this manager.
 227          *
 228          * \param   module  Module to add.
 229          * \throws  std::bad_alloc if out of memory.
 230          *
 231          * The manager takes ownership of the object.
 232          *
 233          * This method is public mostly for testing purposes; for typical uses,
 234          * registerModule() is a more convenient way of adding modules.
 235          *
 236          * \see registerModule()
 237          */
 238         void addModule(CommandLineModulePointer module);
 239         /*! \brief
 240          * Adds a module that runs a given main()-like function.
 241          *
 242          * \param[in] name             Name for the module.
 243          * \param[in] shortDescription One-line description for the module.
 244          * \param[in] mainFunction     Main function to wrap.
 245          * \throws    std::bad_alloc if out of memory.
 246          *
 247          * There is normally no need to call this method outside the Gromacs
 248          * library.  User code usually wants to use runAsMainCMain().
 249          *
 250          * \p name and \p shortDescription should be string constants, or the
 251          * caller should otherwise ensure that they stay in scope for the
 252          * duration the CommandLineModuleManager object exists.
 253          * \p mainFunction should call parse_common_args() to process its
 254          * command-line arguments.
 255          */
 256         void addModuleCMain(const char *name, const char *shortDescription,
 257                             CMainFunction mainFunction);
 258         /*! \brief
 259          * Registers a module of a certain type to this manager.
 260          *
 261          * \tparam  Module  Type of module to register.
 262          * \throws  std::bad_alloc if out of memory.
 263          *
 264          * \p Module must be default-constructible and implement
 265          * CommandLineModuleInterface.
 266          *
 267          * This method is provided as a convenient alternative to addModule()
 268          * for cases where each module is implemented by a different type
 269          * (which should be the case for typical situations outside unit
 270          * tests).
 271          */
 272         template <class Module>
 273         void registerModule()
 274         {
 275             addModule(CommandLineModulePointer(new Module));
 276         }
 277
 278         /*! \brief
 279          * Adds a group for modules to use in help output.
 280          *
 281          * \param[in] title  Short title for the group.
 282          * \returns   Handle that can be used to add modules to the group.
 283          * \throws    std::bad_alloc if out of memory.
 284          *
 285          * Creates a group that is used to structure the list of all modules in
 286          * help output.  Modules are added to the group using the returned
 287          * object.
 288          */
 289         CommandLineModuleGroup addModuleGroup(const char *title);
 290
 291         /*! \brief
 292          * Makes given help topic available through the manager's help module.
 293          *
 294          * \param[in]  topic  Help topic to add.
 295          * \throws     std::bad_alloc if out of memory.
 296          *
 297          * The manager takes ownership of the help topic.
 298          */
 299         void addHelpTopic(HelpTopicPointer topic);
 300
 301         /*! \brief
 302          * Runs a module based on given command line.
 303          *
 304          * \param[in] argc  Number of elements in \p argv.
 305          * \param[in] argv  Command-line arguments.
 306          * \throws   unspecified  Throws any exception that the selected module
 307          *      throws.
 308          * \returns  Exit code for the program.
 309          * \retval   0 on successful termination.
 310          * \retval   2 if no module is specified, or if the module is not found.
 311          *
 312          * Runs the module whose name matches \p argv[1].
 313          */
 314         int run(int argc, char *argv[]);
 315
 316     private:
 317         class Impl;
 318
 319         PrivateImplPointer<Impl> impl_;
 320 };
 321
 322 /*! \libinternal \brief
 323  * Handle to add content to a group added with
 324  * CommandLineModuleManager::addModuleGroup().
 325  *
 326  * This class only provides a public interface to construct a module group for
 327  * CommandLineModuleManager, and has semantics similar to a pointer: copies all
 328  * point to the same group.  The actual state of the group is maintained in an
 329  * internal implementation class.
 330  *
 331  * \inlibraryapi
 332  */
 333 class CommandLineModuleGroup
 334 {
 335     public:
 336         /*! \cond internal */
 337         //! Shorthand for the implementation type that holds all the data.
 338         typedef CommandLineModuleGroupData Impl;
 339
 340         //! Creates a new group (only called by CommandLineModuleManager).
 341         explicit CommandLineModuleGroup(Impl *impl) : impl_(impl) {}
 342         //! \endcond
 343
 344         /*! \brief
 345          * Adds a module to this group.
 346          *
 347          * \param[in] name  Name of the module.
 348          * \throws    std::bad_alloc if out of memory.
 349          *
 350          * This works as addModuleWithDescription(), but uses the short
 351          * description of the module itself as the description.
 352          *
 353          * \see addModuleWithDescription()
 354          */
 355         void addModule(const char *name);
 356         /*! \brief
 357          * Adds a module to this group with a custom description.
 358          *
 359          * \param[in] name        Name of the module.
 360          * \param[in] description Description of the module in this group.
 361          * \throws    std::bad_alloc if out of memory.
 362          *
 363          * \p name must name a module added into the CommandLineModuleManager.
 364          * It is possible to add the same module into multiple groups.
 365          */
 366         void addModuleWithDescription(const char *name, const char *description);
 367
 368     private:
 369         //! Pointer to the data owned by CommandLineModuleManager.
 370         Impl                     *impl_;
 371 };
 372
 373 //! \}
 374
 375 } // namespace gmx
 376
 377 #endif