Engine: Add support for sending broadcasts by pointer

Author: adazem009

include/scratchcpp/iengine.h

@@ -65,6 +65,9 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Starts the script of the broadcast with the given index. */
         virtual void broadcast(unsigned int index, VirtualMachine *sourceScript, bool wait = false) = 0;
 
+        /*! Starts the script of the given broadcast. */
+        virtual void broadcastByPtr(Broadcast *broadcast, VirtualMachine *sourceScript, bool wait = false) = 0;
+
         /*! Stops the given script. */
         virtual void stopScript(VirtualMachine *vm) = 0;
 
@@ -122,6 +125,9 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Returns true if there are any running script of the broadcast with the given index. */
         virtual bool broadcastRunning(unsigned int index, VirtualMachine *sourceScript) = 0;
 
+        /*! Returns true if there are any running script of the given broadcast. */
+        virtual bool broadcastByPtrRunning(Broadcast *broadcast, VirtualMachine *sourceScript) = 0;
+
         /*!
          * Call this from a block implementation to force a "screen refresh".
          * \note This has no effect in "run without screen refresh" custom blocks.

src/engine/internal/engine.cpp

@@ -13,6 +13,7 @@
 #include <scratchcpp/block.h>
 #include <scratchcpp/variable.h>
 #include <scratchcpp/list.h>
+#include <scratchcpp/costume.h>
 #include <cassert>
 #include <iostream>
 #include <thread>
@@ -208,9 +209,13 @@ void Engine::startScript(std::shared_ptr<Block> topLevelBlock, std::shared_ptr<T
 
 void Engine::broadcast(unsigned int index, VirtualMachine *sourceScript, bool wait)
 {
+    if (index < 0 || index >= m_broadcasts.size())
+        return;
+
     bool previousSkipFrame = m_skipFrame;
     skipFrame();
     const std::vector<Script *> &scripts = m_broadcastMap[index];
+    auto broadcast = m_broadcasts[index];
 
     for (auto script : scripts) {
         std::vector<VirtualMachine *> runningBroadcastScripts;
@@ -229,7 +234,7 @@ void Engine::broadcast(unsigned int index, VirtualMachine *sourceScript, bool wa
             m_scriptsToRemove.erase(std::remove(m_scriptsToRemove.begin(), m_scriptsToRemove.end(), vm), m_scriptsToRemove.end());
             assert(std::find(m_scriptsToRemove.begin(), m_scriptsToRemove.end(), vm) == m_scriptsToRemove.end());
 
-            auto &scripts = m_runningBroadcastMap[index];
+            auto &scripts = m_runningBroadcastMap[broadcast.get()];
 
             for (auto &pair : scripts) {
                 if (pair.second->script() == script)
@@ -264,12 +269,20 @@ void Engine::broadcast(unsigned int index, VirtualMachine *sourceScript, bool wa
             if (it == runningBroadcastScripts.end()) {
                 auto vm = script->start(target);
                 m_runningScripts.push_back(vm);
-                m_runningBroadcastMap[index].push_back({ sourceScript, vm.get() });
+                m_runningBroadcastMap[broadcast.get()].push_back({ sourceScript, vm.get() });
             }
         }
     }
 }
 
+void Engine::broadcastByPtr(Broadcast *broadcast, VirtualMachine *sourceScript, bool wait)
+{
+    auto it = std::find_if(m_broadcasts.begin(), m_broadcasts.end(), [broadcast](std::shared_ptr<Broadcast> b) { return b.get() == broadcast; });
+
+    if (it != m_broadcasts.end())
+        this->broadcast(it - m_broadcasts.begin(), sourceScript, wait);
+}
+
 void Engine::stopScript(VirtualMachine *vm)
 {
     assert(vm);
@@ -411,7 +424,20 @@ void Engine::setStageHeight(unsigned int height)
 
 bool Engine::broadcastRunning(unsigned int index, VirtualMachine *sourceScript)
 {
-    const auto &scripts = m_runningBroadcastMap[index];
+    if (index < 0 || index >= m_broadcasts.size())
+        return false;
+
+    return broadcastByPtrRunning(m_broadcasts[index].get(), sourceScript);
+}
+
+bool Engine::broadcastByPtrRunning(Broadcast *broadcast, VirtualMachine *sourceScript)
+{
+    auto it = m_runningBroadcastMap.find(broadcast);
+
+    if (it == m_runningBroadcastMap.cend())
+        return false;
+
+    const auto &scripts = it->second;
 
     for (const auto &pair : scripts) {
         if (pair.first == sourceScript)
@@ -570,6 +596,10 @@ int Engine::findBroadcastById(const std::string &broadcastId) const
 void Engine::addBroadcastScript(std::shared_ptr<Block> whenReceivedBlock, std::shared_ptr<Broadcast> broadcast)
 {
     auto id = findBroadcast(broadcast->name());
+
+    if (id == -1)
+        return;
+
     if (m_broadcastMap.count(id) == 1) {
         std::vector<Script *> &scripts = m_broadcastMap[id];
         // TODO: Do not allow adding existing scripts
@@ -579,7 +609,7 @@ void Engine::addBroadcastScript(std::shared_ptr<Block> whenReceivedBlock, std::s
 
         // Create a vector of running scripts for this broadcast
         // so we don't need to check if it's there
-        m_runningBroadcastMap[id] = {};
+        m_runningBroadcastMap[m_broadcasts[id].get()] = {};
     }
 }
 

src/engine/internal/engine.h

@@ -31,6 +31,7 @@ class Engine : public IEngine
         void stop() override;
         void startScript(std::shared_ptr<Block> topLevelBlock, std::shared_ptr<Target> target) override;
         void broadcast(unsigned int index, VirtualMachine *sourceScript, bool wait = false) override;
+        void broadcastByPtr(Broadcast *broadcast, VirtualMachine *sourceScript, bool wait = false) override;
         void stopScript(VirtualMachine *vm) override;
         void stopTarget(Target *target, VirtualMachine *exceptScript) override;
         void initClone(libscratchcpp::Sprite *clone) override;
@@ -54,6 +55,7 @@ class Engine : public IEngine
         void setStageHeight(unsigned int height) override;
 
         bool broadcastRunning(unsigned int index, VirtualMachine *sourceScript) override;
+        bool broadcastByPtrRunning(Broadcast *broadcast, VirtualMachine *sourceScript) override;
 
         void breakFrame() override;
         bool breakingCurrentFrame() override;
@@ -116,8 +118,8 @@ class Engine : public IEngine
         std::vector<std::shared_ptr<Target>> m_targets;
         std::vector<std::shared_ptr<Broadcast>> m_broadcasts;
         std::unordered_map<unsigned int, std::vector<Script *>> m_broadcastMap;
-        std::unordered_map<unsigned int, std::vector<std::pair<VirtualMachine *, VirtualMachine *>>> m_runningBroadcastMap; // source script, "when received" script
-        std::unordered_map<Target *, std::vector<Script *>> m_cloneInitScriptsMap;                                          // target (no clones), "when I start as a clone" scripts
+        std::unordered_map<Broadcast *, std::vector<std::pair<VirtualMachine *, VirtualMachine *>>> m_runningBroadcastMap; // source script, "when received" script
+        std::unordered_map<Target *, std::vector<Script *>> m_cloneInitScriptsMap;                                         // target (no clones), "when I start as a clone" scripts
         std::vector<std::string> m_extensions;
         std::vector<std::shared_ptr<VirtualMachine>> m_runningScripts;
         std::vector<VirtualMachine *> m_scriptsToRemove;

test/mocks/enginemock.h

@@ -19,6 +19,7 @@ class EngineMock : public IEngine
         MOCK_METHOD(void, stop, (), (override));
         MOCK_METHOD(void, startScript, (std::shared_ptr<Block>, std::shared_ptr<Target>), (override));
         MOCK_METHOD(void, broadcast, (unsigned int, VirtualMachine *, bool), (override));
+        MOCK_METHOD(void, broadcastByPtr, (Broadcast *, VirtualMachine *, bool), (override));
         MOCK_METHOD(void, stopScript, (VirtualMachine *), (override));
         MOCK_METHOD(void, stopTarget, (Target *, VirtualMachine *), (override));
         MOCK_METHOD(void, initClone, (Sprite *), (override));
@@ -42,6 +43,7 @@ class EngineMock : public IEngine
         MOCK_METHOD(void, setStageHeight, (unsigned int), (override));
 
         MOCK_METHOD(bool, broadcastRunning, (unsigned int, VirtualMachine *), (override));
+        MOCK_METHOD(bool, broadcastByPtrRunning, (Broadcast *, VirtualMachine *), (override));
 
         MOCK_METHOD(void, breakFrame, (), (override));
         MOCK_METHOD(bool, breakingCurrentFrame, (), (override));