src/util/file_system.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef HEADER_SUPERTUX_UTIL_FILE_SYSTEM_HPP
  18 #define HEADER_SUPERTUX_UTIL_FILE_SYSTEM_HPP
  19
  20 namespace FileSystem {
  21
  22 /** Returns true if the given path is a directory */
  23 bool is_directory(const std::string& path);
  24
  25 /** Return true if the given file exists */
  26 bool exists(const std::string& path);
  27
  28 /**
  29  *  Create the given directory
  30  */
  31 void mkdir(const std::string& directory);
  32
  33 /**
  34  * returns the path of the directory the file is in
  35  */
  36 std::string dirname(const std::string& filename);
  37
  38 /**
  39  * returns the name of the file
  40  */
  41 std::string basename(const std::string& filename);
  42
  43 /**
  44  * remove everything starting from and including the last dot
  45  */
  46 std::string strip_extension(const std::string& filename);
  47
  48 /**
  49  * normalize filename so that "blup/bla/blo/../../bar" will become
  50  * "blup/bar"
  51  */
  52 std::string normalize(const std::string& filename);
  53
  54 /**
  55  * join two filenames join("foo", "bar") -> "foo/bar"
  56  */
  57 std::string join(const std::string& lhs, const std::string& rhs);
  58
  59 } // namespace FileSystem
  60
  61 #endif
  62
  63 /* EOF */