src/gromacs/trajectoryanalysis/cmdlinerunner.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013, 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 /*! \file
  36  * \brief
  37  * Declares gmx::TrajectoryAnalysisCommandLineRunner.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_trajectoryanalysis
  42  */
  43 #ifndef GMX_TRAJECTORYANALYSIS_CMDLINERUNNER_H
  44 #define GMX_TRAJECTORYANALYSIS_CMDLINERUNNER_H
  45
  46 #include "analysismodule.h"
  47 #include "../utility/common.h"
  48
  49 namespace gmx
  50 {
  51
  52 class CommandLineModuleManager;
  53 class CommandLineHelpContext;
  54
  55 /*! \brief
  56  * Runner class for command-line analysis tools.
  57  *
  58  * This class implements a command-line analysis program, given a
  59  * TrajectoryAnalysisModule object.  It takes care of converting command-line
  60  * parameters to a form understood by the module, as well as parsing common
  61  * options, initializing and evaluating selections, and looping over trajectory
  62  * frames.
  63  *
  64  * \inpublicapi
  65  * \ingroup module_trajectoryanalysis
  66  */
  67 class TrajectoryAnalysisCommandLineRunner
  68 {
  69     public:
  70         /*! \brief
  71          * Factory method type for creating a trajectory analysis module.
  72          *
  73          * This method allows the module creation to be postponed to be inside
  74          * the try/catch block in runAsMain()/registerModule() implementation
  75          * methods and still keep the implementation out of the header, making
  76          * the ABI more stable.
  77          */
  78         typedef TrajectoryAnalysisModulePointer (*ModuleFactoryMethod)();
  79
  80         /*! \brief
  81          * Implements a main() method that runs a given module.
  82          *
  83          * \tparam ModuleType  Trajectory analysis module.
  84          * \param  argc        \c argc passed to main().
  85          * \param  argv        \c argv passed to main().
  86          *
  87          * This method abstracts away all the logic required to implement a
  88          * main() method in user tools, allowing that to be changed without
  89          * requiring changes to the tools themselves.
  90          *
  91          * \p ModuleType should be default-constructible and derive from
  92          * TrajectoryAnalysisModule.
  93          *
  94          * Does not throw.  All exceptions are caught and handled internally.
  95          */
  96         template <class ModuleType>
  97         static int runAsMain(int argc, char *argv[])
  98         {
  99             return runAsMain(argc, argv, &createModule<ModuleType>);
 100         }
 101         /*! \brief
 102          * Registers a command-line module that runs a given module.
 103          *
 104          * \tparam ModuleType  Trajectory analysis module.
 105          * \param  manager     Manager to register the module to.
 106          * \param  name        Name of the module to register.
 107          * \param  description One-line description for the module to register.
 108          *
 109          * \p ModuleType should be default-constructible and derive from
 110          * TrajectoryAnalysisModule.
 111          *
 112          * \p name and \p descriptions must be string constants or otherwise
 113          * stay valid for the duration of the program execution.
 114          */
 115         template <class ModuleType>
 116         static void registerModule(CommandLineModuleManager *manager,
 117                                    const char *name, const char *description)
 118         {
 119             registerModule(manager, name, description, &createModule<ModuleType>);
 120         }
 121         /*! \brief
 122          * Registers a command-line module that runs a given module.
 123          *
 124          * \tparam ModuleType  Trajectory analysis module.
 125          * \param  manager     Manager to register the module to.
 126          * \param  name        Name of the module to register.
 127          * \param  description One-line description for the module to register.
 128          * \param  factory     Function that creates the module on demand.
 129          *
 130          * \p name and \p descriptions must be string constants or otherwise
 131          * stay valid for the duration of the program execution.
 132          *
 133          * Implements the template registerModule() method, but can also be
 134          * used independently.
 135          */
 136         static void registerModule(CommandLineModuleManager *manager,
 137                                    const char *name, const char *description,
 138                                    ModuleFactoryMethod factory);
 139
 140         /*! \brief
 141          * Create a new runner with the provided module.
 142          *
 143          * \param  module  Analysis module to run using the runner.
 144          * \throws std::bad_alloc if out of memory.
 145          *
 146          * The caller should ensure that the provided module is not destroyed
 147          * while the runner exists.
 148          */
 149         TrajectoryAnalysisCommandLineRunner(TrajectoryAnalysisModule *module);
 150         ~TrajectoryAnalysisCommandLineRunner();
 151
 152         /*! \brief
 153          * Sets whether default index groups are initialized.
 154          *
 155          * This is intended only for internal unit testing purposes to avoid
 156          * repeated, unnecessary initialization of the default groups, which
 157          * can be expensive under, e.g., valgrind.
 158          *
 159          * Does not throw.
 160          */
 161         void setUseDefaultGroups(bool bUseDefaults);
 162         /*! \brief
 163          * Sets the default debugging level for selections.
 164          *
 165          * \param[in] debuglevel  Level of debugging verbosity.
 166          *
 167          * This is intended only for use by internal debugging tools.
 168          *
 169          * Does not throw.
 170          *
 171          * \see SelectionCollection::setDebugLevel()
 172          */
 173         void setSelectionDebugLevel(int debuglevel);
 174         /*! \brief
 175          * Parses options from the given command line and runs the analysis.
 176          *
 177          * \throws  multiple  Exceptions are used to indicate errors.
 178          * \returns Zero on success.
 179          */
 180         int run(int argc, char *argv[]);
 181         /*! \brief
 182          * Prints help for the module, including common options from the runner.
 183          *
 184          * \param[in] context  Context object for writing the help.
 185          * \throws    std::bad_alloc if out of memory.
 186          * \throws    FileIOError on any I/O error.
 187          */
 188         void writeHelp(const CommandLineHelpContext &context);
 189
 190     private:
 191         /*! \brief
 192          * Creates a trajectory analysis module of a given type.
 193          *
 194          * \tparam ModuleType  Module to create.
 195          */
 196         template <class ModuleType>
 197         static TrajectoryAnalysisModulePointer createModule()
 198         {
 199             return TrajectoryAnalysisModulePointer(new ModuleType());
 200         }
 201
 202         //! Implements the template runAsMain() method.
 203         static int runAsMain(int argc, char *argv[],
 204                              ModuleFactoryMethod factory);
 205
 206         class Impl;
 207
 208         PrivateImplPointer<Impl> impl_;
 209 };
 210
 211 } // namespace gmx
 212
 213 #endif