src/gromacs/utility/path.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
   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 "gromacs/utility/path.h"
  43
  44 #include <cerrno>
  45 #include <cstdlib>
  46 #include <cstring>
  47
  48 #include <algorithm>
  49
  50 #include "config.h"
  51
  52 #include <sys/stat.h>
  53 #ifdef GMX_NATIVE_WINDOWS
  54 #include <direct.h>
  55 #else
  56 #ifdef HAVE_UNISTD_H
  57 #include <unistd.h>
  58 #endif
  59 #endif
  60
  61 #include "gromacs/fileio/futil.h"
  62
  63 namespace
  64 {
  65
  66 //! Directory separator to use when joining paths.
  67 const char cDirSeparator = '/';
  68 //! Directory separators to use when parsing paths.
  69 const char cDirSeparators[] = "/\\";
  70
  71 //! Check whether a given character is a directory separator.
  72 bool isDirSeparator(char chr)
  73 {
  74     return std::strchr(cDirSeparators, chr);
  75 }
  76
  77 } // namespace
  78
  79 namespace gmx
  80 {
  81
  82 /********************************************************************
  83  * Path
  84  */
  85
  86 bool Path::containsDirectory(const std::string &path)
  87 {
  88     return path.find_first_of(cDirSeparators) != std::string::npos;
  89 }
  90
  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.
  94  */
  95 bool Path::isAbsolute(const char *path)
  96 {
  97     if (isDirSeparator(path[0]))
  98     {
  99         return true;
 100     }
 101 #ifdef GMX_NATIVE_WINDOWS
 102     return path[0] != '\0' && path[1] == ':' && isDirSeparator(path[2]);
 103 #else
 104     return false;
 105 #endif
 106 }
 107
 108 bool Path::isAbsolute(const std::string &path)
 109 {
 110     return isAbsolute(path.c_str());
 111 }
 112
 113 std::string Path::join(const std::string &path1,
 114                        const std::string &path2)
 115 {
 116     // TODO: Remove extra separators if they are present in the input paths.
 117     return path1 + cDirSeparator + path2;
 118 }
 119
 120
 121 std::string Path::join(const std::string &path1,
 122                        const std::string &path2,
 123                        const std::string &path3)
 124 {
 125     // TODO: Remove extra separators if they are present in the input paths.
 126     return path1 + cDirSeparator + path2 + cDirSeparator + path3;
 127 }
 128
 129 std::pair<std::string, std::string>
 130 Path::splitToPathAndFilename(const std::string &path)
 131 {
 132     size_t pos = path.find_last_of(cDirSeparators);
 133     if (pos == std::string::npos)
 134     {
 135         return std::make_pair(std::string(), path);
 136     }
 137     return std::make_pair(path.substr(0, pos), path.substr(pos+1));
 138 }
 139
 140 std::string Path::normalize(const std::string &path)
 141 {
 142     std::string result(path);
 143     if (DIR_SEPARATOR != '/')
 144     {
 145         std::replace(result.begin(), result.end(), '/', DIR_SEPARATOR);
 146     }
 147     return result;
 148 }
 149
 150 bool Path::exists(const char *path)
 151 {
 152     return gmx_fexist(path);
 153 }
 154
 155 bool Path::exists(const std::string &path)
 156 {
 157     return exists(path.c_str());
 158 }
 159
 160 std::string Path::getWorkingDirectory()
 161 {
 162     // TODO: Use exceptions instead of gmx_fatal().
 163     char cwd[GMX_PATH_MAX];
 164     gmx_getcwd(cwd, sizeof(cwd));
 165     return cwd;
 166 }
 167
 168 void Path::splitPathEnvironment(const std::string        &pathEnv,
 169                                 std::vector<std::string> *result)
 170 {
 171     size_t                   prevPos = 0;
 172     size_t                   separator;
 173     do
 174     {
 175         separator = pathEnv.find_first_of(PATH_SEPARATOR, prevPos);
 176         result->push_back(pathEnv.substr(prevPos, separator - prevPos));
 177         prevPos = separator + 1;
 178     }
 179     while (separator != std::string::npos);
 180 }
 181
 182 std::vector<std::string> Path::getExecutablePaths()
 183 {
 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("");
 188 #endif
 189     const char *path = std::getenv("PATH");
 190     if (path != NULL)
 191     {
 192         splitPathEnvironment(path, &result);
 193     }
 194     return result;
 195 }
 196
 197 std::string Path::resolveSymlinks(const std::string &path)
 198 {
 199     std::string result(path);
 200 #ifndef GMX_NATIVE_WINDOWS
 201     char        buf[GMX_PATH_MAX];
 202     int         length;
 203     while ((length = readlink(result.c_str(), buf, sizeof(buf)-1)) > 0)
 204     {
 205         buf[length] = '\0';
 206         if (isAbsolute(buf))
 207         {
 208             result = buf;
 209         }
 210         else
 211         {
 212             result = join(splitToPathAndFilename(result).first, buf);
 213         }
 214     }
 215 #endif
 216     return result;
 217 }
 218
 219
 220 /********************************************************************
 221  * Directory
 222  */
 223
 224 int Directory::create(const char *path)
 225 {
 226     if (Directory::exists(path))
 227     {
 228         return 0;
 229     }
 230 #ifdef GMX_NATIVE_WINDOWS
 231     if (_mkdir(path))
 232 #else
 233     if (mkdir(path, S_IRWXU | S_IRWXG | S_IROTH | S_IWOTH) != 0)
 234 #endif
 235     {
 236         // TODO: Proper error handling.
 237         return -1;
 238     }
 239     return 0;
 240 }
 241
 242
 243 int Directory::create(const std::string &path)
 244 {
 245     return create(path.c_str());
 246 }
 247
 248
 249 bool Directory::exists(const char *path)
 250 {
 251     struct stat info;
 252     if (stat(path, &info) != 0)
 253     {
 254         if (errno != ENOENT && errno != ENOTDIR)
 255         {
 256             // TODO: Proper error handling.
 257         }
 258         return false;
 259     }
 260 #ifdef GMX_NATIVE_WINDOWS
 261     return ((_S_IFDIR & info.st_mode) != 0);
 262 #else
 263     return S_ISDIR(info.st_mode);
 264 #endif
 265 }
 266
 267
 268 bool Directory::exists(const std::string &path)
 269 {
 270     return exists(path.c_str());
 271 }
 272
 273 } // namespace gmx