Merge pull request #554 from scratchcpp/clear_things_on_stop

Clear questions, text bubbles and graphic effects when project/thread stops

Author: adazem009

include/scratchcpp/iengine.h

@@ -370,6 +370,9 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Emits when a question is asked, for example using the 'ask and wait' block. */
         virtual sigslot::signal<const std::string &> &questionAsked() = 0;
 
+        /*! Emits when the current question is aborted. */
+        virtual sigslot::signal<> &questionAborted() = 0;
+
         /*! Emits when a question is answered. */
         virtual sigslot::signal<const std::string &> &questionAnswered() = 0;
 

src/blocks/looksblocks.cpp

@@ -103,6 +103,15 @@ void LooksBlocks::onInit(IEngine *engine)
         m_timeMap.erase(vm);
         erase_if(m_waitingBubbles, [vm](const std::pair<Target *, VirtualMachine *> &pair) { return pair.second == vm; });
     });
+
+    engine->stopped().connect([engine]() {
+        const auto &targets = engine->targets();
+
+        for (auto target : targets) {
+            target->setBubbleText("");
+            target->clearGraphicsEffects();
+        }
+    });
 }
 
 void LooksBlocks::compileSayForSecs(Compiler *compiler)

src/blocks/sensingblocks.cpp

@@ -95,6 +95,22 @@ void SensingBlocks::registerBlocks(IEngine *engine)
     engine->questionAnswered().connect(&onAnswer);
 }
 
+void SensingBlocks::onInit(IEngine *engine)
+{
+    engine->threadAboutToStop().connect([engine](VirtualMachine *thread) {
+        if (!m_questionList.empty()) {
+            // Abort the question of this thread if it's currently being displayed
+            if (m_questionList.front()->vm == thread) {
+                thread->target()->setBubbleText("");
+                engine->questionAborted()();
+            }
+
+            m_questionList
+                .erase(std::remove_if(m_questionList.begin(), m_questionList.end(), [thread](const std::unique_ptr<Question> &question) { return question->vm == thread; }), m_questionList.end());
+        }
+    });
+}
+
 void SensingBlocks::compileTouchingObject(Compiler *compiler)
 {
     Input *input = compiler->input(TOUCHINGOBJECTMENU);

src/blocks/sensingblocks.h

@@ -60,6 +60,7 @@ class SensingBlocks : public IBlockSection
         std::string name() const override;
 
         void registerBlocks(IEngine *engine) override;
+        void onInit(IEngine *engine) override;
 
         static void compileTouchingObject(Compiler *compiler);
         static void compileTouchingColor(Compiler *compiler);

src/engine/internal/engine.cpp

@@ -1349,6 +1349,11 @@ sigslot::signal<const std::string &> &Engine::questionAsked()
     return m_questionAsked;
 }
 
+sigslot::signal<> &Engine::questionAborted()
+{
+    return m_questionAborted;
+}
+
 sigslot::signal<const std::string &> &Engine::questionAnswered()
 {
     return m_questionAnswered;

src/engine/internal/engine.h

@@ -154,6 +154,7 @@ class Engine : public IEngine
         sigslot::signal<Monitor *, IMonitorHandler *> &monitorRemoved() override;
 
         sigslot::signal<const std::string &> &questionAsked() override;
+        sigslot::signal<> &questionAborted() override;
         sigslot::signal<const std::string &> &questionAnswered() override;
 
         const std::vector<std::string> &extensions() const override;
@@ -284,6 +285,7 @@ class Engine : public IEngine
         sigslot::signal<Monitor *> m_monitorAdded;
         sigslot::signal<Monitor *, IMonitorHandler *> m_monitorRemoved;
         sigslot::signal<const std::string &> m_questionAsked;
+        sigslot::signal<> m_questionAborted;
         sigslot::signal<const std::string &> m_questionAnswered;
 };
 

test/mocks/enginemock.h

@@ -134,6 +134,7 @@ class EngineMock : public IEngine
         MOCK_METHOD((sigslot::signal<Monitor *, IMonitorHandler *> &), monitorRemoved, (), (override));
 
         MOCK_METHOD(sigslot::signal<const std::string &> &, questionAsked, (), (override));
+        MOCK_METHOD(sigslot::signal<> &, questionAborted, (), (override));
         MOCK_METHOD(sigslot::signal<const std::string &> &, questionAnswered, (), (override));
 
         MOCK_METHOD(std::vector<std::string> &, extensions, (), (const, override));