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,2016,2018, 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         /*! \brief Concatenate \c stringToAdd to \c input, before any
  73          * file extension (if one exists), and return the result.
  74          *
  75          * To be recognized as an extension, an extension-separator
  76          * character must follow the last path-separator character (if
  77          * any). */
  78         static std::string concatenateBeforeExtension(const std::string &input,
  79                                                       const std::string &stringToAdd);
  80
  81         static const char *stripSourcePrefix(const char *path);
  82
  83         static bool exists(const char *path);
  84         static bool exists(const std::string &path);
  85         static std::string getWorkingDirectory();
  86
  87         static void splitPathEnvironment(const std::string        &pathEnv,
  88                                          std::vector<std::string> *result);
  89         static std::vector<std::string> getExecutablePaths();
  90
  91         static std::string resolveSymlinks(const std::string &path);
  92
  93     private:
  94         // Disallow instantiation.
  95         Path();
  96 };
  97
  98 class File
  99 {
 100     public:
 101         struct NotFoundInfo
 102         {
 103             NotFoundInfo(const char *filename, const char *message,
 104                          const char *call, bool wasError, int err)
 105                 : filename(filename), message(message), call(call),
 106                   wasError(wasError), err(err)
 107             {
 108             }
 109
 110             const char *filename;
 111             const char *message;
 112             const char *call;
 113             bool        wasError;
 114             int         err;
 115         };
 116
 117         static void returnFalseOnError(const NotFoundInfo &info);
 118         static void throwOnError(const NotFoundInfo &info);
 119         [[ noreturn ]] static void throwOnNotFound(const NotFoundInfo &info);
 120
 121         typedef void (*NotFoundHandler)(const NotFoundInfo &info);
 122
 123         /*! \brief
 124          * Checks whether a file exists and is a regular file.
 125          *
 126          * \param[in] filename    Path to the file to check.
 127          * \param[in] onNotFound  Function to call when the file does not
 128          *     exists or there is an error accessing it.
 129          * \returns   `true` if \p filename exists and is accessible.
 130          *
 131          * Does not throw, unless onNotFound throws.
 132          */
 133         static bool exists(const char *filename, NotFoundHandler onNotFound);
 134         //! \copydoc exists(const char *, NotFoundHandler)
 135         static bool exists(const std::string &filename,
 136                            NotFoundHandler    onNotFound);
 137
 138     private:
 139         // Disallow instantiation.
 140         File();
 141 };
 142
 143 class Directory
 144 {
 145     public:
 146         static int create(const char *path);
 147         static int create(const std::string &path);
 148         static bool exists(const char *path);
 149         static bool exists(const std::string &path);
 150
 151     private:
 152         // Disallow instantiation.
 153         Directory();
 154 };
 155
 156 } // namespace gmx
 157
 158 #endif