Add question callbacks to IEngine

Author: adazem009

include/scratchcpp/iengine.h

@@ -338,6 +338,18 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Sets the function which is called when a monitor is removed. */
         virtual void setRemoveMonitorHandler(const std::function<void(Monitor *, IMonitorHandler *)> &handler) = 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;
+
+        /*! Sets the function which is called when a question is asked, for example using the 'ask and wait' block. */
+        virtual void setQuestionAsked(const std::function<void(const std::string &)> &f) = 0;
+
+        /*! Returns the function which should be called when a question is answered. */
+        virtual const std::function<void(const std::string &)> &questionAnswered() const = 0;
+
+        /*! Sets the function which should be called when a question is answered. */
+        virtual void setQuestionAnswered(const std::function<void(const std::string &)> &f) = 0;
+
         /*! Returns the list of extension names. */
         virtual const std::vector<std::string> &extensions() const = 0;
 

src/engine/internal/engine.cpp

@@ -1170,6 +1170,26 @@ void Engine::setRemoveMonitorHandler(const std::function<void(Monitor *, IMonito
     m_removeMonitorHandler = handler;
 }
 
+const std::function<void(const std::string &)> &Engine::questionAsked() const
+{
+    return m_questionAsked;
+}
+
+void Engine::setQuestionAsked(const std::function<void(const std::string &)> &f)
+{
+    m_questionAsked = f;
+}
+
+const std::function<void(const std::string &)> &Engine::questionAnswered() const
+{
+    return m_questionAnswered;
+}
+
+void Engine::setQuestionAnswered(const std::function<void(const std::string &)> &f)
+{
+    m_questionAnswered = f;
+}
+
 const std::vector<std::string> &Engine::extensions() const
 {
     return m_extensions;

src/engine/internal/engine.h

@@ -143,6 +143,12 @@ class Engine : public IEngine
         void setAddMonitorHandler(const std::function<void(Monitor *)> &handler) override;
         void setRemoveMonitorHandler(const std::function<void(Monitor *, IMonitorHandler *)> &handler) override;
 
+        const std::function<void(const std::string &)> &questionAsked() const override;
+        void setQuestionAsked(const std::function<void(const std::string &)> &f) override;
+
+        const std::function<void(const std::string &)> &questionAnswered() const override;
+        void setQuestionAnswered(const std::function<void(const std::string &)> &f) override;
+
         const std::vector<std::string> &extensions() const override;
         void setExtensions(const std::vector<std::string> &newExtensions) override;
 
@@ -255,6 +261,8 @@ class Engine : public IEngine
 
         std::function<void(Monitor *)> m_addMonitorHandler = nullptr;
         std::function<void(Monitor *, IMonitorHandler *)> m_removeMonitorHandler = nullptr;
+        std::function<void(const std::string &)> m_questionAsked = nullptr;
+        std::function<void(const std::string &)> m_questionAnswered = nullptr;
 };
 
 } // namespace libscratchcpp

test/engine/engine_test.cpp

@@ -51,6 +51,14 @@ class AddRemoveMonitorMock
         MOCK_METHOD(void, monitorRemoved, (Monitor *, IMonitorHandler *));
 };
 
+template<typename T, typename... U>
+size_t getAddress(std::function<T(U...)> f)
+{
+    typedef T(fnType)(U...);
+    fnType **fnPointer = f.template target<fnType *>();
+    return (size_t)*fnPointer;
+}
+
 TEST(EngineTest, Clock)
 {
     Engine engine;
@@ -1542,6 +1550,30 @@ TEST(EngineTest, CreateMissingMonitors)
     }
 }
 
+void questionFunction(const std::string &)
+{
+}
+
+TEST(EngineTest, QuestionAsked)
+{
+    Engine engine;
+    ASSERT_EQ(engine.questionAsked(), nullptr);
+
+    static const std::function<void(const std::string &)> f = &questionFunction;
+    engine.setQuestionAsked(&questionFunction);
+    ASSERT_EQ(getAddress(engine.questionAsked()), getAddress(f));
+}
+
+TEST(EngineTest, QuestionAnswered)
+{
+    Engine engine;
+    ASSERT_EQ(engine.questionAnswered(), nullptr);
+
+    static const std::function<void(const std::string &)> f = &questionFunction;
+    engine.setQuestionAnswered(f);
+    ASSERT_EQ(getAddress(engine.questionAnswered()), getAddress(f));
+}
+
 TEST(EngineTest, Clones)
 {
     Project p("clones.sb3");

test/mocks/enginemock.h

@@ -124,6 +124,12 @@ class EngineMock : public IEngine
         MOCK_METHOD(void, setAddMonitorHandler, (const std::function<void(Monitor *)> &), (override));
         MOCK_METHOD(void, setRemoveMonitorHandler, (const std::function<void(Monitor *, IMonitorHandler *)> &), (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));
+
+        MOCK_METHOD(const std::function<void(const std::string &)> &, questionAnswered, (), (const, override));
+        MOCK_METHOD(void, setQuestionAnswered, (const std::function<void(const std::string &)> &), (override));
+
         MOCK_METHOD(std::vector<std::string> &, extensions, (), (const, override));
         MOCK_METHOD(void, setExtensions, (const std::vector<std::string> &), (override));