2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
37 * Declares gmx::CommandLineProgramContext.
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
44 * \author Teemu Murtola <teemu.murtola@gmail.com>
46 * \ingroup module_commandline
48 #ifndef GMX_COMMANDLINE_CMDLINEPROGRAMCONTEXT_H
49 #define GMX_COMMANDLINE_CMDLINEPROGRAMCONTEXT_H
54 #include "../utility/common.h"
55 #include "../utility/programcontext.h"
56 #include "../utility/uniqueptr.h"
61 //! \addtogroup module_commandline
64 /*! \libinternal \brief
65 * Allows customization of the way various directories are found by
66 * CommandLineProgramContext.
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.
74 class ExecutableEnvironmentInterface
77 virtual ~ExecutableEnvironmentInterface() {}
80 * Returns the working directory when the program was launched.
82 virtual std::string getWorkingDirectory() const = 0;
84 * Returns list of paths where executables are searched for.
86 * The returned list should be in priority order. An empty string in
87 * the returned list corresponds to getWorkindDirectory().
89 virtual std::vector<std::string> getExecutablePaths() const = 0;
92 //! Shorthand for a smart pointer to ExecutableEnvironmentInterface.
93 typedef gmx_unique_ptr<ExecutableEnvironmentInterface>::type
94 ExecutableEnvironmentPointer;
96 /*! \libinternal \brief
97 * Program context implementation for command line programs.
99 * Constructors are provided mostly for unit testing purposes; in normal usage,
100 * a single CommandLineProgramContext object is constructed with
101 * initForCommandLine() in the beginning of the program.
102 * The returned object can be explicitly passed to other methods, or accessed
103 * through getProgramContext().
105 * Unless explicitly noted otherwise, methods in this class may throw
106 * std::bad_alloc on out-of-memory conditions, but do not throw other
111 class CommandLineProgramContext : public ProgramContextInterface
115 * Constructs an empty context object.
117 * All methods in the constructed object return dummy values.
119 CommandLineProgramContext();
121 * Initializes a program context object with binary name only.
123 * \param[in] binaryName Name of the binary.
125 * This is needed for unit testing purposes.
126 * The constructed object works as if the command line consisted of
127 * only of the binary name.
129 explicit CommandLineProgramContext(const char *binaryName);
131 * Initializes a program context object based on command line.
133 * \param[in] argc argc value passed to main().
134 * \param[in] argv argv array passed to main().
136 CommandLineProgramContext(int argc, const char *const argv[]);
138 * Initializes a program context object based on command line.
140 * \param[in] argc argc value passed to main().
141 * \param[in] argv argv array passed to main().
142 * \param[in] env Customizes the way the binary name is handled.
144 * This overload allows one to customize the way the binary is located
145 * by providing a custom ExecutableEnvironmentInterface implementation.
146 * This is mainly useful for testing purposes to make it possible to
147 * test different paths without setting environment variables, changing
148 * the working directory or doing other process-wide operations.
149 * It may also be useful for making Gromacs behave better when linked
150 * into a non-Gromacs executable (with possible extensions in
151 * ExecutableEnvironmentInterface).
153 CommandLineProgramContext(int argc, const char *const argv[],
154 ExecutableEnvironmentPointer env);
155 virtual ~CommandLineProgramContext();
158 * Sets a display name for the binary.
160 * \throws std::bad_alloc if out of memory.
162 * This is used with the wrapper binary to add the name of the invoked
163 * module to the name of the binary shown.
165 * It is not threadsafe if there are concurrent calls to displayName()
166 * before this method has returned. Thread safety is not required for
167 * the normal initialization sequence of command line programs; it is
168 * called in the wrapper binary before the control passes to the actual
169 * module which may create threads.
171 void setDisplayName(const std::string &name);
174 * Returns the name of the binary as it was invoked without any path.
178 virtual const char *programName() const;
180 * Returns a display name of the current module.
182 * The returned value equals programName(), unless a separate display
183 * name has been set with setDisplayName().
187 virtual const char *displayName() const;
189 * Returns the full path of the running binary.
191 * \throws std::bad_alloc if out of memory.
192 * \throws tMPI::system_error on thread synchronization errors.
194 * Returns argv[0] if there was an error in finding the absolute path.
196 virtual const char *fullBinaryPath() const;
198 * Returns the default path for \Gromacs data files.
200 * \throws std::bad_alloc if out of memory.
201 * \throws tMPI::system_error on thread synchronization errors.
203 * Returns a hardcoded path set during configuration time if there is
204 * an error in finding the library data files.
206 virtual const char *defaultLibraryDataPath() const;
208 * Returns the full command line used to invoke the binary.
212 virtual const char *commandLine() const;
217 PrivateImplPointer<Impl> impl_;