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 #pragma once
  21
  22 #include <set>
  23 #include <string>
  24 #include <vector>
  25 #include "exceptions.h"
  26
  27 #ifdef _WIN32
  28 #define DIR_DELIM "\\"
  29 #define DIR_DELIM_CHAR '\\'
  30 #define FILESYS_CASE_INSENSITIVE true
  31 #define PATH_DELIM ";"
  32 #else
  33 #define DIR_DELIM "/"
  34 #define DIR_DELIM_CHAR '/'
  35 #define FILESYS_CASE_INSENSITIVE false
  36 #define PATH_DELIM ":"
  37 #endif
  38
  39 namespace irr { namespace io {
  40 class IFileSystem;
  41 }}
  42
  43 namespace fs
  44 {
  45
  46 struct DirListNode
  47 {
  48         std::string name;
  49         bool dir;
  50 };
  51
  52 std::vector<DirListNode> GetDirListing(const std::string &path);
  53
  54 // Returns true if already exists
  55 bool CreateDir(const std::string &path);
  56
  57 bool PathExists(const std::string &path);
  58
  59 bool IsPathAbsolute(const std::string &path);
  60
  61 bool IsDir(const std::string &path);
  62
  63 bool IsExecutable(const std::string &path);
  64
  65 inline bool IsFile(const std::string &path)
  66 {
  67         return PathExists(path) && !IsDir(path);
  68 }
  69
  70 bool IsDirDelimiter(char c);
  71
  72 // Only pass full paths to this one. True on success.
  73 // NOTE: The WIN32 version returns always true.
  74 bool RecursiveDelete(const std::string &path);
  75
  76 bool DeleteSingleFileOrEmptyDirectory(const std::string &path);
  77
  78 // Returns path to temp directory, can return "" on error
  79 std::string TempPath();
  80
  81 // Returns path to securely-created temporary file (will already exist when this function returns)
  82 // can return "" on error
  83 std::string CreateTempFile();
  84
  85 /* Returns a list of subdirectories, including the path itself, but excluding
  86        hidden directories (whose names start with . or _)
  87 */
  88 void GetRecursiveDirs(std::vector<std::string> &dirs, const std::string &dir);
  89 std::vector<std::string> GetRecursiveDirs(const std::string &dir);
  90
  91 /* Multiplatform */
  92
  93 /* The path itself not included, returns a list of all subpaths.
  94    dst - vector that contains all the subpaths.
  95    list files - include files in the list of subpaths.
  96    ignore - paths that start with these charcters will not be listed.
  97 */
  98 void GetRecursiveSubPaths(const std::string &path,
  99                   std::vector<std::string> &dst,
 100                   bool list_files,
 101                   const std::set<char> &ignore = {});
 102
 103 // Only pass full paths to this one. True on success.
 104 bool RecursiveDeleteContent(const std::string &path);
 105
 106 // Create all directories on the given path that don't already exist.
 107 bool CreateAllDirs(const std::string &path);
 108
 109 // Copy a regular file
 110 bool CopyFileContents(const std::string &source, const std::string &target);
 111
 112 // Copy directory and all subdirectories
 113 // Omits files and subdirectories that start with a period
 114 bool CopyDir(const std::string &source, const std::string &target);
 115
 116 // Move directory and all subdirectories
 117 // Behavior with files/subdirs that start with a period is undefined
 118 bool MoveDir(const std::string &source, const std::string &target);
 119
 120 // Check if one path is prefix of another
 121 // For example, "/tmp" is a prefix of "/tmp" and "/tmp/file" but not "/tmp2"
 122 // Ignores case differences and '/' vs. '\\' on Windows
 123 bool PathStartsWith(const std::string &path, const std::string &prefix);
 124
 125 // Remove last path component and the dir delimiter before and/or after it,
 126 // returns "" if there is only one path component.
 127 // removed: If non-NULL, receives the removed component(s).
 128 // count: Number of components to remove
 129 std::string RemoveLastPathComponent(const std::string &path,
 130                std::string *removed = NULL, int count = 1);
 131
 132 // Remove "." and ".." path components and for every ".." removed, remove
 133 // the last normal path component before it. Unlike AbsolutePath,
 134 // this does not resolve symlinks and check for existence of directories.
 135 std::string RemoveRelativePathComponents(std::string path);
 136
 137 // Returns the absolute path for the passed path, with "." and ".." path
 138 // components and symlinks removed.  Returns "" on error.
 139 std::string AbsolutePath(const std::string &path);
 140
 141 // Returns the filename from a path or the entire path if no directory
 142 // delimiter is found.
 143 const char *GetFilenameFromPath(const char *path);
 144
 145 bool safeWriteToFile(const std::string &path, const std::string &content);
 146
 147 #ifndef SERVER
 148 bool extractZipFile(irr::io::IFileSystem *fs, const char *filename, const std::string &destination);
 149 #endif
 150
 151 bool ReadFile(const std::string &path, std::string &out);
 152
 153 bool Rename(const std::string &from, const std::string &to);
 154
 155 } // namespace fs