3.9

1 files changed, 67 insertions, 0 deletions

diff --git a/shared/file_traverser.h b/shared/file_traverser.h
new file mode 100644
index 00000000..d61ff1cd
--- /dev/null
+++ b/shared/file_traverser.h
@@ -0,0 +1,67 @@
+// **************************************************************************
+// * 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) 2008-2010 ZenJu (zhnmju123 AT gmx.de)                    *
+// **************************************************************************
+//
+#ifndef FILETRAVERSER_H_INCLUDED
+#define FILETRAVERSER_H_INCLUDED
+
+#include "zstring.h"
+#include <wx/longlong.h>
+#include "loki/TypeManip.h"
+
+//advanced file traverser returning metadata and hierarchical information on files and directories
+
+namespace ffs3
+{
+class TraverseCallback
+{
+public:
+    virtual ~TraverseCallback() {}
+
+    struct FileInfo
+    {
+        wxULongLong fileSize;        //unit: bytes!
+        wxLongLong lastWriteTimeRaw; //number of seconds since Jan. 1st 1970 UTC
+    };
+
+    struct SymlinkInfo
+    {
+        wxLongLong lastWriteTimeRaw; //number of seconds since Jan. 1st 1970 UTC
+        Zstring    targetPath;       //may be empty if something goes wrong
+        bool dirLink;                //"true": point to dir; "false": point to file (or broken Link on Linux)
+    };
+
+    class ReturnValDir
+    {
+    public:
+        enum ReturnValueEnh
+        {
+            TRAVERSING_DIR_IGNORE,
+            TRAVERSING_DIR_CONTINUE
+        };
+
+        ReturnValDir(Loki::Int2Type<TRAVERSING_DIR_IGNORE>) : returnCode(TRAVERSING_DIR_IGNORE), subDirCb(NULL) {}
+        ReturnValDir(Loki::Int2Type<TRAVERSING_DIR_CONTINUE>, TraverseCallback* subDirCallback) : returnCode(TRAVERSING_DIR_CONTINUE), subDirCb(subDirCallback) {}
+
+        const ReturnValueEnh returnCode;
+        TraverseCallback* const subDirCb;
+    };
+
+    //overwrite these virtual methods
+    virtual void onError(const wxString& errorText) = 0;
+    virtual void onFile(       const DefaultChar* shortName, const Zstring& fullName, const FileInfo&    details) = 0;
+    virtual void onSymlink(    const DefaultChar* shortName, const Zstring& fullName, const SymlinkInfo& details) = 0;
+    virtual ReturnValDir onDir(const DefaultChar* shortName, const Zstring& fullName) = 0;
+};
+
+//custom traverser with detail information about files
+//directory may end with PATH_SEPARATOR
+void traverseFolder(const Zstring& directory, bool followSymlinks, TraverseCallback* sink); //throw();
+//followSymlinks:
+//"true":  Symlinks dereferenced and reported via onFile() and onDir() => onSymlink not used!
+//"false": Symlinks directly reported via onSymlink(), directory symlinks are not followed
+}
+
+#endif // FILETRAVERSER_H_INCLUDED