src/gromacs/utility/path.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2011,2012,2013, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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
  49 namespace gmx
  50 {
  51
  52 class Path
  53 {
  54     public:
  55         static std::string join(const std::string &path1,
  56                                 const std::string &path2);
  57         static std::string join(const std::string &path1,
  58                                 const std::string &path2,
  59                                 const std::string &path3);
  60         static std::pair<std::string, std::string>
  61         splitToPathAndFilename(const std::string &path);
  62
  63     private:
  64         // Disallow instantiation.
  65         Path();
  66 };
  67
  68
  69 class Directory
  70 {
  71     public:
  72         static int create(const char *path);
  73         static int create(const std::string &path);
  74         static bool exists(const char *path);
  75         static bool exists(const std::string &path);
  76
  77     private:
  78         // Disallow instantiation.
  79         Directory();
  80 };
  81
  82 } // namespace gmx
  83
  84 #endif