From 2cca4bddfc510c51444801efda9cc5607107e075 Mon Sep 17 00:00:00 2001
From: Nav <nav@navnav.me>
Date: Thu, 8 Sep 2022 19:55:43 +0100
Subject: [PATCH] Grouped InsightWorker tasks by use of TargetController

---
 src/Insight/InsightWorker/Tasks/GetTargetDescriptor.hpp    | 6 ++++++
 src/Insight/InsightWorker/Tasks/GetTargetState.hpp         | 6 ++++++
 src/Insight/InsightWorker/Tasks/ReadProgramCounter.hpp     | 6 ++++++
 src/Insight/InsightWorker/Tasks/ReadStackPointer.hpp       | 6 ++++++
 src/Insight/InsightWorker/Tasks/ReadTargetMemory.hpp       | 6 ++++++
 src/Insight/InsightWorker/Tasks/ReadTargetRegisters.hpp    | 6 ++++++
 src/Insight/InsightWorker/Tasks/RefreshTargetPinStates.hpp | 6 ++++++
 src/Insight/InsightWorker/Tasks/SetTargetPinState.hpp      | 6 ++++++
 src/Insight/InsightWorker/Tasks/TaskGroup.hpp              | 4 +++-
 src/Insight/InsightWorker/Tasks/WriteTargetRegister.hpp    | 6 ++++++
 10 files changed, 57 insertions(+), 1 deletion(-)

diff --git a/src/Insight/InsightWorker/Tasks/GetTargetDescriptor.hpp b/src/Insight/InsightWorker/Tasks/GetTargetDescriptor.hpp
index ba6f8845..851394af 100644
--- a/src/Insight/InsightWorker/Tasks/GetTargetDescriptor.hpp
+++ b/src/Insight/InsightWorker/Tasks/GetTargetDescriptor.hpp
@@ -13,6 +13,12 @@ namespace Bloom
     public:
         GetTargetDescriptor() = default;
 
+        TaskGroups getTaskGroups() const override {
+            return TaskGroups({
+                TaskGroup::USES_TARGET_CONTROLLER,
+            });
+        };
+
     signals:
         void targetDescriptor(Targets::TargetDescriptor targetDescriptor);
 
diff --git a/src/Insight/InsightWorker/Tasks/GetTargetState.hpp b/src/Insight/InsightWorker/Tasks/GetTargetState.hpp
index b72f5c5d..fdc68dfa 100644
--- a/src/Insight/InsightWorker/Tasks/GetTargetState.hpp
+++ b/src/Insight/InsightWorker/Tasks/GetTargetState.hpp
@@ -13,6 +13,12 @@ namespace Bloom
     public:
         GetTargetState() = default;
 
+        TaskGroups getTaskGroups() const override {
+            return TaskGroups({
+                TaskGroup::USES_TARGET_CONTROLLER,
+            });
+        };
+
     signals:
         void targetState(Targets::TargetState state);
 
diff --git a/src/Insight/InsightWorker/Tasks/ReadProgramCounter.hpp b/src/Insight/InsightWorker/Tasks/ReadProgramCounter.hpp
index a85a1d09..0cbb95f0 100644
--- a/src/Insight/InsightWorker/Tasks/ReadProgramCounter.hpp
+++ b/src/Insight/InsightWorker/Tasks/ReadProgramCounter.hpp
@@ -13,6 +13,12 @@ namespace Bloom
     public:
         ReadProgramCounter() = default;
 
+        TaskGroups getTaskGroups() const override {
+            return TaskGroups({
+                TaskGroup::USES_TARGET_CONTROLLER,
+            });
+        };
+
     signals:
         void programCounterRead(Targets::TargetProgramCounter programCounter);
 
diff --git a/src/Insight/InsightWorker/Tasks/ReadStackPointer.hpp b/src/Insight/InsightWorker/Tasks/ReadStackPointer.hpp
index 25e4461a..6600820f 100644
--- a/src/Insight/InsightWorker/Tasks/ReadStackPointer.hpp
+++ b/src/Insight/InsightWorker/Tasks/ReadStackPointer.hpp
@@ -13,6 +13,12 @@ namespace Bloom
     public:
         ReadStackPointer() = default;
 
+        TaskGroups getTaskGroups() const override {
+            return TaskGroups({
+                TaskGroup::USES_TARGET_CONTROLLER,
+            });
+        };
+
     signals:
         void stackPointerRead(Targets::TargetStackPointer stackPointer);
 
