src/gromacs/utility/path.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements functions in path.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "path.h"
  45
  46 #include <cctype>
  47 #include <cerrno>
  48 #include <cstdlib>
  49 #include <cstring>
  50
  51 #include <algorithm>
  52
  53 #include <sys/stat.h>
  54
  55 #include "config.h"
  56
  57 #ifdef GMX_NATIVE_WINDOWS
  58 #include <direct.h>
  59 #else
  60 #ifdef HAVE_UNISTD_H
  61 #include <unistd.h>
  62 #endif
  63 #endif
  64
  65 #include "gromacs/utility/futil.h"
  66 #include "gromacs/utility/stringutil.h"
  67
  68 namespace
  69 {
  70
  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
  76  * \brief
  77  * Separator to use to split the PATH environment variable.
  78  *
  79  * When reading the PATH environment variable, Unix separates entries
  80  * with colon, while windows uses semicolon.
  81  */
  82 #ifdef GMX_NATIVE_WINDOWS
  83 const char cPathSeparator = ';';
  84 #else
  85 const char cPathSeparator = ':';
  86 #endif
  87
  88 //! Check whether a given character is a directory separator.
  89 bool isDirSeparator(char chr)
  90 {
  91     return std::strchr(cDirSeparators, chr);
  92 }
  93
  94 } // namespace
  95
  96 namespace gmx
  97 {
  98
  99 /********************************************************************
 100  * Path
 101  */
 102
 103 bool Path::containsDirectory(const std::string &path)
 104 {
 105     return path.find_first_of(cDirSeparators) != std::string::npos;
 106 }
 107
 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.
 111  */
 112 bool Path::isAbsolute(const char *path)
 113 {
 114     if (isDirSeparator(path[0]))
 115     {
 116         return true;
 117     }
 118 #ifdef GMX_NATIVE_WINDOWS
 119     return path[0] != '\0' && path[1] == ':' && isDirSeparator(path[2]);
 120 #else
 121     return false;
 122 #endif
 123 }
 124
 125 bool Path::isAbsolute(const std::string &path)
 126 {
 127     return isAbsolute(path.c_str());
 128 }
 129
 130 bool Path::startsWith(const std::string &path, const std::string &prefix)
 131 {
 132     return gmx::startsWith(normalize(path), normalize(prefix));
 133 }
 134
 135 std::string Path::join(const std::string &path1,
 136                        const std::string &path2)
 137 {
 138     // TODO: Remove extra separators if they are present in the input paths.
 139     return path1 + cDirSeparator + path2;
 140 }
 141
 142
 143 std::string Path::join(const std::string &path1,
 144                        const std::string &path2,
 145                        const std::string &path3)
 146 {
 147     // TODO: Remove extra separators if they are present in the input paths.
 148     return path1 + cDirSeparator + path2 + cDirSeparator + path3;
 149 }
 150
 151 std::string Path::getParentPath(const std::string &path)
 152 {
 153     size_t pos = path.find_last_of(cDirSeparators);
 154     if (pos == std::string::npos)
 155     {
 156         return std::string();
 157     }
 158     return path.substr(0, pos);
 159 }
 160
 161 std::string Path::getFilename(const std::string &path)
 162 {
 163     size_t pos = path.find_last_of(cDirSeparators);
 164     if (pos == std::string::npos)
 165     {
 166         return path;
 167     }
 168     return path.substr(pos+1);
 169 }
 170
 171 std::string Path::stripExtension(const std::string &path)
 172 {
 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))
 177     {
 178         return path;
 179     }
 180     return path.substr(0, extPos);
 181 }
 182
 183 std::string Path::normalize(const std::string &path)
 184 {
 185     std::string result(path);
 186     // TODO: Remove . and .. entries.
 187     if (DIR_SEPARATOR != '/')
 188     {
 189         std::replace(result.begin(), result.end(), '/', DIR_SEPARATOR);
 190     }
 191 #ifdef GMX_NATIVE_WINDOWS
 192     if (std::isalpha(result[0]) && result[1] == ':')
 193     {
 194         result[0] = std::toupper(result[0]);
 195     }
 196 #endif
 197     return result;
 198 }
 199
 200 bool Path::exists(const char *path)
 201 {
 202     return gmx_fexist(path);
 203 }
 204
 205 bool Path::exists(const std::string &path)
 206 {
 207     return exists(path.c_str());
 208 }
 209
 210 std::string Path::getWorkingDirectory()
 211 {
 212     // TODO: Use exceptions instead of gmx_fatal().
 213     char cwd[GMX_PATH_MAX];
 214     gmx_getcwd(cwd, sizeof(cwd));
 215     return cwd;
 216 }
 217
 218 void Path::splitPathEnvironment(const std::string        &pathEnv,
 219                                 std::vector<std::string> *result)
 220 {
 221     size_t prevPos = 0;
 222     size_t separator;
 223     do
 224     {
 225         separator = pathEnv.find(cPathSeparator, prevPos);
 226         result->push_back(pathEnv.substr(prevPos, separator - prevPos));
 227         prevPos = separator + 1;
 228     }
 229     while (separator != std::string::npos);
 230 }
 231
 232 std::vector<std::string> Path::getExecutablePaths()
 233 {
 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("");
 238 #endif
 239     const char *path = std::getenv("PATH");
 240     if (path != NULL)
 241     {
 242         splitPathEnvironment(path, &result);
 243     }
 244     return result;
 245 }
 246
 247 std::string Path::resolveSymlinks(const std::string &path)
 248 {
 249     std::string result(path);
 250 #ifndef GMX_NATIVE_WINDOWS
 251     char        buf[GMX_PATH_MAX];
 252     int         length;
 253     while ((length = readlink(result.c_str(), buf, sizeof(buf)-1)) > 0)
 254     {
 255         buf[length] = '\0';
 256         if (isAbsolute(buf))
 257         {
 258             result = buf;
 259         }
 260         else
 261         {
 262             result = join(getParentPath(result), buf);
 263         }
 264     }
 265 #endif
 266     return result;
 267 }
 268
 269
 270 /********************************************************************
 271  * Directory
 272  */
 273
 274 int Directory::create(const char *path)
 275 {
 276     if (Directory::exists(path))
 277     {
 278         return 0;
 279     }
 280 #ifdef GMX_NATIVE_WINDOWS
 281     if (_mkdir(path))
 282 #else
 283     if (mkdir(path, S_IRWXU | S_IRWXG | S_IROTH | S_IWOTH) != 0)
 284 #endif
 285     {
 286         // TODO: Proper error handling.
 287         return -1;
 288     }
 289     return 0;
 290 }
 291
 292
 293 int Directory::create(const std::string &path)
 294 {
 295     return create(path.c_str());
 296 }
 297
 298
 299 bool Directory::exists(const char *path)
 300 {
 301     struct stat info;
 302     if (stat(path, &info) != 0)
 303     {
 304         if (errno != ENOENT && errno != ENOTDIR)
 305         {
 306             // TODO: Proper error handling.
 307         }
 308         return false;
 309     }
 310 #ifdef GMX_NATIVE_WINDOWS
 311     return ((_S_IFDIR & info.st_mode) != 0);
 312 #else
 313     return S_ISDIR(info.st_mode);
 314 #endif
 315 }
 316
 317
 318 bool Directory::exists(const std::string &path)
 319 {
 320     return exists(path.c_str());
 321 }
 322
 323 } // namespace gmx