Add Clock class

Author: adazem009

src/engine/CMakeLists.txt

@@ -11,6 +11,9 @@ target_sources(scratchcpp
     script_p.h
     internal/engine.cpp
     internal/engine.h
+    internal/clock.cpp
+    internal/clock.h
+    internal/iclock.h
     internal/blocksectioncontainer.cpp
     internal/blocksectioncontainer.h
     internal/global.h

src/engine/internal/clock.cpp

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include "clock.h"
+
+using namespace libscratchcpp;
+
+std::shared_ptr<Clock> Clock::m_instance = std::make_shared<Clock>();
+
+Clock::Clock()
+{
+}
+
+std::shared_ptr<Clock> Clock::instance()
+{
+    return m_instance;
+}
+
+std::chrono::steady_clock::time_point Clock::currentTime() const
+{
+    return std::chrono::steady_clock::now();
+}

src/engine/internal/clock.h

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <memory>
+#include "iclock.h"
+
+namespace libscratchcpp
+{
+
+class Clock : public IClock
+{
+    public:
+        Clock();
+        Clock(const Clock &) = delete;
+
+        static std::shared_ptr<Clock> instance();
+
+        std::chrono::steady_clock::time_point currentTime() const override;
+
+    private:
+        static std::shared_ptr<Clock> m_instance;
+};
+
+} // namespace libscratchcpp

src/engine/internal/iclock.h

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <chrono>
+
+namespace libscratchcpp
+{
+
+class IClock
+{
+    public:
+        virtual ~IClock() { }
+
+        virtual std::chrono::steady_clock::time_point currentTime() const = 0;
+};
+
+} // namespace libscratchcpp

test/CMakeLists.txt

@@ -28,3 +28,4 @@ add_subdirectory(assets)
 add_subdirectory(script)
 add_subdirectory(extensions)
 add_subdirectory(engine)
+add_subdirectory(clock)

test/clock/CMakeLists.txt

@@ -0,0 +1,12 @@
+add_executable(
+  clock_test
+  clock_test.cpp
+)
+
+target_link_libraries(
+  clock_test
+  GTest::gtest_main
+  scratchcpp
+)
+
+gtest_discover_tests(clock_test)

test/clock/clock_test.cpp

@@ -0,0 +1,20 @@
+#include <engine/internal/clock.h>
+#include <cmath>
+
+#include "../common.h"
+
+using namespace libscratchcpp;
+
+TEST(ClockTest, CurrentTime)
+{
+    auto clock = Clock::instance();
+    ASSERT_TRUE(clock);
+
+    auto currentTime = std::chrono::time_point_cast<std::chrono::milliseconds>(std::chrono::steady_clock::now());
+    double currentTimeMs = std::round(currentTime.time_since_epoch().count() / 10) * 10;
+
+    auto reportedTime = std::chrono::time_point_cast<std::chrono::milliseconds>(clock->currentTime());
+    double reportedTimeMs = std::round(reportedTime.time_since_epoch().count() / 10) * 10;
+
+    ASSERT_EQ(reportedTimeMs, currentTimeMs);
+}

test/mocks/clockmock.h

@@ -0,0 +1,12 @@
+#pragma once
+
+#include <engine/internal/iclock.h>
+#include <gmock/gmock.h>
+
+using namespace libscratchcpp;
+
+class ClockMock : public IClock
+{
+    public:
+        MOCK_METHOD(std::chrono::steady_clock::time_point, currentTime, (), (const override));
+};