2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2014,2015, 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 * Implements gmx::DataFileFinder.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_utility
44 #include "datafilefinder.h"
51 #include "gromacs/utility/exceptions.h"
52 #include "gromacs/utility/file.h"
53 #include "gromacs/utility/path.h"
54 #include "gromacs/utility/programcontext.h"
55 #include "gromacs/utility/stringutil.h"
60 /********************************************************************
61 * DataFileFinder::Impl
64 class DataFileFinder::Impl
67 Impl() : envName_(NULL), bEnvIsSet_(false) {}
71 std::vector<std::string> searchPath_;
74 /********************************************************************
78 DataFileFinder::DataFileFinder()
83 DataFileFinder::~DataFileFinder()
87 void DataFileFinder::setSearchPathFromEnv(const char *envVarName)
91 impl_.reset(new Impl());
93 impl_->envName_ = envVarName;
94 const char *const lib = getenv(envVarName);
97 impl_->bEnvIsSet_ = true;
98 Path::splitPathEnvironment(lib, &impl_->searchPath_);
102 FILE *DataFileFinder::openFile(const DataFileOptions &options) const
104 // TODO: There is a small race here, since there is some time between
105 // the exists() calls and actually opening the file. It would be better
106 // to leave the file open after a successful exists() if the desire is to
107 // actually open the file.
108 std::string filename = findFile(options);
109 if (filename.empty())
116 fprintf(debug, "Opening library file %s\n", fn);
119 return File::openRawHandle(filename, "r");
122 std::string DataFileFinder::findFile(const DataFileOptions &options) const
124 if (options.bCurrentDir_ && Path::exists(options.filename_))
126 return options.filename_;
130 std::vector<std::string>::const_iterator i;
131 for (i = impl_->searchPath_.begin(); i != impl_->searchPath_.end(); ++i)
133 // TODO: Deal with an empty search path entry more reasonably.
134 std::string testPath = Path::join(*i, options.filename_);
135 // TODO: Consider skipping directories.
136 if (Path::exists(testPath))
142 const char *const defaultPath = getProgramContext().defaultLibraryDataPath();
143 if (defaultPath != NULL && defaultPath[0] != '\0')
145 std::string testPath = Path::join(defaultPath, options.filename_);
146 if (Path::exists(testPath))
153 const char *const envName = (impl_.get() ? impl_->envName_ : NULL);
154 const bool bEnvIsSet = (impl_.get() ? impl_->bEnvIsSet_ : false);
156 formatString("Library file %s not found", options.filename_));
157 if (options.bCurrentDir_)
159 message.append(" in current dir nor");
163 message.append(formatString(" in your %s path nor", envName));
165 message.append(" in the default directories.\nThe following paths were searched:");
166 if (options.bCurrentDir_)
168 message.append("\n ");
169 message.append(Path::getWorkingDirectory());
170 message.append(" (current dir)");
174 std::vector<std::string>::const_iterator i;
175 for (i = impl_->searchPath_.begin(); i != impl_->searchPath_.end(); ++i)
177 message.append("\n ");
181 if (defaultPath != NULL && defaultPath[0] != '\0')
183 message.append("\n ");
184 message.append(defaultPath);
185 message.append(" (default)");
187 if (!bEnvIsSet && envName != NULL)
190 formatString("\nYou can set additional directories to search "
191 "with the %s path variable.", envName));
193 GMX_THROW(FileIOError(message));
195 return std::string();