src/gromacs/commandline/cmdlineprogramcontext.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2018, 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::CommandLineProgramContext.
  38  *
  39  * This header is installed to support cmdlineinit.h because some compilers
  40  * don't allow returning a reference to an incomplete type from a function.
  41  * It should not be necessary to use gmx::CommandLineProgramContext outside the
  42  * \Gromacs library.
  43  *
  44  * \author Teemu Murtola <teemu.murtola@gmail.com>
  45  * \inlibraryapi
  46  * \ingroup module_commandline
  47  */
  48 #ifndef GMX_COMMANDLINE_CMDLINEPROGRAMCONTEXT_H
  49 #define GMX_COMMANDLINE_CMDLINEPROGRAMCONTEXT_H
  50
  51 #include <memory>
  52 #include <string>
  53 #include <vector>
  54
  55 #include "gromacs/utility/classhelpers.h"
  56 #include "gromacs/utility/programcontext.h"
  57
  58 namespace gmx
  59 {
  60
  61 //! \addtogroup module_commandline
  62 //! \{
  63
  64 /*! \libinternal \brief
  65  * Allows customization of the way various directories are found by
  66  * CommandLineProgramContext.
  67  *
  68  * For the CommandLineProgramContext constructors that do not take this
  69  * interface as a parameter, a default implementation is used that forwards
  70  * the calls to the corresponding methods in gmx::Path.
  71  *
  72  * \inlibraryapi
  73  */
  74 class IExecutableEnvironment
  75 {
  76     public:
  77         virtual ~IExecutableEnvironment() {}
  78
  79         /*! \brief
  80          * Returns the working directory when the program was launched.
  81          */
  82         virtual std::string getWorkingDirectory() const = 0;
  83         /*! \brief
  84          * Returns list of paths where executables are searched for.
  85          *
  86          * The returned list should be in priority order.  An empty string in
  87          * the returned list corresponds to getWorkindDirectory().
  88          */
  89         virtual std::vector<std::string> getExecutablePaths() const = 0;
  90 };
  91
  92 //! Shorthand for a smart pointer to IExecutableEnvironment.
  93 typedef std::unique_ptr<IExecutableEnvironment> ExecutableEnvironmentPointer;
  94
  95 /*! \libinternal \brief
  96  * Program context implementation for command line programs.
  97  *
  98  * Constructors are provided mostly for unit testing purposes; in normal usage,
  99  * a single CommandLineProgramContext object is constructed with
 100  * initForCommandLine() in the beginning of the program.
 101  * The returned object can be explicitly passed to other methods, or accessed
 102  * through getProgramContext().
 103  *
 104  * Unless explicitly noted otherwise, methods in this class may throw
 105  * std::bad_alloc on out-of-memory conditions, but do not throw other
 106  * exceptions.
 107  *
 108  * \inlibraryapi
 109  */
 110 class CommandLineProgramContext : public IProgramContext
 111 {
 112     public:
 113         /*! \brief
 114          * Constructs an empty context object.
 115          *
 116          * All methods in the constructed object return dummy values.
 117          */
 118         CommandLineProgramContext();
 119         /*! \brief
 120          * Initializes a program context object with binary name only.
 121          *
 122          * \param[in] binaryName  Name of the binary.
 123          *
 124          * This is needed for unit testing purposes.
 125          * The constructed object works as if the command line consisted of
 126          * only of the binary name.
 127          */
 128         explicit CommandLineProgramContext(const char *binaryName);
 129         /*! \brief
 130          * Initializes a program context object based on command line.
 131          *
 132          * \param[in] argc  argc value passed to main().
 133          * \param[in] argv  argv array passed to main().
 134          */
 135         CommandLineProgramContext(int argc, const char *const argv[]);
 136         /*! \brief
 137          * Initializes a program context object based on command line.
 138          *
 139          * \param[in] argc  argc value passed to main().
 140          * \param[in] argv  argv array passed to main().
 141          * \param[in] env   Customizes the way the binary name is handled.
 142          *
 143          * This overload allows one to customize the way the binary is located
 144          * by providing a custom IExecutableEnvironment implementation.
 145          * This is mainly useful for testing purposes to make it possible to
 146          * test different paths without setting environment variables, changing
 147          * the working directory or doing other process-wide operations.
 148          * It may also be useful for making Gromacs behave better when linked
 149          * into a non-Gromacs executable (with possible extensions in
 150          * IExecutableEnvironment).
 151          */
 152         CommandLineProgramContext(int argc, const char *const argv[],
 153                                   ExecutableEnvironmentPointer env);
 154         ~CommandLineProgramContext() override;
 155
 156         /*! \brief
 157          * Sets a display name for the binary.
 158          *
 159          * \throws std::bad_alloc if out of memory.
 160          *
 161          * This is used with the wrapper binary to add the name of the invoked
 162          * module to the name of the binary shown.
 163          *
 164          * It is not threadsafe if there are concurrent calls to displayName()
 165          * before this method has returned.  Thread safety is not required for
 166          * the normal initialization sequence of command line programs; it is
 167          * called in the wrapper binary before the control passes to the actual
 168          * module which may create threads.
 169          */
 170         void setDisplayName(const std::string &name);
 171
 172         /*! \brief
 173          * Returns the name of the binary as it was invoked without any path.
 174          *
 175          * Does not throw.
 176          */
 177         const char *programName() const override;
 178         /*! \brief
 179          * Returns a display name of the current module.
 180          *
 181          * The returned value equals programName(), unless a separate display
 182          * name has been set with setDisplayName().
 183          *
 184          * Does not throw.
 185          */
 186         const char *displayName() const override;
 187         /*! \brief
 188          * Returns the full path of the running binary.
 189          *
 190          * \throws std::bad_alloc if out of memory.
 191          * \throws tMPI::system_error on thread synchronization errors.
 192          *
 193          * Returns argv[0] if there was an error in finding the absolute path.
 194          */
 195         const char *fullBinaryPath() const override;
 196         /*! \brief
 197          * Returns the installation prefix (for finding \Gromacs data files).
 198          *
 199          * \throws std::bad_alloc if out of memory.
 200          * \throws tMPI::system_error on thread synchronization errors.
 201          *
 202          * Returns a hardcoded path set during configuration time if there is
 203          * an error in finding the library data files.
 204          */
 205         InstallationPrefixInfo installationPrefix() const override;
 206         /*! \brief
 207          * Returns the full command line used to invoke the binary.
 208          *
 209          * Does not throw.
 210          */
 211         const char *commandLine() const override;
 212
 213     private:
 214         class Impl;
 215
 216         PrivateImplPointer<Impl> impl_;
 217 };
 218
 219 } // namespace gmx
 220
 221 #endif