/*
-Minetest-c55
-Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#ifndef FILESYS_HEADER
-#define FILESYS_HEADER
+#pragma once
+#include <set>
#include <string>
#include <vector>
#include "exceptions.h"
#ifdef _WIN32 // WINDOWS
#define DIR_DELIM "\\"
-#define DIR_DELIM_C '\\'
+#define DIR_DELIM_CHAR '\\'
+#define FILESYS_CASE_INSENSITIVE true
+#define PATH_DELIM ";"
#else // POSIX
#define DIR_DELIM "/"
-#define DIR_DELIM_C '/'
+#define DIR_DELIM_CHAR '/'
+#define FILESYS_CASE_INSENSITIVE false
+#define PATH_DELIM ":"
#endif
namespace fs
std::string name;
bool dir;
};
-std::vector<DirListNode> GetDirListing(std::string path);
+
+std::vector<DirListNode> GetDirListing(const std::string &path);
// Returns true if already exists
-bool CreateDir(std::string path);
+bool CreateDir(const std::string &path);
+
+bool PathExists(const std::string &path);
-bool PathExists(std::string path);
+bool IsPathAbsolute(const std::string &path);
-bool IsDir(std::string path);
+bool IsDir(const std::string &path);
+
+bool IsDirDelimiter(char c);
// Only pass full paths to this one. True on success.
// NOTE: The WIN32 version returns always true.
-bool RecursiveDelete(std::string path);
+bool RecursiveDelete(const std::string &path);
+
+bool DeleteSingleFileOrEmptyDirectory(const std::string &path);
-bool DeleteSingleFileOrEmptyDirectory(std::string path);
+// Returns path to temp directory, can return "" on error
+std::string TempPath();
+
+/* Returns a list of subdirectories, including the path itself, but excluding
+ hidden directories (whose names start with . or _)
+*/
+void GetRecursiveDirs(std::vector<std::string> &dirs, const std::string &dir);
+std::vector<std::string> GetRecursiveDirs(const std::string &dir);
/* Multiplatform */
-// The path itself not included
-void GetRecursiveSubPaths(std::string path, std::vector<std::string> &dst);
+/* The path itself not included, returns a list of all subpaths.
+ dst - vector that contains all the subpaths.
+ list files - include files in the list of subpaths.
+ ignore - paths that start with these charcters will not be listed.
+*/
+void GetRecursiveSubPaths(const std::string &path,
+ std::vector<std::string> &dst,
+ bool list_files,
+ const std::set<char> &ignore = {});
// Tries to delete all, returns false if any failed
bool DeletePaths(const std::vector<std::string> &paths);
// Only pass full paths to this one. True on success.
-bool RecursiveDeleteContent(std::string path);
+bool RecursiveDeleteContent(const std::string &path);
// Create all directories on the given path that don't already exist.
-bool CreateAllDirs(std::string path);
+bool CreateAllDirs(const std::string &path);
-}//fs
+// Copy a regular file
+bool CopyFileContents(const std::string &source, const std::string &target);
-#endif
+// Copy directory and all subdirectories
+// Omits files and subdirectories that start with a period
+bool CopyDir(const std::string &source, const std::string &target);
+
+// Check if one path is prefix of another
+// For example, "/tmp" is a prefix of "/tmp" and "/tmp/file" but not "/tmp2"
+// Ignores case differences and '/' vs. '\\' on Windows
+bool PathStartsWith(const std::string &path, const std::string &prefix);
+
+// Remove last path component and the dir delimiter before and/or after it,
+// returns "" if there is only one path component.
+// removed: If non-NULL, receives the removed component(s).
+// count: Number of components to remove
+std::string RemoveLastPathComponent(const std::string &path,
+ std::string *removed = NULL, int count = 1);
+
+// Remove "." and ".." path components and for every ".." removed, remove
+// the last normal path component before it. Unlike AbsolutePath,
+// this does not resolve symlinks and check for existence of directories.
+std::string RemoveRelativePathComponents(std::string path);
+
+// Returns the absolute path for the passed path, with "." and ".." path
+// components and symlinks removed. Returns "" on error.
+std::string AbsolutePath(const std::string &path);
+
+// Returns the filename from a path or the entire path if no directory
+// delimiter is found.
+const char *GetFilenameFromPath(const char *path);
+
+bool safeWriteToFile(const std::string &path, const std::string &content);
+
+bool Rename(const std::string &from, const std::string &to);
+} // namespace fs