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,2019, 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 #include "gromacs/compat/string_view.h"
  51
  52 namespace gmx
  53 {
  54
  55 class Path
  56 {
  57     public:
  58         static bool containsDirectory(const std::string &path);
  59         static bool isAbsolute(const char *path);
  60         static bool isAbsolute(const std::string &path);
  61         static bool isEquivalent(const std::string &path1,
  62                                  const std::string &path2);
  63
  64         static std::string join(const std::string &path1,
  65                                 const std::string &path2);
  66         static std::string join(const std::string &path1,
  67                                 const std::string &path2,
  68                                 const std::string &path3);
  69         //! Return a path using directory separators that suit the execution OS.
  70         static std::string normalize(const std::string &path);
  71         /*! \brief Returns a copy of the parent path (ie. directory
  72          * components) of \c input ie. up to but excluding the last
  73          * directory separator (if one exists).
  74          *
  75          * \returns A copy of the parent path-components, or empty if
  76          * no directory separator exists. */
  77         static std::string getParentPath(const std::string &input);
  78         /*! \brief Returns a copy of the filename in \c input
  79          * ie. after the last directory separator (if one exists). */
  80         static std::string getFilename(const std::string &input);
  81         //! Returns whether an extension is present in \c input.
  82         static bool hasExtension(const std::string &input);
  83         /*! \brief Returns whether the extension present in \c input
  84          * matches \c extension (which does not include the separator
  85          * character). */
  86         static bool extensionMatches(compat::string_view input,
  87                                      compat::string_view extension);
  88         /*! \brief Returns a copy of the input without any trailing
  89          * extension found in the filename component. */
  90         static std::string stripExtension(const std::string &input);
  91         /*! \brief Concatenate \c stringToAdd to a copy of \c input,
  92          * before any file extension (if one exists), and return the
  93          * result. */
  94         static std::string concatenateBeforeExtension(const std::string &input,
  95                                                       const std::string &stringToAdd);
  96
  97         static const char *stripSourcePrefix(const char *path);
  98
  99         static bool exists(const char *path);
 100         static bool exists(const std::string &path);
 101         static std::string getWorkingDirectory();
 102
 103         static void splitPathEnvironment(const std::string        &pathEnv,
 104                                          std::vector<std::string> *result);
 105         static std::vector<std::string> getExecutablePaths();
 106
 107         static std::string resolveSymlinks(const std::string &path);
 108
 109     private:
 110         // Disallow instantiation.
 111         Path();
 112 };
 113
 114 class File
 115 {
 116     public:
 117         struct NotFoundInfo
 118         {
 119             NotFoundInfo(const char *filename, const char *message,
 120                          const char *call, bool wasError, int err)
 121                 : filename(filename), message(message), call(call),
 122                   wasError(wasError), err(err)
 123             {
 124             }
 125
 126             const char *filename;
 127             const char *message;
 128             const char *call;
 129             bool        wasError;
 130             int         err;
 131         };
 132
 133         static void returnFalseOnError(const NotFoundInfo &info);
 134         static void throwOnError(const NotFoundInfo &info);
 135         [[ noreturn ]] static void throwOnNotFound(const NotFoundInfo &info);
 136
 137         typedef void (*NotFoundHandler)(const NotFoundInfo &info);
 138
 139         /*! \brief
 140          * Checks whether a file exists and is a regular file.
 141          *
 142          * \param[in] filename    Path to the file to check.
 143          * \param[in] onNotFound  Function to call when the file does not
 144          *     exists or there is an error accessing it.
 145          * \returns   `true` if \p filename exists and is accessible.
 146          *
 147          * Does not throw, unless onNotFound throws.
 148          */
 149         static bool exists(const char *filename, NotFoundHandler onNotFound);
 150         //! \copydoc exists(const char *, NotFoundHandler)
 151         static bool exists(const std::string &filename,
 152                            NotFoundHandler    onNotFound);
 153
 154     private:
 155         // Disallow instantiation.
 156         File();
 157 };
 158
 159 class Directory
 160 {
 161     public:
 162         static int create(const char *path);
 163         static int create(const std::string &path);
 164         static bool exists(const char *path);
 165         static bool exists(const std::string &path);
 166
 167     private:
 168         // Disallow instantiation.
 169         Directory();
 170 };
 171
 172 } // namespace gmx
 173
 174 #endif