Add a callback for monitor removed events

Author: adazem009

include/scratchcpp/iengine.h

@@ -24,6 +24,7 @@ class Script;
 class ITimer;
 class KeyEvent;
 class Monitor;
+class IMonitorHandler;
 
 /*!
  * \brief The IEngine interface provides an API for running Scratch projects.
@@ -310,6 +311,9 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Sets the function which is called when a monitor is added. */
         virtual void setAddMonitorHandler(const std::function<void(Monitor *)> &handler) = 0;
 
+        /*! Sets the function which is called when a monitor is removed. */
+        virtual void setRemoveMonitorHandler(const std::function<void(Monitor *, IMonitorHandler *)> &handler) = 0;
+
         /*! Returns the list of extension names. */
         virtual const std::vector<std::string> &extensions() const = 0;
 

include/scratchcpp/monitor.h

@@ -19,6 +19,8 @@ class MonitorPrivate;
 class LIBSCRATCHCPP_EXPORT Monitor : public Entity
 {
     public:
+        friend class Engine;
+
         enum class Mode
         {
             Default,

src/engine/internal/engine.cpp

@@ -29,6 +29,7 @@
 #include "blocks/standardblocks.h"
 #include "blocks/variableblocks.h"
 #include "blocks/listblocks.h"
+#include "scratch/monitor_p.h"
 
 using namespace libscratchcpp;
 
@@ -57,6 +58,11 @@ void Engine::clear()
 {
     stop();
 
+    if (m_removeMonitorHandler) {
+        for (auto monitor : m_monitors)
+            m_removeMonitorHandler(monitor.get(), monitor->impl->iface);
+    }
+
     m_sections.clear();
     m_targets.clear();
     m_broadcasts.clear();
@@ -1033,6 +1039,11 @@ void Engine::setAddMonitorHandler(const std::function<void(Monitor *)> &handler)
     m_addMonitorHandler = handler;
 }
 
+void Engine::setRemoveMonitorHandler(const std::function<void(Monitor *, IMonitorHandler *)> &handler)
+{
+    m_removeMonitorHandler = handler;
+}
+
 const std::vector<std::string> &Engine::extensions() const
 {
     return m_extensions;

src/engine/internal/engine.h

@@ -134,6 +134,7 @@ 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;
 
         const std::vector<std::string> &extensions() const override;
         void setExtensions(const std::vector<std::string> &newExtensions) override;
@@ -244,6 +245,7 @@ class Engine : public IEngine
         std::mutex m_stopEventLoopMutex;
 
         std::function<void(Monitor *)> m_addMonitorHandler = nullptr;
+        std::function<void(Monitor *, IMonitorHandler *)> m_removeMonitorHandler = nullptr;
 };
 
 } // namespace libscratchcpp

test/engine/engine_test.cpp

@@ -13,6 +13,7 @@
 #include <clockmock.h>
 #include <audioplayerfactorymock.h>
 #include <audioplayermock.h>
+#include <monitorhandlermock.h>
 #include <thread>
 
 #include "../common.h"
@@ -38,10 +39,11 @@ class RedrawMock
         MOCK_METHOD(void, redraw, ());
 };
 
-class AddMonitorMock
+class AddRemoveMonitorMock
 {
     public:
         MOCK_METHOD(void, monitorAdded, (Monitor *));
+        MOCK_METHOD(void, monitorRemoved, (Monitor *, IMonitorHandler *));
 };
 
 TEST(EngineTest, Clock)
@@ -65,11 +67,36 @@ TEST(EngineTest, Clear)
     auto section = std::make_shared<TestSection>();
     engine.registerSection(section);
 
+    auto monitor1 = std::make_shared<Monitor>("", "");
+    auto monitor2 = std::make_shared<Monitor>("", "");
+    auto monitor3 = std::make_shared<Monitor>("", "");
+    auto monitor4 = std::make_shared<Monitor>("", "");
+
+    MonitorHandlerMock iface1, iface3, iface4;
+    EXPECT_CALL(iface1, init);
+    EXPECT_CALL(iface3, init);
+    EXPECT_CALL(iface4, init);
+    monitor1->setInterface(&iface1);
+    monitor3->setInterface(&iface3);
+    monitor4->setInterface(&iface4);
+
     engine.clear();
     ASSERT_TRUE(engine.targets().empty());
     ASSERT_TRUE(engine.broadcasts().empty());
     ASSERT_TRUE(engine.monitors().empty());
     ASSERT_TRUE(engine.registeredSections().empty());
+
+    AddRemoveMonitorMock removeMonitorMock;
+    auto handler = std::bind(&AddRemoveMonitorMock::monitorRemoved, &removeMonitorMock, std::placeholders::_1, std::placeholders::_2);
+    engine.setRemoveMonitorHandler(std::function<void(Monitor *, IMonitorHandler *)>(handler));
+    engine.setMonitors({ monitor1, monitor2, monitor3, monitor4 });
+
+    EXPECT_CALL(removeMonitorMock, monitorRemoved(monitor1.get(), &iface1));
+    EXPECT_CALL(removeMonitorMock, monitorRemoved(monitor2.get(), nullptr));
+    EXPECT_CALL(removeMonitorMock, monitorRemoved(monitor3.get(), &iface3));
+    EXPECT_CALL(removeMonitorMock, monitorRemoved(monitor4.get(), &iface4));
+    engine.clear();
+    ASSERT_TRUE(engine.monitors().empty());
 }
 
 TEST(EngineTest, IsRunning)
@@ -1154,8 +1181,8 @@ TEST(EngineTest, Monitors)
     engine.setMonitors({ m1, m2, m3 });
     ASSERT_EQ(engine.monitors(), std::vector<std::shared_ptr<Monitor>>({ m1, m2, m3 }));
 
-    AddMonitorMock addMonitorMock;
-    auto handler = std::bind(&AddMonitorMock::monitorAdded, &addMonitorMock, std::placeholders::_1);
+    AddRemoveMonitorMock addMonitorMock;
+    auto handler = std::bind(&AddRemoveMonitorMock::monitorAdded, &addMonitorMock, std::placeholders::_1);
     engine.setAddMonitorHandler(std::function<void(Monitor *)>(handler));
     engine.setMonitors({});
 
@@ -1264,8 +1291,8 @@ TEST(EngineTest, CreateMissingMonitors)
 
     {
         Engine engine;
-        AddMonitorMock addMonitorMock;
-        auto handler = std::bind(&AddMonitorMock::monitorAdded, &addMonitorMock, std::placeholders::_1);
+        AddRemoveMonitorMock addMonitorMock;
+        auto handler = std::bind(&AddRemoveMonitorMock::monitorAdded, &addMonitorMock, std::placeholders::_1);
         engine.setAddMonitorHandler(std::function<void(Monitor *)>(handler));
 
         EXPECT_CALL(addMonitorMock, monitorAdded(m1.get()));

test/mocks/enginemock.h

@@ -115,6 +115,7 @@ 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(std::vector<std::string> &, extensions, (), (const, override));
         MOCK_METHOD(void, setExtensions, (const std::vector<std::string> &), (override));