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
54 #ifdef GMX_NATIVE_WINDOWS
62 #include "gromacs/utility/futil.h"
63 #include "gromacs/utility/stringutil.h"
68 //! Directory separator to use when joining paths.
69 const char cDirSeparator = '/';
70 //! Directory separators to use when parsing paths.
71 const char cDirSeparators[] = "/\\";
72 /*! \var cPathSeparator
74 * Separator to use to split the PATH environment variable.
76 * When reading the PATH environment variable, Unix separates entries
77 * with colon, while windows uses semicolon.
79 #ifdef GMX_NATIVE_WINDOWS
80 const char cPathSeparator = ';';
82 const char cPathSeparator = ':';
85 //! Check whether a given character is a directory separator.
86 bool isDirSeparator(char chr)
88 return std::strchr(cDirSeparators, chr);
96 /********************************************************************
100 bool Path::containsDirectory(const std::string &path)
102 return path.find_first_of(cDirSeparators) != std::string::npos;
105 /* Check if the program name begins with "/" on unix/cygwin, or
106 * with "\" or "X:\" on windows. If not, the program name
107 * is relative to the current directory.
109 bool Path::isAbsolute(const char *path)
111 if (isDirSeparator(path[0]))
115 #ifdef GMX_NATIVE_WINDOWS
116 return path[0] != '\0' && path[1] == ':' && isDirSeparator(path[2]);
122 bool Path::isAbsolute(const std::string &path)
124 return isAbsolute(path.c_str());
127 bool Path::startsWith(const std::string &path, const std::string &prefix)
129 return gmx::startsWith(normalize(path), normalize(prefix));
132 std::string Path::join(const std::string &path1,
133 const std::string &path2)
135 // TODO: Remove extra separators if they are present in the input paths.
136 return path1 + cDirSeparator + path2;
140 std::string Path::join(const std::string &path1,
141 const std::string &path2,
142 const std::string &path3)
144 // TODO: Remove extra separators if they are present in the input paths.
145 return path1 + cDirSeparator + path2 + cDirSeparator + path3;
148 std::string Path::getParentPath(const std::string &path)
150 size_t pos = path.find_last_of(cDirSeparators);
151 if (pos == std::string::npos)
153 return std::string();
155 return path.substr(0, pos);
158 std::string Path::getFilename(const std::string &path)
160 size_t pos = path.find_last_of(cDirSeparators);
161 if (pos == std::string::npos)
165 return path.substr(pos+1);
168 std::string Path::normalize(const std::string &path)
170 std::string result(path);
171 // TODO: Remove . and .. entries.
172 if (DIR_SEPARATOR != '/')
174 std::replace(result.begin(), result.end(), '/', DIR_SEPARATOR);
176 #ifdef GMX_NATIVE_WINDOWS
177 if (std::isalpha(result[0]) && result[1] == ':')
179 result[0] = std::toupper(result[0]);
185 bool Path::exists(const char *path)
187 return gmx_fexist(path);
190 bool Path::exists(const std::string &path)
192 return exists(path.c_str());
195 std::string Path::getWorkingDirectory()
197 // TODO: Use exceptions instead of gmx_fatal().
198 char cwd[GMX_PATH_MAX];
199 gmx_getcwd(cwd, sizeof(cwd));
203 void Path::splitPathEnvironment(const std::string &pathEnv,
204 std::vector<std::string> *result)
210 separator = pathEnv.find(cPathSeparator, prevPos);
211 result->push_back(pathEnv.substr(prevPos, separator - prevPos));
212 prevPos = separator + 1;
214 while (separator != std::string::npos);
217 std::vector<std::string> Path::getExecutablePaths()
219 std::vector<std::string> result;
220 #ifdef GMX_NATIVE_WINDOWS
221 // Add the local dir since it is not in the path on Windows.
222 result.push_back("");
224 const char *path = std::getenv("PATH");
227 splitPathEnvironment(path, &result);
232 std::string Path::resolveSymlinks(const std::string &path)
234 std::string result(path);
235 #ifndef GMX_NATIVE_WINDOWS
236 char buf[GMX_PATH_MAX];
238 while ((length = readlink(result.c_str(), buf, sizeof(buf)-1)) > 0)
247 result = join(getParentPath(result), buf);
255 /********************************************************************
259 int Directory::create(const char *path)
261 if (Directory::exists(path))
265 #ifdef GMX_NATIVE_WINDOWS
268 if (mkdir(path, S_IRWXU | S_IRWXG | S_IROTH | S_IWOTH) != 0)
271 // TODO: Proper error handling.
278 int Directory::create(const std::string &path)
280 return create(path.c_str());
284 bool Directory::exists(const char *path)
287 if (stat(path, &info) != 0)
289 if (errno != ENOENT && errno != ENOTDIR)
291 // TODO: Proper error handling.
295 #ifdef GMX_NATIVE_WINDOWS
296 return ((_S_IFDIR & info.st_mode) != 0);
298 return S_ISDIR(info.st_mode);
303 bool Directory::exists(const std::string &path)
305 return exists(path.c_str());