Replace monitor added/removed handlers with signals

Author: adazem009

include/scratchcpp/iengine.h

@@ -346,11 +346,11 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Sets the list of monitors. */
         virtual void setMonitors(const std::vector<std::shared_ptr<Monitor>> &newMonitors) = 0;
 
-        /*! Sets the function which is called when a monitor is added. */
-        virtual void setAddMonitorHandler(const std::function<void(Monitor *)> &handler) = 0;
+        /*! Emits when a monitor is added. */
+        virtual sigslot::signal<Monitor *> &monitorAdded() = 0;
 
-        /*! Sets the function which is called when a monitor is removed. */
-        virtual void setRemoveMonitorHandler(const std::function<void(Monitor *, IMonitorHandler *)> &handler) = 0;
+        /*! Emits when a monitor is removed. */
+        virtual sigslot::signal<Monitor *, IMonitorHandler *> &monitorRemoved() = 0;
 
         /*! Returns the function which is called when a question is asked, for example using the 'ask and wait' block. */
         virtual const std::function<void(const std::string &)> &questionAsked() const = 0;

src/engine/internal/engine.cpp

@@ -60,10 +60,8 @@ void Engine::clear()
 {
     stop();
 
-    if (m_removeMonitorHandler) {
-        for (auto monitor : m_monitors)
-            m_removeMonitorHandler(monitor.get(), monitor->impl->iface);
-    }
+    for (auto monitor : m_monitors)
+        m_monitorRemoved(monitor.get(), monitor->impl->iface);
 
     m_sections.clear();
     m_targets.clear();
@@ -1220,28 +1218,25 @@ const std::vector<std::shared_ptr<Monitor>> &Engine::monitors() const
 
 void Engine::setMonitors(const std::vector<std::shared_ptr<Monitor>> &newMonitors)
 {
-    if (m_addMonitorHandler) {
-        m_monitors.clear();
+    m_monitors.clear();
 
-        for (auto monitor : newMonitors) {
-            m_monitors.push_back(monitor);
-            m_addMonitorHandler(monitor.get());
-        }
-    } else
-        m_monitors = newMonitors;
+    for (auto monitor : newMonitors) {
+        m_monitors.push_back(monitor);
+        m_monitorAdded(monitor.get());
+    }
 
     // Create missing monitors
     createMissingMonitors();
 }
 
-void Engine::setAddMonitorHandler(const std::function<void(Monitor *)> &handler)
+sigslot::signal<Monitor *> &Engine::monitorAdded()
 {
-    m_addMonitorHandler = handler;
+    return m_monitorAdded;
 }
 
-void Engine::setRemoveMonitorHandler(const std::function<void(Monitor *, IMonitorHandler *)> &handler)
+sigslot::signal<Monitor *, IMonitorHandler *> &Engine::monitorRemoved()
 {
-    m_removeMonitorHandler = handler;
+    return m_monitorRemoved;
 }
 
 const std::function<void(const std::string &)> &Engine::questionAsked() const
@@ -1633,9 +1628,7 @@ void Engine::addVarOrListMonitor(std::shared_ptr<Monitor> monitor, Target *targe
     monitor->setY(rect.top());
 
     m_monitors.push_back(monitor);
-
-    if (m_addMonitorHandler)
-        m_addMonitorHandler(monitor.get());
+    m_monitorAdded(monitor.get());
 
     monitor->setVisible(false);
 }

src/engine/internal/engine.h

@@ -143,8 +143,8 @@ class Engine : public IEngine
 
         const std::vector<std::shared_ptr<Monitor>> &monitors() const override;
         void setMonitors(const std::vector<std::shared_ptr<Monitor>> &newMonitors) override;
-        void setAddMonitorHandler(const std::function<void(Monitor *)> &handler) override;
-        void setRemoveMonitorHandler(const std::function<void(Monitor *, IMonitorHandler *)> &handler) override;
+        sigslot::signal<Monitor *> &monitorAdded() override;
+        sigslot::signal<Monitor *, IMonitorHandler *> &monitorRemoved() override;
 
         const std::function<void(const std::string &)> &questionAsked() const override;
         void setQuestionAsked(const std::function<void(const std::string &)> &f) override;
@@ -272,8 +272,8 @@ class Engine : public IEngine
         bool m_stopEventLoop = false;
         std::mutex m_stopEventLoopMutex;
 
-        std::function<void(Monitor *)> m_addMonitorHandler = nullptr;
-        std::function<void(Monitor *, IMonitorHandler *)> m_removeMonitorHandler = nullptr;
+        sigslot::signal<Monitor *> m_monitorAdded;
+        sigslot::signal<Monitor *, IMonitorHandler *> m_monitorRemoved;
         std::function<void(const std::string &)> m_questionAsked = nullptr;
         std::function<void(const std::string &)> m_questionAnswered = nullptr;
 };

