From c1ab97eb15eee0b188ca79f2657eb9600e6c6c47 Mon Sep 17 00:00:00 2001
From: MihailRis <mexaruc@gmail.com>
Date: Fri, 5 Apr 2024 14:19:02 +0300
Subject: [PATCH] Task interface

---
 src/files/WorldConverter.cpp |  7 ++++-
 src/files/WorldConverter.h   | 31 +++++++++++++++++---
 src/frontend/menu/menu.cpp   | 55 +++++++++++++++++++++++-------------
 src/interfaces/Task.h        | 19 +++++++++++++
 src/util/ThreadPool.h        | 18 ++++++++++--
 5 files changed, 102 insertions(+), 28 deletions(-)
 create mode 100644 src/interfaces/Task.h

diff --git a/src/files/WorldConverter.cpp b/src/files/WorldConverter.cpp
index ba30f7bf..9588aad0 100644
--- a/src/files/WorldConverter.cpp
+++ b/src/files/WorldConverter.cpp
@@ -77,6 +77,7 @@ void WorldConverter::convertNext() {
     }
     convert_task task = tasks.front();
     tasks.pop();
+    tasksDone++;
 
     if (!fs::is_regular_file(task.file))
         return;
@@ -95,6 +96,10 @@ void WorldConverter::write() {
     wfile->write(nullptr, content);
 }
 
