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
65 #include "gromacs/utility/futil.h"
66 #include "gromacs/utility/stringutil.h"
71 //! Directory separator to use when joining paths.
72 const char cDirSeparator = '/';
73 //! Directory separators to use when parsing paths.
74 const char cDirSeparators[] = "/\\";
75 /*! \var cPathSeparator
77 * Separator to use to split the PATH environment variable.
79 * When reading the PATH environment variable, Unix separates entries
80 * with colon, while windows uses semicolon.
82 #ifdef GMX_NATIVE_WINDOWS
83 const char cPathSeparator = ';';
85 const char cPathSeparator = ':';
88 //! Check whether a given character is a directory separator.
89 bool isDirSeparator(char chr)
91 return std::strchr(cDirSeparators, chr);
99 /********************************************************************
103 bool Path::containsDirectory(const std::string &path)
105 return path.find_first_of(cDirSeparators) != std::string::npos;
108 /* Check if the program name begins with "/" on unix/cygwin, or
109 * with "\" or "X:\" on windows. If not, the program name
110 * is relative to the current directory.
112 bool Path::isAbsolute(const char *path)
114 if (isDirSeparator(path[0]))
118 #ifdef GMX_NATIVE_WINDOWS
119 return path[0] != '\0' && path[1] == ':' && isDirSeparator(path[2]);
125 bool Path::isAbsolute(const std::string &path)
127 return isAbsolute(path.c_str());
130 bool Path::startsWith(const std::string &path, const std::string &prefix)
132 return gmx::startsWith(normalize(path), normalize(prefix));
135 std::string Path::join(const std::string &path1,
136 const std::string &path2)
138 // TODO: Remove extra separators if they are present in the input paths.
139 return path1 + cDirSeparator + path2;
143 std::string Path::join(const std::string &path1,
144 const std::string &path2,
145 const std::string &path3)
147 // TODO: Remove extra separators if they are present in the input paths.
148 return path1 + cDirSeparator + path2 + cDirSeparator + path3;
151 std::string Path::getParentPath(const std::string &path)
153 size_t pos = path.find_last_of(cDirSeparators);
154 if (pos == std::string::npos)
156 return std::string();
158 return path.substr(0, pos);
161 std::string Path::getFilename(const std::string &path)
163 size_t pos = path.find_last_of(cDirSeparators);
164 if (pos == std::string::npos)
168 return path.substr(pos+1);
171 std::string Path::stripExtension(const std::string &path)
173 size_t dirSeparatorPos = path.find_last_of(cDirSeparators);
174 size_t extPos = path.find_last_of('.');
175 if (extPos == std::string::npos
176 || (dirSeparatorPos != std::string::npos && extPos < dirSeparatorPos))
180 return path.substr(0, extPos);
183 std::string Path::normalize(const std::string &path)
185 std::string result(path);
186 // TODO: Remove . and .. entries.
187 if (DIR_SEPARATOR != '/')
189 std::replace(result.begin(), result.end(), '/', DIR_SEPARATOR);
191 #ifdef GMX_NATIVE_WINDOWS
192 if (std::isalpha(result[0]) && result[1] == ':')
194 result[0] = std::toupper(result[0]);
200 bool Path::exists(const char *path)
202 return gmx_fexist(path);
205 bool Path::exists(const std::string &path)
207 return exists(path.c_str());
210 std::string Path::getWorkingDirectory()
212 // TODO: Use exceptions instead of gmx_fatal().
213 char cwd[GMX_PATH_MAX];
214 gmx_getcwd(cwd, sizeof(cwd));
218 void Path::splitPathEnvironment(const std::string &pathEnv,
219 std::vector<std::string> *result)
225 separator = pathEnv.find(cPathSeparator, prevPos);
226 result->push_back(pathEnv.substr(prevPos, separator - prevPos));
227 prevPos = separator + 1;
229 while (separator != std::string::npos);
232 std::vector<std::string> Path::getExecutablePaths()
234 std::vector<std::string> result;
235 #ifdef GMX_NATIVE_WINDOWS
236 // Add the local dir since it is not in the path on Windows.
237 result.push_back("");
239 const char *path = std::getenv("PATH");
242 splitPathEnvironment(path, &result);
247 std::string Path::resolveSymlinks(const std::string &path)
249 std::string result(path);
250 #ifndef GMX_NATIVE_WINDOWS
251 char buf[GMX_PATH_MAX];
253 while ((length = readlink(result.c_str(), buf, sizeof(buf)-1)) > 0)
262 result = join(getParentPath(result), buf);
270 /********************************************************************
274 int Directory::create(const char *path)
276 if (Directory::exists(path))
280 #ifdef GMX_NATIVE_WINDOWS
283 if (mkdir(path, S_IRWXU | S_IRWXG | S_IROTH | S_IWOTH) != 0)
286 // TODO: Proper error handling.
293 int Directory::create(const std::string &path)
295 return create(path.c_str());
299 bool Directory::exists(const char *path)
302 if (stat(path, &info) != 0)
304 if (errno != ENOENT && errno != ENOTDIR)
306 // TODO: Proper error handling.
310 #ifdef GMX_NATIVE_WINDOWS
311 return ((_S_IFDIR & info.st_mode) != 0);
313 return S_ISDIR(info.st_mode);
318 bool Directory::exists(const std::string &path)
320 return exists(path.c_str());