src/filesys.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef FILESYS_HEADER
  21 #define FILESYS_HEADER
  22
  23 #include <string>
  24 #include <vector>
  25 #include "exceptions.h"
  26
  27 #ifdef _WIN32 // WINDOWS
  28 #define DIR_DELIM "\\"
  29 #define DIR_DELIM_C '\\'
  30 #else // POSIX
  31 #define DIR_DELIM "/"
  32 #define DIR_DELIM_C '/'
  33 #endif
  34
  35 namespace fs
  36 {
  37
  38 struct DirListNode
  39 {
  40         std::string name;
  41         bool dir;
  42 };
  43 std::vector<DirListNode> GetDirListing(std::string path);
  44
  45 // Returns true if already exists
  46 bool CreateDir(std::string path);
  47
  48 bool PathExists(std::string path);
  49
  50 bool IsDir(std::string path);
  51
  52 // Only pass full paths to this one. True on success.
  53 // NOTE: The WIN32 version returns always true.
  54 bool RecursiveDelete(std::string path);
  55
  56 bool DeleteSingleFileOrEmptyDirectory(std::string path);
  57
  58 /* Multiplatform */
  59
  60 // The path itself not included
  61 void GetRecursiveSubPaths(std::string path, std::vector<std::string> &dst);
  62
  63 // Tries to delete all, returns false if any failed
  64 bool DeletePaths(const std::vector<std::string> &paths);
  65
  66 // Only pass full paths to this one. True on success.
  67 bool RecursiveDeleteContent(std::string path);
  68
  69 // Create all directories on the given path that don't already exist.
  70 bool CreateAllDirs(std::string path);
  71
  72 }//fs
  73
  74 #endif
  75