Add timer to Engine

Author: adazem009

include/scratchcpp/iengine.h

@@ -19,6 +19,7 @@ class Sprite;
 class Variable;
 class List;
 class Script;
+class ITimer;
 
 /*!
  * \brief The IEngine interface provides an API for running Scratch projects.
@@ -106,6 +107,9 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Call this from a block implementation to ignore calls to skipFrame() until the current frame ends. */
         virtual void lockFrame() = 0;
 
+        /*! Returns the timer of the project. */
+        virtual ITimer *timer() const = 0;
+
         /*!
          * Registers the given block section.
          * \see <a href="blockSections.html">Block sections</a>

src/engine/internal/engine.cpp

@@ -18,11 +18,14 @@
 
 #include "engine.h"
 #include "blocksectioncontainer.h"
+#include "timer.h"
 #include "../../blocks/standardblocks.h"
 
 using namespace libscratchcpp;
 
-Engine::Engine()
+Engine::Engine() :
+    m_defaultTimer(std::make_unique<Timer>()),
+    m_timer(m_defaultTimer.get())
 {
     srand(time(NULL));
 }
@@ -165,6 +168,8 @@ void Engine::frame()
 
 void Engine::start()
 {
+    m_timer->reset();
+
     for (auto target : m_targets) {
         auto gfBlocks = target->greenFlagBlocks();
         for (auto block : gfBlocks)
@@ -377,6 +382,16 @@ void Engine::lockFrame()
     m_lockFrame = true;
 }
 
+ITimer *Engine::timer() const
+{
+    return m_timer;
+}
+
+void Engine::setTimer(ITimer *timer)
+{
+    m_timer = timer;
+}
+
 void Engine::registerSection(std::shared_ptr<IBlockSection> section)
 {
     if (section) {

src/engine/internal/engine.h

@@ -4,6 +4,7 @@
 
 #include <scratchcpp/iengine.h>
 #include <scratchcpp/target.h>
+#include <scratchcpp/itimer.h>
 #include <unordered_map>
 #include <memory>
 #include <chrono>
@@ -43,6 +44,9 @@ class Engine : public IEngine
         void skipFrame() override;
         void lockFrame() override;
 
+        ITimer *timer() const override;
+        void setTimer(ITimer *timer);
+
         void registerSection(std::shared_ptr<IBlockSection> section) override;
         std::vector<std::shared_ptr<IBlockSection>> registeredSections() const;
         unsigned int functionIndex(BlockFunc f) override;
@@ -101,6 +105,9 @@ class Engine : public IEngine
         std::unordered_map<Variable *, Target *> m_variableOwners;
         std::unordered_map<List *, Target *> m_listOwners;
 
+        std::unique_ptr<ITimer> m_defaultTimer;
+        ITimer *m_timer = nullptr;
+
         bool m_breakFrame = false;
         bool m_skipFrame = false;
         bool m_lockFrame = false;

test/engine/CMakeLists.txt

@@ -8,7 +8,9 @@ add_executable(
 target_link_libraries(
   engine_test
   GTest::gtest_main
+  GTest::gmock_main
   scratchcpp
+  scratchcpp_mocks
 )
 
 gtest_discover_tests(engine_test)

test/engine/engine_test.cpp

@@ -3,6 +3,7 @@
 #include <scratchcpp/project.h>
 #include <scratchcpp/variable.h>
 #include <scratchcpp/list.h>
+#include <timermock.h>
 
 #include "../common.h"
 #include "testsection.h"
@@ -42,6 +43,26 @@ TEST(EngineTest, BreakFrame)
     ASSERT_TRUE(engine.breakingCurrentFrame());
 }
 
+TEST(EngineTest, Timer)
+{
+    Engine engine;
+    ASSERT_TRUE(engine.timer());
+    engine.timer()->reset(); // shouldn't crash
+
+    TimerMock timer;
+    engine.setTimer(&timer);
+    ASSERT_EQ(engine.timer(), &timer);
+
+    EXPECT_CALL(timer, reset()).Times(1);
+    engine.start();
+
+    EXPECT_CALL(timer, reset()).Times(0);
+    engine.stop();
+
+    EXPECT_CALL(timer, reset()).Times(1);
+    engine.run();
+}
+
 TEST(EngineTest, Sections)
 {
     Engine engine;

test/mocks/enginemock.h

@@ -32,6 +32,8 @@ class EngineMock : public IEngine
         MOCK_METHOD(void, skipFrame, (), (override));
         MOCK_METHOD(void, lockFrame, (), (override));
 
+        MOCK_METHOD(ITimer *, timer, (), (const, override));
+
         MOCK_METHOD(void, registerSection, (std::shared_ptr<IBlockSection>), (override));
         MOCK_METHOD(unsigned int, functionIndex, (BlockFunc), (override));