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