diff --git a/src/Insight/InsightWorker/Tasks/ReadTargetMemory.hpp b/src/Insight/InsightWorker/Tasks/ReadTargetMemory.hpp
index 8fd6f045..bbc8ee2f 100644
--- a/src/Insight/InsightWorker/Tasks/ReadTargetMemory.hpp
+++ b/src/Insight/InsightWorker/Tasks/ReadTargetMemory.hpp
@@ -24,6 +24,12 @@ namespace Bloom
             , size(size)
             , excludedAddressRanges(excludedAddressRanges) {}
 
+        TaskGroups getTaskGroups() const override {
+            return TaskGroups({
+                TaskGroup::USES_TARGET_CONTROLLER,
+            });
+        };
+
     signals:
         void targetMemoryRead(Targets::TargetMemoryBuffer buffer);
 
diff --git a/src/Insight/InsightWorker/Tasks/ReadTargetRegisters.hpp b/src/Insight/InsightWorker/Tasks/ReadTargetRegisters.hpp
index e60d6d91..cdfc8184 100644
--- a/src/Insight/InsightWorker/Tasks/ReadTargetRegisters.hpp
+++ b/src/Insight/InsightWorker/Tasks/ReadTargetRegisters.hpp
@@ -12,6 +12,12 @@ namespace Bloom
     public:
         explicit ReadTargetRegisters(const Targets::TargetRegisterDescriptors& descriptors): descriptors(descriptors) {}
 
+        TaskGroups getTaskGroups() const override {
+            return TaskGroups({
+                TaskGroup::USES_TARGET_CONTROLLER,
+            });
+        };
+
     signals:
         void targetRegistersRead(Targets::TargetRegisters registers);
 
diff --git a/src/Insight/InsightWorker/Tasks/RefreshTargetPinStates.hpp b/src/Insight/InsightWorker/Tasks/RefreshTargetPinStates.hpp
index 4a3f6b67..b829f87a 100644
--- a/src/Insight/InsightWorker/Tasks/RefreshTargetPinStates.hpp
+++ b/src/Insight/InsightWorker/Tasks/RefreshTargetPinStates.hpp
@@ -13,6 +13,12 @@ namespace Bloom
     public:
         explicit RefreshTargetPinStates(int variantId): variantId(variantId) {}
 
+        TaskGroups getTaskGroups() const override {
+            return TaskGroups({
+                TaskGroup::USES_TARGET_CONTROLLER,
+            });
+        };
+
     signals:
         void targetPinStatesRetrieved(Bloom::Targets::TargetPinStateMappingType pinStatesByNumber);
 
diff --git a/src/Insight/InsightWorker/Tasks/SetTargetPinState.hpp b/src/Insight/InsightWorker/Tasks/SetTargetPinState.hpp
index 8cb090c5..4e507088 100644
--- a/src/Insight/InsightWorker/Tasks/SetTargetPinState.hpp
+++ b/src/Insight/InsightWorker/Tasks/SetTargetPinState.hpp
@@ -13,6 +13,12 @@ namespace Bloom
         SetTargetPinState(const Targets::TargetPinDescriptor& pinDescriptor, const Targets::TargetPinState& pinState):
         pinDescriptor(pinDescriptor), pinState(pinState) {}
 
+        TaskGroups getTaskGroups() const override {
+            return TaskGroups({
+                TaskGroup::USES_TARGET_CONTROLLER,
+            });
+        };
+
     protected:
         void run(TargetController::TargetControllerConsole& targetControllerConsole) override;
 
diff --git a/src/Insight/InsightWorker/Tasks/TaskGroup.hpp b/src/Insight/InsightWorker/Tasks/TaskGroup.hpp
index b710637d..bf6686c8 100644
--- a/src/Insight/InsightWorker/Tasks/TaskGroup.hpp
+++ b/src/Insight/InsightWorker/Tasks/TaskGroup.hpp
@@ -6,7 +6,9 @@
 namespace Bloom
 {
     enum class TaskGroup: std::uint16_t
-    {};
+    {
+        USES_TARGET_CONTROLLER,
+    };
 
     using TaskGroups = std::set<TaskGroup>;
 }
diff --git a/src/Insight/InsightWorker/Tasks/WriteTargetRegister.hpp b/src/Insight/InsightWorker/Tasks/WriteTargetRegister.hpp
index 69e8e8ff..3120b909 100644
--- a/src/Insight/InsightWorker/Tasks/WriteTargetRegister.hpp
+++ b/src/Insight/InsightWorker/Tasks/WriteTargetRegister.hpp
@@ -12,6 +12,12 @@ namespace Bloom
     public:
         explicit WriteTargetRegister(const Targets::TargetRegister& targetRegister): targetRegister(targetRegister) {}
 
+        TaskGroups getTaskGroups() const override {
+            return TaskGroups({
+                TaskGroup::USES_TARGET_CONTROLLER,
+            });
+        };
+
     protected:
         void run(TargetController::TargetControllerConsole& targetControllerConsole) override;