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
56 #ifdef GMX_NATIVE_WINDOWS
64 #include "gromacs/utility/futil.h"
65 #include "gromacs/utility/stringutil.h"
70 //! Directory separator to use when joining paths.
71 const char cDirSeparator = '/';
72 //! Directory separators to use when parsing paths.
73 const char cDirSeparators[] = "/\\";
74 /*! \var cPathSeparator
76 * Separator to use to split the PATH environment variable.
78 * When reading the PATH environment variable, Unix separates entries
79 * with colon, while windows uses semicolon.
81 #ifdef GMX_NATIVE_WINDOWS
82 const char cPathSeparator = ';';
84 const char cPathSeparator = ':';
87 //! Check whether a given character is a directory separator.
88 bool isDirSeparator(char chr)
90 return std::strchr(cDirSeparators, chr);
98 /********************************************************************
102 bool Path::containsDirectory(const std::string &path)
104 return path.find_first_of(cDirSeparators) != std::string::npos;
107 /* Check if the program name begins with "/" on unix/cygwin, or
108 * with "\" or "X:\" on windows. If not, the program name
109 * is relative to the current directory.
111 bool Path::isAbsolute(const char *path)
113 if (isDirSeparator(path[0]))
117 #ifdef GMX_NATIVE_WINDOWS
118 return path[0] != '\0' && path[1] == ':' && isDirSeparator(path[2]);
124 bool Path::isAbsolute(const std::string &path)
126 return isAbsolute(path.c_str());
129 bool Path::startsWith(const std::string &path, const std::string &prefix)
131 return gmx::startsWith(normalize(path), normalize(prefix));
134 std::string Path::join(const std::string &path1,
135 const std::string &path2)
137 // TODO: Remove extra separators if they are present in the input paths.
138 return path1 + cDirSeparator + path2;
142 std::string Path::join(const std::string &path1,
143 const std::string &path2,
144 const std::string &path3)
146 // TODO: Remove extra separators if they are present in the input paths.
147 return path1 + cDirSeparator + path2 + cDirSeparator + path3;
150 std::string Path::getParentPath(const std::string &path)
152 size_t pos = path.find_last_of(cDirSeparators);
153 if (pos == std::string::npos)
155 return std::string();
157 return path.substr(0, pos);
160 std::string Path::getFilename(const std::string &path)
162 size_t pos = path.find_last_of(cDirSeparators);
163 if (pos == std::string::npos)
167 return path.substr(pos+1);
170 std::string Path::stripExtension(const std::string &path)
172 size_t dirSeparatorPos = path.find_last_of(cDirSeparators);
173 size_t extPos = path.find_last_of('.');
174 if (extPos == std::string::npos
175 || (dirSeparatorPos != std::string::npos && extPos < dirSeparatorPos))
179 return path.substr(0, extPos);
182 std::string Path::normalize(const std::string &path)
184 std::string result(path);
185 // TODO: Remove . and .. entries.
186 if (DIR_SEPARATOR != '/')
188 std::replace(result.begin(), result.end(), '/', DIR_SEPARATOR);
190 #ifdef GMX_NATIVE_WINDOWS
191 if (std::isalpha(result[0]) && result[1] == ':')
193 result[0] = std::toupper(result[0]);
199 bool Path::exists(const char *path)
201 return gmx_fexist(path);
204 bool Path::exists(const std::string &path)
206 return exists(path.c_str());
209 std::string Path::getWorkingDirectory()
211 // TODO: Use exceptions instead of gmx_fatal().
212 char cwd[GMX_PATH_MAX];
213 gmx_getcwd(cwd, sizeof(cwd));
217 void Path::splitPathEnvironment(const std::string &pathEnv,
218 std::vector<std::string> *result)
224 separator = pathEnv.find(cPathSeparator, prevPos);
225 result->push_back(pathEnv.substr(prevPos, separator - prevPos));
226 prevPos = separator + 1;
228 while (separator != std::string::npos);
231 std::vector<std::string> Path::getExecutablePaths()
233 std::vector<std::string> result;
234 #ifdef GMX_NATIVE_WINDOWS
235 // Add the local dir since it is not in the path on Windows.
236 result.push_back("");
238 const char *path = std::getenv("PATH");
241 splitPathEnvironment(path, &result);
246 std::string Path::resolveSymlinks(const std::string &path)
248 std::string result(path);
249 #ifndef GMX_NATIVE_WINDOWS
250 char buf[GMX_PATH_MAX];
252 while ((length = readlink(result.c_str(), buf, sizeof(buf)-1)) > 0)
261 result = join(getParentPath(result), buf);
269 /********************************************************************
273 int Directory::create(const char *path)
275 if (Directory::exists(path))
279 #ifdef GMX_NATIVE_WINDOWS
282 if (mkdir(path, S_IRWXU | S_IRWXG | S_IROTH | S_IWOTH) != 0)
285 // TODO: Proper error handling.
292 int Directory::create(const std::string &path)
294 return create(path.c_str());
298 bool Directory::exists(const char *path)
301 if (stat(path, &info) != 0)
303 if (errno != ENOENT && errno != ENOTDIR)
305 // TODO: Proper error handling.
309 #ifdef GMX_NATIVE_WINDOWS
310 return ((_S_IFDIR & info.st_mode) != 0);
312 return S_ISDIR(info.st_mode);
317 bool Directory::exists(const std::string &path)
319 return exists(path.c_str());