2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2011,2012,2013,2014,2015,2016, 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
59 #if GMX_NATIVE_WINDOWS
68 #include "gromacs/utility/dir_separator.h"
69 #include "gromacs/utility/exceptions.h"
70 #include "gromacs/utility/futil.h"
71 #include "gromacs/utility/stringutil.h"
76 //! Directory separator to use when joining paths.
77 const char cDirSeparator
= '/';
78 //! Directory separators to use when parsing paths.
79 const char cDirSeparators
[] = "/\\";
80 /*! \var cPathSeparator
82 * Separator to use to split the PATH environment variable.
84 * When reading the PATH environment variable, Unix separates entries
85 * with colon, while windows uses semicolon.
87 #if GMX_NATIVE_WINDOWS
88 const char cPathSeparator
= ';';
90 const char cPathSeparator
= ':';
93 //! Check whether a given character is a directory separator.
94 bool isDirSeparator(char chr
)
96 return std::strchr(cDirSeparators
, chr
);
104 /********************************************************************
108 bool Path::containsDirectory(const std::string
&path
)
110 return path
.find_first_of(cDirSeparators
) != std::string::npos
;
113 /* Check if the program name begins with "/" on unix/cygwin, or
114 * with "\" or "X:\" on windows. If not, the program name
115 * is relative to the current directory.
117 bool Path::isAbsolute(const char *path
)
119 if (isDirSeparator(path
[0]))
123 #if GMX_NATIVE_WINDOWS
124 return path
[0] != '\0' && path
[1] == ':' && isDirSeparator(path
[2]);
130 bool Path::isAbsolute(const std::string
&path
)
132 return isAbsolute(path
.c_str());
135 #if GMX_NATIVE_WINDOWS
138 struct handle_wrapper
141 handle_wrapper(HANDLE h
)
145 if (handle
!= INVALID_HANDLE_VALUE
)
147 ::CloseHandle(handle
);
154 bool Path::isEquivalent(const std::string
&path1
, const std::string
&path2
)
156 //based on boost_1_56_0/libs/filesystem/src/operations.cpp under BSL
157 #if GMX_NATIVE_WINDOWS
158 // Note well: Physical location on external media is part of the
159 // equivalence criteria. If there are no open handles, physical location
160 // can change due to defragmentation or other relocations. Thus handles
161 // must be held open until location information for both paths has
164 // p2 is done first, so any error reported is for p1
170 FILE_SHARE_DELETE
| FILE_SHARE_READ
| FILE_SHARE_WRITE
,
173 FILE_FLAG_BACKUP_SEMANTICS
,
180 FILE_SHARE_DELETE
| FILE_SHARE_READ
| FILE_SHARE_WRITE
,
183 FILE_FLAG_BACKUP_SEMANTICS
,
186 if (h1
.handle
== INVALID_HANDLE_VALUE
187 || h2
.handle
== INVALID_HANDLE_VALUE
)
189 // if one is invalid and the other isn't, then they aren't equivalent,
190 // but if both are invalid then it is an error
191 if (h1
.handle
== INVALID_HANDLE_VALUE
192 && h2
.handle
== INVALID_HANDLE_VALUE
)
194 GMX_THROW(FileIOError("Path::isEquivalent called with two invalid files"));
200 // at this point, both handles are known to be valid
202 BY_HANDLE_FILE_INFORMATION info1
, info2
;
204 if (!GetFileInformationByHandle(h1
.handle
, &info1
))
206 GMX_THROW(FileIOError("Path::isEquivalent: GetFileInformationByHandle failed"));
209 if (!GetFileInformationByHandle(h2
.handle
, &info2
))
211 GMX_THROW(FileIOError("Path::isEquivalent: GetFileInformationByHandle failed"));
214 // In theory, volume serial numbers are sufficient to distinguish between
215 // devices, but in practice VSN's are sometimes duplicated, so last write
216 // time and file size are also checked.
218 info1
.dwVolumeSerialNumber
== info2
.dwVolumeSerialNumber
219 && info1
.nFileIndexHigh
== info2
.nFileIndexHigh
220 && info1
.nFileIndexLow
== info2
.nFileIndexLow
221 && info1
.nFileSizeHigh
== info2
.nFileSizeHigh
222 && info1
.nFileSizeLow
== info2
.nFileSizeLow
223 && info1
.ftLastWriteTime
.dwLowDateTime
224 == info2
.ftLastWriteTime
.dwLowDateTime
225 && info1
.ftLastWriteTime
.dwHighDateTime
226 == info2
.ftLastWriteTime
.dwHighDateTime
;
229 int e2
= stat(path2
.c_str(), &s2
);
230 int e1
= stat(path1
.c_str(), &s1
);
232 if (e1
!= 0 || e2
!= 0)
234 // if one is invalid and the other isn't then they aren't equivalent,
235 // but if both are invalid then it is an error.
236 if (e1
!= 0 && e2
!= 0)
238 GMX_THROW_WITH_ERRNO(
239 FileIOError("Path::isEquivalent called with two invalid files"),
245 // both stats now known to be valid
246 return s1
.st_dev
== s2
.st_dev
&& s1
.st_ino
== s2
.st_ino
247 // According to the POSIX stat specs, "The st_ino and st_dev fields
248 // taken together uniquely identify the file within the system."
249 // Just to be sure, size and mod time are also checked.
250 && s1
.st_size
== s2
.st_size
&& s1
.st_mtime
== s2
.st_mtime
;
254 std::string
Path::join(const std::string
&path1
,
255 const std::string
&path2
)
257 // TODO: Remove extra separators if they are present in the input paths.
258 return path1
+ cDirSeparator
+ path2
;
262 std::string
Path::join(const std::string
&path1
,
263 const std::string
&path2
,
264 const std::string
&path3
)
266 // TODO: Remove extra separators if they are present in the input paths.
267 return path1
+ cDirSeparator
+ path2
+ cDirSeparator
+ path3
;
270 std::string
Path::getParentPath(const std::string
&path
)
272 /* Expects that the path doesn't contain "." or "..". If used on a path for
273 * which this isn't guaranteed realpath needs to be called first. */
274 size_t pos
= path
.find_last_of(cDirSeparators
);
275 if (pos
== std::string::npos
)
277 return std::string();
279 return path
.substr(0, pos
);
282 std::string
Path::getFilename(const std::string
&path
)
284 size_t pos
= path
.find_last_of(cDirSeparators
);
285 if (pos
== std::string::npos
)
289 return path
.substr(pos
+1);
292 bool Path::hasExtension(const std::string
&path
)
294 return getFilename(path
).find('.') != std::string::npos
;
297 std::string
Path::stripExtension(const std::string
&path
)
299 size_t dirSeparatorPos
= path
.find_last_of(cDirSeparators
);
300 size_t extPos
= path
.find_last_of('.');
301 if (extPos
== std::string::npos
302 || (dirSeparatorPos
!= std::string::npos
&& extPos
< dirSeparatorPos
))
306 return path
.substr(0, extPos
);
309 std::string
Path::normalize(const std::string
&path
)
311 std::string
result(path
);
312 if (DIR_SEPARATOR
!= '/')
314 std::replace(result
.begin(), result
.end(), '/', DIR_SEPARATOR
);
319 bool Path::exists(const char *path
)
321 return gmx_fexist(path
);
324 bool Path::exists(const std::string
&path
)
326 return exists(path
.c_str());
329 std::string
Path::getWorkingDirectory()
331 // TODO: Use exceptions instead of gmx_fatal().
332 char cwd
[GMX_PATH_MAX
];
333 gmx_getcwd(cwd
, sizeof(cwd
));
337 void Path::splitPathEnvironment(const std::string
&pathEnv
,
338 std::vector
<std::string
> *result
)
344 separator
= pathEnv
.find(cPathSeparator
, prevPos
);
345 result
->push_back(pathEnv
.substr(prevPos
, separator
- prevPos
));
346 prevPos
= separator
+ 1;
348 while (separator
!= std::string::npos
);
351 std::vector
<std::string
> Path::getExecutablePaths()
353 std::vector
<std::string
> result
;
354 #if GMX_NATIVE_WINDOWS
355 // Add the local dir since it is not in the path on Windows.
356 result
.push_back("");
358 const char *path
= std::getenv("PATH");
361 splitPathEnvironment(path
, &result
);
366 std::string
Path::resolveSymlinks(const std::string
&path
)
368 /* Does not fully resolve the path like realpath/boost::canonical would.
369 * It doesn't resolve path elements (including "." or ".."), but only
370 * resolves the entire path (it does that recursively). */
371 std::string
result(path
);
372 #if !GMX_NATIVE_WINDOWS
373 char buf
[GMX_PATH_MAX
];
375 while ((length
= readlink(result
.c_str(), buf
, sizeof(buf
)-1)) > 0)
384 result
= join(getParentPath(result
), buf
);
391 /********************************************************************
395 void File::returnFalseOnError(const NotFoundInfo
& /*info*/)
399 void File::throwOnError(const NotFoundInfo
&info
)
403 const std::string message
404 = formatString("Failed to access file '%s'.\n%s",
405 info
.filename
, info
.message
);
406 GMX_THROW_WITH_ERRNO(FileIOError(message
), info
.call
, info
.err
);
410 void File::throwOnNotFound(const NotFoundInfo
&info
)
413 const std::string message
414 = formatString("File '%s' does not exist or is not accessible.\n%s",
415 info
.filename
, info
.message
);
416 GMX_THROW_WITH_ERRNO(InvalidInputError(message
), info
.call
, info
.err
);
420 bool File::exists(const char *filename
, NotFoundHandler onNotFound
)
422 if (filename
== NULL
)
426 FILE *test
= std::fopen(filename
, "r");
429 const bool wasError
= (errno
!= ENOENT
&& errno
!= ENOTDIR
);
430 NotFoundInfo
info(filename
, "The file could not be opened.",
431 "fopen", wasError
, errno
);
438 // Windows doesn't allow fopen of directory, so we don't need to check
440 #if !GMX_NATIVE_WINDOWS
442 int status
= stat(filename
, &st_buf
);
445 NotFoundInfo
info(filename
, "File information could not be read.",
446 "stat", true, errno
);
450 if (!S_ISREG(st_buf
.st_mode
))
452 NotFoundInfo
info(filename
, "The file is not a regular file.",
463 bool File::exists(const std::string
&filename
, NotFoundHandler onNotFound
)
465 return exists(filename
.c_str(), onNotFound
);
468 /********************************************************************
472 int Directory::create(const char *path
)
474 if (Directory::exists(path
))
478 #if GMX_NATIVE_WINDOWS
481 if (mkdir(path
, S_IRWXU
| S_IRWXG
| S_IROTH
| S_IWOTH
) != 0)
484 // TODO: Proper error handling.
491 int Directory::create(const std::string
&path
)
493 return create(path
.c_str());
497 bool Directory::exists(const char *path
)
500 if (stat(path
, &info
) != 0)
502 if (errno
!= ENOENT
&& errno
!= ENOTDIR
)
504 // TODO: Proper error handling.
508 #if GMX_NATIVE_WINDOWS
509 return ((_S_IFDIR
& info
.st_mode
) != 0);
511 return S_ISDIR(info
.st_mode
);
516 bool Directory::exists(const std::string
&path
)
518 return exists(path
.c_str());