src/gromacs/utility/path.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2011,2012,2013,2014,2015, 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 /*! \libinternal \file
  36  * \brief
  37  * Declares functions for OS-independent path handling.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_PATH_H
  44 #define GMX_UTILITY_PATH_H
  45
  46 #include <string>
  47 #include <utility>
  48 #include <vector>
  49
  50 namespace gmx
  51 {
  52
  53 class Path
  54 {
  55     public:
  56         static bool containsDirectory(const std::string &path);
  57         static bool isAbsolute(const char *path);
  58         static bool isAbsolute(const std::string &path);
  59         static bool isEquivalent(const std::string &path1,
  60                                  const std::string &path2);
  61
  62         static std::string join(const std::string &path1,
  63                                 const std::string &path2);
  64         static std::string join(const std::string &path1,
  65                                 const std::string &path2,
  66                                 const std::string &path3);
  67         static std::string normalize(const std::string &path);
  68         static std::string getParentPath(const std::string &path);
  69         static std::string getFilename(const std::string &path);
  70         static bool hasExtension(const std::string &path);
  71         static std::string stripExtension(const std::string &path);
  72
  73         static bool exists(const char *path);
  74         static bool exists(const std::string &path);
  75         static std::string getWorkingDirectory();
  76
  77         static void splitPathEnvironment(const std::string        &pathEnv,
  78                                          std::vector<std::string> *result);
  79         static std::vector<std::string> getExecutablePaths();
  80
  81         static std::string resolveSymlinks(const std::string &path);
  82
  83     private:
  84         // Disallow instantiation.
  85         Path();
  86 };
  87
  88
  89 class Directory
  90 {
  91     public:
  92         static int create(const char *path);
  93         static int create(const std::string &path);
  94         static bool exists(const char *path);
  95         static bool exists(const std::string &path);
  96
  97     private:
  98         // Disallow instantiation.
  99         Directory();
 100 };
 101
 102 } // namespace gmx
 103
 104 #endif