Add lockFrame method to Engine

Author: adazem009

include/scratchcpp/iengine.h

@@ -97,6 +97,9 @@ class LIBSCRATCHCPP_EXPORT IEngine
          */
         virtual void skipFrame() = 0;
 
+        /*! Call this from a block implementation to ignore calls to skipFrame() until the current frame ends. */
+        virtual void lockFrame() = 0;
+
         /*!
          * Registers the given block section.
          * \see <a href="blockSections.html">Block sections</a>

src/engine/engine.cpp

@@ -119,6 +119,8 @@ void Engine::compile()
 
 void Engine::frame()
 {
+    m_lockFrame = false;
+
     for (int i = 0; i < m_runningScripts.size(); i++) {
         auto script = m_runningScripts[i];
         m_breakFrame = false;
@@ -310,8 +312,16 @@ bool libscratchcpp::Engine::breakingCurrentFrame()
 
 void Engine::skipFrame()
 {
-    breakFrame();
-    m_skipFrame = true;
+    if (!m_lockFrame) {
+        breakFrame();
+        m_skipFrame = true;
+    }
+}
+
+void Engine::lockFrame()
+{
+    m_skipFrame = false;
+    m_lockFrame = true;
 }
 
 void Engine::registerSection(std::shared_ptr<IBlockSection> section)

src/engine/engine.h

@@ -41,6 +41,7 @@ class Engine : public IEngine
         bool breakingCurrentFrame() override;
 
         void skipFrame() override;
+        void lockFrame() override;
 
         void registerSection(std::shared_ptr<IBlockSection> section) override;
         unsigned int functionIndex(BlockFunc f) override;
@@ -92,6 +93,7 @@ class Engine : public IEngine
 
         bool m_breakFrame = false;
         bool m_skipFrame = false;
+        bool m_lockFrame = false;
 };
 
 } // namespace libscratchcpp

test/mocks/enginemock.h

@@ -29,6 +29,7 @@ class EngineMock : public IEngine
         MOCK_METHOD(bool, breakingCurrentFrame, (), (override));
 
         MOCK_METHOD(void, skipFrame, (), (override));
+        MOCK_METHOD(void, lockFrame, (), (override));
 
         MOCK_METHOD(void, registerSection, (std::shared_ptr<IBlockSection>), (override));
         MOCK_METHOD(unsigned int, functionIndex, (BlockFunc), (override));