1 files changed, 80 insertions, 0 deletions
diff --git a/zen/file_access.h b/zen/file_access.h
new file mode 100644
index 00000000..7cac889c
--- /dev/null
+++ b/zen/file_access.h
@@ -0,0 +1,80 @@
+// **************************************************************************
+// * This file is part of the FreeFileSync project. It is distributed under *
+// * GNU General Public License: http://www.gnu.org/licenses/gpl.html       *
+// * Copyright (C) Zenju (zenju AT gmx DOT de) - All Rights Reserved        *
+// **************************************************************************
+
+#ifndef FILE_ACCESS_H_8017341345614857
+#define FILE_ACCESS_H_8017341345614857
+
+#include <functional>
+#include "zstring.h"
+#include "file_error.h"
+#include "file_id_def.h"
+
+namespace zen
+{
+bool fileExists     (const Zstring& filepath); //noexcept; check whether file      or file-symlink exists
+bool dirExists      (const Zstring& dirpath ); //noexcept; check whether directory or dir-symlink exists
+bool symlinkExists  (const Zstring& linkname); //noexcept; check whether a symbolic link exists
+bool somethingExists(const Zstring& objname ); //noexcept; check whether any object with this name exists
+
+enum class ProcSymlink
+{
+    DIRECT,
+    FOLLOW
+};
+
+void setFileTime(const Zstring& filepath, std::int64_t modificationTime, ProcSymlink procSl); //throw FileError
+
+//symlink handling: always evaluate target
+std::uint64_t getFilesize(const Zstring& filepath); //throw FileError
+std::uint64_t getFreeDiskSpace(const Zstring& path); //throw FileError
+
+bool removeFile(const Zstring& filepath); //throw FileError; return "false" if file is not existing
+void removeDirectory(const Zstring& directory, //throw FileError
+                     const std::function<void (const Zstring& filepath)>& onBeforeFileDeletion = nullptr,  //optional;
+                     const std::function<void (const Zstring& dirpath)>&  onBeforeDirDeletion  = nullptr); //one call for each *existing* object!
+
+//rename file or directory: no copying!!!
+void renameFile(const Zstring& oldName, const Zstring& newName); //throw FileError, ErrorDifferentVolume, ErrorTargetExisting
+
+bool supportsPermissions(const Zstring& dirpath); //throw FileError, dereferences symlinks
+
+//if parent directory not existing: create recursively:
+void makeDirectory(const Zstring& directory, bool failIfExists = false); //throw FileError, ErrorTargetExisting
+
+//fail if already existing or parent directory not existing:
+//directory should not end with path separator
+//templateDir may be empty
+void makeDirectoryPlain(const Zstring& directory, const Zstring& templateDir, bool copyFilePermissions); //throw FileError, ErrorTargetExisting, ErrorTargetPathMissing
+
+struct InSyncAttributes
+{
+    std::uint64_t fileSize;
+    std::int64_t modificationTime; //time_t UTC compatible
+    FileId sourceFileId;
+    FileId targetFileId;
+};
+
+void copyFile(const Zstring& sourceFile, //throw FileError, ErrorFileLocked (Windows-only)
+              const Zstring& targetFile, //symlink handling: dereference source
+              bool copyFilePermissions,
+              bool transactionalCopy,
+              //if target is existing user needs to implement deletion: copyFile() NEVER overwrites target if already existing!
+              //if transactionalCopy == true, full read access on source had been proven at this point, so it's safe to delete it.
+              const std::function<void()>& onDeleteTargetFile, //may be nullptr; may throw!
+              //accummulated delta != file size! consider ADS, sparse, compressed files
+              const std::function<void(std::int64_t bytesDelta)>& onUpdateCopyStatus, //may be nullptr; may throw!
+
+              InSyncAttributes* newAttrib = nullptr);  //return current attributes at the time of copy
+
+//Note: it MAY happen that copyFile() leaves temp files behind, e.g. temporary network drop.
+// => clean them up at an appropriate time (automatically set sync directions to delete them). They have the following ending:
+
+const Zchar TEMP_FILE_ENDING[] = Zstr(".ffs_tmp"); //don't use Zstring as global constant: avoid static initialization order problem in global namespace!
+
+void copySymlink(const Zstring& sourceLink, const Zstring& targetLink, bool copyFilePermissions); //throw FileError
+}
+
+#endif //FILE_ACCESS_H_8017341345614857