src/gromacs/utility/path.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13  *
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \libinternal \file
  32  * \brief
  33  * Declares functions for OS-independent path handling.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \inlibraryapi
  37  */
  38 #ifndef GMX_UTILITY_PATH_H
  39 #define GMX_UTILITY_PATH_H
  40
  41 #include <string>
  42 #include <utility>
  43
  44 namespace gmx
  45 {
  46
  47 class Path
  48 {
  49     public:
  50         static std::string join(const std::string &path1,
  51                                 const std::string &path2);
  52         static std::string join(const std::string &path1,
  53                                 const std::string &path2,
  54                                 const std::string &path3);
  55         static std::pair<std::string, std::string>
  56         splitToPathAndFilename(const std::string &path);
  57
  58     private:
  59         // Disallow instantiation.
  60         Path();
  61 };
  62
  63
  64 class Directory
  65 {
  66     public:
  67         static int create(const char *path);
  68         static int create(const std::string &path);
  69         static bool exists(const char *path);
  70         static bool exists(const std::string &path);
  71
  72     private:
  73         // Disallow instantiation.
  74         Directory();
  75 };
  76
  77 } // namespace gmx
  78
  79 #endif