-uint WorldConverter::getTotalTasks() const {
+uint WorldConverter::getWorkRemaining() const {
     return tasks.size();
 }
+
+uint WorldConverter::getWorkDone() const {
+    return tasksDone;
+}
diff --git a/src/files/WorldConverter.h b/src/files/WorldConverter.h
index 031b69cd..0a34a9e5 100644
--- a/src/files/WorldConverter.h
+++ b/src/files/WorldConverter.h
@@ -4,7 +4,10 @@
 #include <queue>
 #include <memory>
 #include <filesystem>
+
 #include "../typedefs.h"
+#include "../delegates.h"
+#include "../interfaces/Task.h"
 
 namespace fs = std::filesystem;
 
@@ -21,25 +24,45 @@ struct convert_task {
     fs::path file;
 };
 
-class WorldConverter {
+class WorldConverter : public Task {
     WorldFiles* wfile;
     std::shared_ptr<ContentLUT> const lut;
     const Content* const content;
     std::queue<convert_task> tasks;
+    runnable onComplete;
+    uint tasksDone = 0;
 
     void convertPlayer(fs::path file);
     void convertRegion(fs::path file);
 public:
-    WorldConverter(fs::path folder, const Content* content, 
-                   std::shared_ptr<ContentLUT> lut);
+    WorldConverter(
+        fs::path folder, const Content* content, 
+        std::shared_ptr<ContentLUT> lut
+    );
     ~WorldConverter();
 
     bool hasNext() const;
     void convertNext();
 
+    void setOnComplete(runnable callback) {
+        this->onComplete = callback;
+    }
+
+    void update() override {
+        convertNext();
+        if (onComplete && !hasNext()) {
+            onComplete();
+        }
+    }
+
+    void terminate() override {
+        tasks = {};
+    }
+
     void write();
 
-    uint getTotalTasks() const;
+    uint getWorkRemaining() const override;
+    uint getWorkDone() const override;
 };
 
 #endif // FILES_WORLD_CONVERTER_H_
diff --git a/src/frontend/menu/menu.cpp b/src/frontend/menu/menu.cpp
index 401619dd..72fe1c76 100644
--- a/src/frontend/menu/menu.cpp
+++ b/src/frontend/menu/menu.cpp
@@ -8,6 +8,7 @@
 #include <filesystem>
 #include <glm/glm.hpp>
 
+#include "../../interfaces/Task.h"
 #include "../../graphics/ui/GUI.h"
 #include "../../graphics/ui/gui_util.h"
 #include "../../graphics/ui/elements/containers.h"
@@ -104,35 +105,27 @@ static void show_content_missing(
     menu->setPage("missing-content");
 }
 
-void show_process_panel(Engine* engine, std::shared_ptr<WorldConverter> converter, runnable postRunnable) {
+void show_process_panel(Engine* engine, std::shared_ptr<Task> task, std::wstring text=L"") {
     auto menu = engine->getGUI()->getMenu();
     auto panel = menus::create_page(engine, "process", 400, 0.5f, 1);
 
-    panel->add(std::make_shared<Label>(langs::get(L"Converting world...")));
+    if (!text.empty()) {
+        panel->add(std::make_shared<Label>(langs::get(text)));
+    }
 
     auto label = std::make_shared<Label>(L"0%");
     panel->add(label);
 
-    uint initialTasks = converter->getTotalTasks();
+    uint initialWork = task->getWorkRemaining();
 
     panel->listenInterval(0.01f, [=]() {
-        if (!converter->hasNext()) {
-            converter->write();
+        task->update();
 
-            menu->reset();
-            menu->setPage("main", false);
-            engine->getGUI()->postRunnable([=]() {
-                postRunnable();
-            });
-            return;
-        }
-        converter->convertNext();
-
-        uint tasksDone = initialTasks-converter->getTotalTasks();
-        float progress = tasksDone/static_cast<float>(initialTasks);
+        uint tasksDone = task->getWorkDone();
+        float progress = tasksDone/static_cast<float>(initialWork);
         label->setText(
             std::to_wstring(tasksDone)+
-            L"/"+std::to_wstring(initialTasks)+L" ("+
+            L"/"+std::to_wstring(initialWork)+L" ("+
             std::to_wstring(int(progress*100))+L"%)"
         );
     });
@@ -141,6 +134,27 @@ void show_process_panel(Engine* engine, std::shared_ptr<WorldConverter> converte
     menu->setPage("process", false);
 }
 
+std::shared_ptr<WorldConverter> create_converter(
+    Engine* engine,
+    fs::path folder, 
+    const Content* content, 
+    std::shared_ptr<ContentLUT> lut, 
+    runnable postRunnable)
+{
+    auto converter = std::make_shared<WorldConverter>(folder, content, lut);
+    converter->setOnComplete([=](){
+        converter->write();
+
+        auto menu = engine->getGUI()->getMenu();
+        menu->reset();
+        menu->setPage("main", false);
+        engine->getGUI()->postRunnable([=]() {
+            postRunnable();
+        });
+    });
+    return converter;
+}
+
 void show_convert_request(
     Engine* engine, 
     const Content* content, 
@@ -149,7 +163,8 @@ void show_convert_request(
     runnable postRunnable
 ) {
     guiutil::confirm(engine->getGUI(), langs::get(L"world.convert-request"), [=]() {
-        show_process_panel(engine, std::make_shared<WorldConverter>(folder, content, lut), postRunnable);
+        auto converter = create_converter(engine, folder, content, lut, postRunnable);
+        show_process_panel(engine, converter, L"Converting world...");
     }, L"", langs::get(L"Cancel"));
 }
 
@@ -210,9 +225,9 @@ void menus::open_world(std::string name, Engine* engine, bool confirmConvert) {
             show_content_missing(engine, content, lut);
         } else {
             if (confirmConvert) {
-                show_process_panel(engine, std::make_shared<WorldConverter>(folder, content, lut), [=](){
+                show_process_panel(engine, create_converter(engine, folder, content, lut, [=]() {
                     open_world(name, engine, false);
-                });
+                }), L"Converting world...");
             } else {
                 show_convert_request(engine, content, lut, folder, [=](){
                     open_world(name, engine, false);
diff --git a/src/interfaces/Task.h b/src/interfaces/Task.h
new file mode 100644
index 00000000..318dbf68
--- /dev/null
+++ b/src/interfaces/Task.h
@@ -0,0 +1,19 @@
+#ifndef INTERFACES_TASK_H_
+#define INTERFACES_TASK_H_
+
+#include "../typedefs.h"
+
+/// @brief Task is a finite process interface.
+/// 'work' is a metric of task progress/remaining work (jobs/bytes/something other)
+class Task {
+public:
+    virtual ~Task() {}
+
+    virtual uint getWorkRemaining() const = 0;
+    virtual uint getWorkDone() const = 0;
+    virtual void update() = 0;
+    virtual void terminate() = 0;
+};
+
+#endif // INTERFACES_TASK_H_
+
diff --git a/src/util/ThreadPool.h b/src/util/ThreadPool.h
index c65f1393..646e65a1 100644
--- a/src/util/ThreadPool.h
+++ b/src/util/ThreadPool.h
@@ -10,6 +10,7 @@
 
 #include "../delegates.h"
 #include "../debug/Logger.h"
+#include "../interfaces/Task.h"
 
 namespace util {
     
@@ -30,7 +31,7 @@ public:
 };
 
 template<class T, class R>
-class ThreadPool {
+class ThreadPool : public Task {
     debug::Logger logger;
     std::queue<T> jobs;
     std::queue<ThreadPoolResult<R>> results;
@@ -43,6 +44,7 @@ class ThreadPool {
     consumer<T&> onJobFailed = nullptr;
     runnable onComplete = nullptr;
     std::atomic<int> busyWorkers = 0;
+    std::atomic<uint> jobsDone = 0;
     bool working = true;
 
     void threadLoop(int index, std::shared_ptr<Worker<T, R>> worker) {
@@ -79,11 +81,13 @@ class ThreadPool {
                     });
                 }
             } catch (std::exception& err) {
+                busyWorkers--;
                 if (onJobFailed) {
                     onJobFailed(job);
                 }
                 logger.error() << "uncaught exception: " << err.what();
             }
+            jobsDone++;
         }
     }
 public:
@@ -102,7 +106,7 @@ public:
         terminate();
     }
 
-    void terminate() {
+    void terminate() override {
         if (!working) {
             return;
         }
@@ -126,7 +130,7 @@ public:
         }
     }
 
-    void update() {
+    void update() override {
         std::lock_guard<std::mutex> lock(resultsMutex);
         while (!results.empty()) {
             ThreadPoolResult<R> entry = results.front();
@@ -161,6 +165,14 @@ public:
     void setOnComplete(runnable callback) {
         this->onComplete = callback;
     }
+
+    uint getWorkRemaining() const override {
+        return jobs.size();
+    }
+
+    uint getWorkDone() const override {
+        return jobsDone;
+    }
 };
 
 } // namespace util