test/engine/engine_test.cpp

@@ -106,7 +106,7 @@ TEST(EngineTest, Clear)
 
     AddRemoveMonitorMock removeMonitorMock;
     auto handler = std::bind(&AddRemoveMonitorMock::monitorRemoved, &removeMonitorMock, std::placeholders::_1, std::placeholders::_2);
-    engine.setRemoveMonitorHandler(std::function<void(Monitor *, IMonitorHandler *)>(handler));
+    engine.monitorRemoved().connect(handler);
     engine.setMonitors({ monitor1, monitor2, monitor3, monitor4 });
 
     EXPECT_CALL(removeMonitorMock, monitorRemoved(monitor1.get(), &iface1));
@@ -1581,7 +1581,7 @@ TEST(EngineTest, Monitors)
 
     AddRemoveMonitorMock addMonitorMock;
     auto handler = std::bind(&AddRemoveMonitorMock::monitorAdded, &addMonitorMock, std::placeholders::_1);
-    engine.setAddMonitorHandler(std::function<void(Monitor *)>(handler));
+    engine.monitorAdded().connect(handler);
     engine.setMonitors({});
 
     EXPECT_CALL(addMonitorMock, monitorAdded(m1.get()));
@@ -1691,7 +1691,7 @@ TEST(EngineTest, CreateMissingMonitors)
         Engine engine;
         AddRemoveMonitorMock addMonitorMock;
         auto handler = std::bind(&AddRemoveMonitorMock::monitorAdded, &addMonitorMock, std::placeholders::_1);
-        engine.setAddMonitorHandler(std::function<void(Monitor *)>(handler));
+        engine.monitorAdded().connect(handler);
 
         EXPECT_CALL(addMonitorMock, monitorAdded(m1.get()));
         EXPECT_CALL(addMonitorMock, monitorAdded(m2.get()));

test/mocks/enginemock.h

@@ -124,8 +124,8 @@ class EngineMock : public IEngine
 
         MOCK_METHOD(const std::vector<std::shared_ptr<Monitor>> &, monitors, (), (const, override));
         MOCK_METHOD(void, setMonitors, (const std::vector<std::shared_ptr<Monitor>> &), (override));
-        MOCK_METHOD(void, setAddMonitorHandler, (const std::function<void(Monitor *)> &), (override));
-        MOCK_METHOD(void, setRemoveMonitorHandler, (const std::function<void(Monitor *, IMonitorHandler *)> &), (override));
+        MOCK_METHOD(sigslot::signal<Monitor *> &, monitorAdded, (), (override));
+        MOCK_METHOD((sigslot::signal<Monitor *, IMonitorHandler *> &), monitorRemoved, (), (override));
 
         MOCK_METHOD(const std::function<void(const std::string &)> &, questionAsked, (), (const, override));
         MOCK_METHOD(void, setQuestionAsked, (const std::function<void(const std::string &)> &), (override));