2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2011,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 * Implements functions in path.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_utility
57 #ifdef GMX_NATIVE_WINDOWS
66 #include "gromacs/utility/exceptions.h"
67 #include "gromacs/utility/futil.h"
68 #include "gromacs/utility/stringutil.h"
73 //! Directory separator to use when joining paths.
74 const char cDirSeparator = '/';
75 //! Directory separators to use when parsing paths.
76 const char cDirSeparators[] = "/\\";
77 /*! \var cPathSeparator
79 * Separator to use to split the PATH environment variable.
81 * When reading the PATH environment variable, Unix separates entries
82 * with colon, while windows uses semicolon.
84 #ifdef GMX_NATIVE_WINDOWS
85 const char cPathSeparator = ';';
87 const char cPathSeparator = ':';
90 //! Check whether a given character is a directory separator.
91 bool isDirSeparator(char chr)
93 return std::strchr(cDirSeparators, chr);
101 /********************************************************************
105 bool Path::containsDirectory(const std::string &path)
107 return path.find_first_of(cDirSeparators) != std::string::npos;
110 /* Check if the program name begins with "/" on unix/cygwin, or
111 * with "\" or "X:\" on windows. If not, the program name
112 * is relative to the current directory.
114 bool Path::isAbsolute(const char *path)
116 if (isDirSeparator(path[0]))
120 #ifdef GMX_NATIVE_WINDOWS
121 return path[0] != '\0' && path[1] == ':' && isDirSeparator(path[2]);
127 bool Path::isAbsolute(const std::string &path)
129 return isAbsolute(path.c_str());
132 #ifdef GMX_NATIVE_WINDOWS
135 struct handle_wrapper
138 handle_wrapper(HANDLE h)
142 if (handle != INVALID_HANDLE_VALUE)
144 ::CloseHandle(handle);
151 bool Path::isEquivalent(const std::string &path1, const std::string &path2)
153 //based on boost_1_56_0/libs/filesystem/src/operations.cpp under BSL
154 #ifdef GMX_NATIVE_WINDOWS
155 // Note well: Physical location on external media is part of the
156 // equivalence criteria. If there are no open handles, physical location
157 // can change due to defragmentation or other relocations. Thus handles
158 // must be held open until location information for both paths has
161 // p2 is done first, so any error reported is for p1
167 FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
170 FILE_FLAG_BACKUP_SEMANTICS,
177 FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
180 FILE_FLAG_BACKUP_SEMANTICS,
183 if (h1.handle == INVALID_HANDLE_VALUE
184 || h2.handle == INVALID_HANDLE_VALUE)
186 // if one is invalid and the other isn't, then they aren't equivalent,
187 // but if both are invalid then it is an error
188 if (h1.handle == INVALID_HANDLE_VALUE
189 && h2.handle == INVALID_HANDLE_VALUE)
191 GMX_THROW(FileIOError("Path::isEquivalent called with two invalid files"));
197 // at this point, both handles are known to be valid
199 BY_HANDLE_FILE_INFORMATION info1, info2;
201 if (!GetFileInformationByHandle(h1.handle, &info1))
203 GMX_THROW(FileIOError("Path::isEquivalent: GetFileInformationByHandle failed"));
206 if (!GetFileInformationByHandle(h2.handle, &info2))
208 GMX_THROW(FileIOError("Path::isEquivalent: GetFileInformationByHandle failed"));
211 // In theory, volume serial numbers are sufficient to distinguish between
212 // devices, but in practice VSN's are sometimes duplicated, so last write
213 // time and file size are also checked.
215 info1.dwVolumeSerialNumber == info2.dwVolumeSerialNumber
216 && info1.nFileIndexHigh == info2.nFileIndexHigh
217 && info1.nFileIndexLow == info2.nFileIndexLow
218 && info1.nFileSizeHigh == info2.nFileSizeHigh
219 && info1.nFileSizeLow == info2.nFileSizeLow
220 && info1.ftLastWriteTime.dwLowDateTime
221 == info2.ftLastWriteTime.dwLowDateTime
222 && info1.ftLastWriteTime.dwHighDateTime
223 == info2.ftLastWriteTime.dwHighDateTime;
226 int e2 = stat(path2.c_str(), &s2);
227 int e1 = stat(path1.c_str(), &s1);
229 if (e1 != 0 || e2 != 0)
231 // if one is invalid and the other isn't then they aren't equivalent,
232 // but if both are invalid then it is an error.
233 if (e1 != 0 && e2 != 0)
235 GMX_THROW_WITH_ERRNO(
236 FileIOError("Path::isEquivalent called with two invalid files"),
242 // both stats now known to be valid
243 return s1.st_dev == s2.st_dev && s1.st_ino == s2.st_ino
244 // According to the POSIX stat specs, "The st_ino and st_dev fields
245 // taken together uniquely identify the file within the system."
246 // Just to be sure, size and mod time are also checked.
247 && s1.st_size == s2.st_size && s1.st_mtime == s2.st_mtime;
251 std::string Path::join(const std::string &path1,
252 const std::string &path2)
254 // TODO: Remove extra separators if they are present in the input paths.
255 return path1 + cDirSeparator + path2;
259 std::string Path::join(const std::string &path1,
260 const std::string &path2,
261 const std::string &path3)
263 // TODO: Remove extra separators if they are present in the input paths.
264 return path1 + cDirSeparator + path2 + cDirSeparator + path3;
267 std::string Path::getParentPath(const std::string &path)
269 /* Expects that the path doesn't contain "." or "..". If used on a path for
270 * which this isn't guaranteed realpath needs to be called first. */
271 size_t pos = path.find_last_of(cDirSeparators);
272 if (pos == std::string::npos)
274 return std::string();
276 return path.substr(0, pos);
279 std::string Path::getFilename(const std::string &path)
281 size_t pos = path.find_last_of(cDirSeparators);
282 if (pos == std::string::npos)
286 return path.substr(pos+1);
289 bool Path::hasExtension(const std::string &path)
291 return getFilename(path).find('.') != std::string::npos;
294 std::string Path::stripExtension(const std::string &path)
296 size_t dirSeparatorPos = path.find_last_of(cDirSeparators);
297 size_t extPos = path.find_last_of('.');
298 if (extPos == std::string::npos
299 || (dirSeparatorPos != std::string::npos && extPos < dirSeparatorPos))
303 return path.substr(0, extPos);
306 std::string Path::normalize(const std::string &path)
308 std::string result(path);
309 if (DIR_SEPARATOR != '/')
311 std::replace(result.begin(), result.end(), '/', DIR_SEPARATOR);
316 bool Path::exists(const char *path)
318 return gmx_fexist(path);
321 bool Path::exists(const std::string &path)
323 return exists(path.c_str());
326 std::string Path::getWorkingDirectory()
328 // TODO: Use exceptions instead of gmx_fatal().
329 char cwd[GMX_PATH_MAX];
330 gmx_getcwd(cwd, sizeof(cwd));
334 void Path::splitPathEnvironment(const std::string &pathEnv,
335 std::vector<std::string> *result)
341 separator = pathEnv.find(cPathSeparator, prevPos);
342 result->push_back(pathEnv.substr(prevPos, separator - prevPos));
343 prevPos = separator + 1;
345 while (separator != std::string::npos);
348 std::vector<std::string> Path::getExecutablePaths()
350 std::vector<std::string> result;
351 #ifdef GMX_NATIVE_WINDOWS
352 // Add the local dir since it is not in the path on Windows.
353 result.push_back("");
355 const char *path = std::getenv("PATH");
358 splitPathEnvironment(path, &result);
363 std::string Path::resolveSymlinks(const std::string &path)
365 /* Does not fully resolve the path like realpath/boost::canonical would.
366 * It doesn't resolve path elements (including "." or ".."), but only
367 * resolves the entire path (it does that recursively). */
368 std::string result(path);
369 #ifndef GMX_NATIVE_WINDOWS
370 char buf[GMX_PATH_MAX];
372 while ((length = readlink(result.c_str(), buf, sizeof(buf)-1)) > 0)
381 result = join(getParentPath(result), buf);
389 /********************************************************************
393 int Directory::create(const char *path)
395 if (Directory::exists(path))
399 #ifdef GMX_NATIVE_WINDOWS
402 if (mkdir(path, S_IRWXU | S_IRWXG | S_IROTH | S_IWOTH) != 0)
405 // TODO: Proper error handling.
412 int Directory::create(const std::string &path)
414 return create(path.c_str());
418 bool Directory::exists(const char *path)
421 if (stat(path, &info) != 0)
423 if (errno != ENOENT && errno != ENOTDIR)
425 // TODO: Proper error handling.
429 #ifdef GMX_NATIVE_WINDOWS
430 return ((_S_IFDIR & info.st_mode) != 0);
432 return S_ISDIR(info.st_mode);
437 bool Directory::exists(const std::string &path)
439 return exists(path.c_str());