1.12

1 files changed, 76 insertions, 0 deletions

diff --git a/library/statusHandler.h b/library/statusHandler.h
new file mode 100644
index 00000000..ad4cb3a0
--- /dev/null
+++ b/library/statusHandler.h
@@ -0,0 +1,76 @@
+#ifndef STATUSHANDLER_H_INCLUDED
+#define STATUSHANDLER_H_INCLUDED
+
+#include <wx/string.h>
+#include <wx/thread.h>
+
+const int UI_UPDATE_INTERVAL = 100; //perform ui updates not more often than necessary, 100 seems to be a good value with only a minimal performance loss
+
+bool updateUiIsAllowed(); //test if a specific amount of time is over
+void updateUiNow();       //do the updating
+
+
+//interfaces for status updates (can be implemented by UI or commandline)
+//overwrite virtual methods for respective functionality
+
+class ErrorHandler
+{
+public:
+    ErrorHandler() {}
+    virtual ~ErrorHandler() {}
+
+    enum Response
+    {
+        CONTINUE_NEXT = -1,
+        RETRY         = -2
+    };
+    virtual Response reportError(const wxString& text) = 0;
+};
+
+
+class StatusHandler
+{
+public:
+    StatusHandler() :
+            abortionRequested(false) {}
+    virtual ~StatusHandler() {}
+
+    //identifiers of different processes
+    enum Process
+    {
+        PROCESS_NONE = 10,
+        PROCESS_SCANNING,
+        PROCESS_COMPARING_CONTENT,
+        PROCESS_SYNCHRONIZING
+    };
+
+    //these methods have to be implemented in the derived classes to handle error and status information
+    virtual void updateStatusText(const wxString& text) = 0;
+    virtual void initNewProcess(int objectsTotal, double dataTotal, Process processID) = 0; //informs about the total amount of data that will be processed from now on
+    virtual void updateProcessedData(int objectsProcessed, double dataProcessed) = 0;   //called periodically after data was processed
+    virtual ErrorHandler::Response reportError(const wxString& text) = 0;
+
+    //this method is triggered repeatedly by requestUiRefresh() and can be used to refresh the ui by dispatching pending events
+    virtual void forceUiRefresh() = 0;
+    void requestUiRefresh(bool asyncProcessActive = false)
+    {
+        if (updateUiIsAllowed())  //test if specific time span between ui updates is over
+            forceUiRefresh();
+
+        if (abortionRequested && !asyncProcessActive)
+            abortThisProcess();  //abort can be triggered by requestAbortion()
+    }
+
+    void requestAbortion() //opportunity to abort must be implemented in a frequently executed method like requestUiRefresh()
+    {                      //currently used by the UI status information screen, when button "Abort is pressed"
+        abortionRequested = true;
+    }
+
+protected:
+    virtual void abortThisProcess() = 0;
+
+    bool abortionRequested;
+};
+
+
+#endif // STATUSHANDLER_H_INCLUDED