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 "config.h"
  47
  48 #include <cctype>
  49 #include <cerrno>
  50 #include <cstdlib>
  51 #include <cstring>
  52
  53 #include <algorithm>
  54
  55 #include <sys/stat.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 bool Path::hasExtension(const std::string &path)
 172 {
 173     return getFilename(path).find('.') != std::string::npos;
 174 }
 175
 176 std::string Path::stripExtension(const std::string &path)
 177 {
 178     size_t dirSeparatorPos = path.find_last_of(cDirSeparators);
 179     size_t extPos          = path.find_last_of('.');
 180     if (extPos == std::string::npos
 181         || (dirSeparatorPos != std::string::npos && extPos < dirSeparatorPos))
 182     {
 183         return path;
 184     }
 185     return path.substr(0, extPos);
 186 }
 187
 188 std::string Path::normalize(const std::string &path)
 189 {
 190     std::string result(path);
 191     // TODO: Remove . and .. entries.
 192     if (DIR_SEPARATOR != '/')
 193     {
 194         std::replace(result.begin(), result.end(), '/', DIR_SEPARATOR);
 195     }
 196 #ifdef GMX_NATIVE_WINDOWS
 197     if (std::isalpha(result[0]) && result[1] == ':')
 198     {
 199         result[0] = std::toupper(result[0]);
 200     }
 201 #endif
 202     return result;
 203 }
 204
 205 bool Path::exists(const char *path)
 206 {
 207     return gmx_fexist(path);
 208 }
 209
 210 bool Path::exists(const std::string &path)
 211 {
 212     return exists(path.c_str());
 213 }
 214
 215 std::string Path::getWorkingDirectory()
 216 {
 217     // TODO: Use exceptions instead of gmx_fatal().
 218     char cwd[GMX_PATH_MAX];
 219     gmx_getcwd(cwd, sizeof(cwd));
 220     return cwd;
 221 }
 222
 223 void Path::splitPathEnvironment(const std::string        &pathEnv,
 224                                 std::vector<std::string> *result)
 225 {
 226     size_t prevPos = 0;
 227     size_t separator;
 228     do
 229     {
 230         separator = pathEnv.find(cPathSeparator, prevPos);
 231         result->push_back(pathEnv.substr(prevPos, separator - prevPos));
 232         prevPos = separator + 1;
 233     }
 234     while (separator != std::string::npos);
 235 }
 236
 237 std::vector<std::string> Path::getExecutablePaths()
 238 {
 239     std::vector<std::string> result;
 240 #ifdef GMX_NATIVE_WINDOWS
 241     // Add the local dir since it is not in the path on Windows.
 242     result.push_back("");
 243 #endif
 244     const char *path = std::getenv("PATH");
 245     if (path != NULL)
 246     {
 247         splitPathEnvironment(path, &result);
 248     }
 249     return result;
 250 }
 251
 252 std::string Path::resolveSymlinks(const std::string &path)
 253 {
 254     std::string result(path);
 255 #ifndef GMX_NATIVE_WINDOWS
 256     char        buf[GMX_PATH_MAX];
 257     int         length;
 258     while ((length = readlink(result.c_str(), buf, sizeof(buf)-1)) > 0)
 259     {
 260         buf[length] = '\0';
 261         if (isAbsolute(buf))
 262         {
 263             result = buf;
 264         }
 265         else
 266         {
 267             result = join(getParentPath(result), buf);
 268         }
 269     }
 270 #endif
 271     return result;
 272 }
 273
 274
 275 /********************************************************************
 276  * Directory
 277  */
 278
 279 int Directory::create(const char *path)
 280 {
 281     if (Directory::exists(path))
 282     {
 283         return 0;
 284     }
 285 #ifdef GMX_NATIVE_WINDOWS
 286     if (_mkdir(path))
 287 #else
 288     if (mkdir(path, S_IRWXU | S_IRWXG | S_IROTH | S_IWOTH) != 0)
 289 #endif
 290     {
 291         // TODO: Proper error handling.
 292         return -1;
 293     }
 294     return 0;
 295 }
 296
 297
 298 int Directory::create(const std::string &path)
 299 {
 300     return create(path.c_str());
 301 }
 302
 303
 304 bool Directory::exists(const char *path)
 305 {
 306     struct stat info;
 307     if (stat(path, &info) != 0)
 308     {
 309         if (errno != ENOENT && errno != ENOTDIR)
 310         {
 311             // TODO: Proper error handling.
 312         }
 313         return false;
 314     }
 315 #ifdef GMX_NATIVE_WINDOWS
 316     return ((_S_IFDIR & info.st_mode) != 0);
 317 #else
 318     return S_ISDIR(info.st_mode);
 319 #endif
 320 }
 321
 322
 323 bool Directory::exists(const std::string &path)
 324 {
 325     return exists(path.c_str());
 326 }
 327
 328 } // namespace gmx