Add a callback for monitor added events

Author: adazem009

include/scratchcpp/iengine.h

@@ -307,6 +307,9 @@ 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;
+
         /*! Returns the list of extension names. */
         virtual const std::vector<std::string> &extensions() const = 0;
 

src/engine/internal/engine.cpp

@@ -1013,12 +1013,25 @@ const std::vector<std::shared_ptr<Monitor>> &Engine::monitors() const
 
 void Engine::setMonitors(const std::vector<std::shared_ptr<Monitor>> &newMonitors)
 {
-    m_monitors = newMonitors;
+    if (m_addMonitorHandler) {
+        m_monitors.clear();
+
+        for (auto monitor : newMonitors) {
+            m_monitors.push_back(monitor);
+            m_addMonitorHandler(monitor.get());
+        }
+    } else
+        m_monitors = newMonitors;
 
     // Create missing monitors
     createMissingMonitors();
 }
 
+void Engine::setAddMonitorHandler(const std::function<void(Monitor *)> &handler)
+{
+    m_addMonitorHandler = handler;
+}
+
 const std::vector<std::string> &Engine::extensions() const
 {
     return m_extensions;
@@ -1356,12 +1369,14 @@ void Engine::addVarOrListMonitor(std::shared_ptr<Monitor> monitor, Target *targe
     monitor->setVisible(false);
 
     // Auto-position the monitor
-    // TODO: Get width and height from renderer
     Rect rect = Monitor::getInitialPosition(m_monitors, monitor->width(), monitor->height());
     monitor->setX(rect.left());
     monitor->setY(rect.top());
 
     m_monitors.push_back(monitor);
+
+    if (m_addMonitorHandler)
+        m_addMonitorHandler(monitor.get());
 }
 
 void Engine::updateFrameDuration()

src/engine/internal/engine.h

@@ -133,6 +133,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;
 
         const std::vector<std::string> &extensions() const override;
         void setExtensions(const std::vector<std::string> &newExtensions) override;
@@ -241,6 +242,8 @@ class Engine : public IEngine
         std::function<void()> m_redrawHandler = nullptr;
         bool m_stopEventLoop = false;
         std::mutex m_stopEventLoopMutex;
+
+        std::function<void(Monitor *)> m_addMonitorHandler = nullptr;
 };
 
 } // namespace libscratchcpp

test/engine/engine_test.cpp

@@ -27,6 +27,8 @@
 using namespace libscratchcpp;
 
 using ::testing::Return;
+using ::testing::SaveArg;
+using ::testing::_;
 
 // NOTE: resolveIds() and compile() are tested in load_project_test
 
@@ -36,6 +38,12 @@ class RedrawMock
         MOCK_METHOD(void, redraw, ());
 };
 
+class AddMonitorMock
+{
+    public:
+        MOCK_METHOD(void, monitorAdded, (Monitor *));
+};
+
 TEST(EngineTest, Clock)
 {
     Engine engine;
@@ -1144,6 +1152,16 @@ 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);
+    engine.setAddMonitorHandler(std::function<void(Monitor *)>(handler));
+    engine.setMonitors({});
+
+    EXPECT_CALL(addMonitorMock, monitorAdded(m1.get()));
+    EXPECT_CALL(addMonitorMock, monitorAdded(m2.get()));
+    EXPECT_CALL(addMonitorMock, monitorAdded(m3.get()));
+    engine.setMonitors({ m1, m2, m3 });
 }
 
 TEST(EngineTest, CreateMissingMonitors)
@@ -1242,6 +1260,29 @@ TEST(EngineTest, CreateMissingMonitors)
         checkVariableMonitor(monitors[5], var4);
         checkVariableMonitor(monitors[6], var5);
     }
+
+    {
+        Engine engine;
+        AddMonitorMock addMonitorMock;
+        auto handler = std::bind(&AddMonitorMock::monitorAdded, &addMonitorMock, std::placeholders::_1);
+        engine.setAddMonitorHandler(std::function<void(Monitor *)>(handler));
+
+        EXPECT_CALL(addMonitorMock, monitorAdded(m1.get()));
+        EXPECT_CALL(addMonitorMock, monitorAdded(m2.get()));
+        EXPECT_CALL(addMonitorMock, monitorAdded(m3.get()));
+        engine.setMonitors({ m1, m2, m3 });
+
+        Monitor *m4, *m5, *m6, *m7;
+        EXPECT_CALL(addMonitorMock, monitorAdded(_)).WillOnce(SaveArg<0>(&m4)).WillOnce(SaveArg<0>(&m5)).WillOnce(SaveArg<0>(&m6)).WillOnce(SaveArg<0>(&m7));
+        engine.setTargets({ target1, target2 });
+
+        const auto &monitors = engine.monitors();
+        ASSERT_EQ(monitors.size(), 7);
+        ASSERT_EQ(monitors[3].get(), m4);
+        ASSERT_EQ(monitors[4].get(), m5);
+        ASSERT_EQ(monitors[5].get(), m6);
+        ASSERT_EQ(monitors[6].get(), m7);
+    }
 }
 
 TEST(EngineTest, Clones)

test/mocks/enginemock.h

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