2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2011,2012,2013, 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
42 #include "gromacs/utility/path.h"
53 #ifdef GMX_NATIVE_WINDOWS
61 #include "gromacs/fileio/futil.h"
66 //! Directory separator to use when joining paths.
67 const char cDirSeparator = '/';
68 //! Directory separators to use when parsing paths.
69 const char cDirSeparators[] = "/\\";
71 //! Check whether a given character is a directory separator.
72 bool isDirSeparator(char chr)
74 return std::strchr(cDirSeparators, chr);
82 /********************************************************************
86 bool Path::containsDirectory(const std::string &path)
88 return path.find_first_of(cDirSeparators) != std::string::npos;
91 /* Check if the program name begins with "/" on unix/cygwin, or
92 * with "\" or "X:\" on windows. If not, the program name
93 * is relative to the current directory.
95 bool Path::isAbsolute(const char *path)
97 if (isDirSeparator(path[0]))
101 #ifdef GMX_NATIVE_WINDOWS
102 return path[0] != '\0' && path[1] == ':' && isDirSeparator(path[2]);
108 bool Path::isAbsolute(const std::string &path)
110 return isAbsolute(path.c_str());
113 std::string Path::join(const std::string &path1,
114 const std::string &path2)
116 // TODO: Remove extra separators if they are present in the input paths.
117 return path1 + cDirSeparator + path2;
121 std::string Path::join(const std::string &path1,
122 const std::string &path2,
123 const std::string &path3)
125 // TODO: Remove extra separators if they are present in the input paths.
126 return path1 + cDirSeparator + path2 + cDirSeparator + path3;
129 std::pair<std::string, std::string>
130 Path::splitToPathAndFilename(const std::string &path)
132 size_t pos = path.find_last_of(cDirSeparators);
133 if (pos == std::string::npos)
135 return std::make_pair(std::string(), path);
137 return std::make_pair(path.substr(0, pos), path.substr(pos+1));
140 std::string Path::normalize(const std::string &path)
142 std::string result(path);
143 if (DIR_SEPARATOR != '/')
145 std::replace(result.begin(), result.end(), '/', DIR_SEPARATOR);
150 bool Path::exists(const char *path)
152 return gmx_fexist(path);
155 bool Path::exists(const std::string &path)
157 return exists(path.c_str());
160 std::string Path::getWorkingDirectory()
162 // TODO: Use exceptions instead of gmx_fatal().
163 char cwd[GMX_PATH_MAX];
164 gmx_getcwd(cwd, sizeof(cwd));
168 void Path::splitPathEnvironment(const std::string &pathEnv,
169 std::vector<std::string> *result)
175 separator = pathEnv.find_first_of(PATH_SEPARATOR, prevPos);
176 result->push_back(pathEnv.substr(prevPos, separator - prevPos));
177 prevPos = separator + 1;
179 while (separator != std::string::npos);
182 std::vector<std::string> Path::getExecutablePaths()
184 std::vector<std::string> result;
185 #ifdef GMX_NATIVE_WINDOWS
186 // Add the local dir since it is not in the path on Windows.
187 result.push_back("");
189 const char *path = std::getenv("PATH");
192 splitPathEnvironment(path, &result);
197 std::string Path::resolveSymlinks(const std::string &path)
199 std::string result(path);
200 #ifndef GMX_NATIVE_WINDOWS
201 char buf[GMX_PATH_MAX];
203 while ((length = readlink(result.c_str(), buf, sizeof(buf)-1)) > 0)
212 result = join(splitToPathAndFilename(result).first, buf);
220 /********************************************************************
224 int Directory::create(const char *path)
226 if (Directory::exists(path))
230 #ifdef GMX_NATIVE_WINDOWS
233 if (mkdir(path, S_IRWXU | S_IRWXG | S_IROTH | S_IWOTH) != 0)
236 // TODO: Proper error handling.
243 int Directory::create(const std::string &path)
245 return create(path.c_str());
249 bool Directory::exists(const char *path)
252 if (stat(path, &info) != 0)
254 if (errno != ENOENT && errno != ENOTDIR)
256 // TODO: Proper error handling.
260 #ifdef GMX_NATIVE_WINDOWS
261 return ((_S_IFDIR & info.st_mode) != 0);
263 return S_ISDIR(info.st_mode);
268 bool Directory::exists(const std::string &path)
270 return exists(path.c_str());