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