Add key state methods to IEngine

Author: adazem009

include/scratchcpp/iengine.h

@@ -98,6 +98,12 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Sets the framerate of the project. */
         virtual void setFps(double fps) = 0;
 
+        /*! Returns true if the given key is pressed. */
+        virtual bool keyPressed(std::string name) const = 0;
+
+        /*! Sets the state of the given key. */
+        virtual void setKeyState(std::string name, bool pressed) = 0;
+
         /*! Returns the X coordinate of the mouse pointer. */
         virtual double mouseX() const = 0;
 

src/engine/internal/engine.cpp

@@ -378,6 +378,23 @@ void Engine::setFps(double fps)
     updateFrameDuration();
 }
 
+bool Engine::keyPressed(std::string name) const
+{
+    std::transform(name.begin(), name.end(), name.begin(), ::tolower);
+    auto it = m_keyMap.find(name);
+
+    if (it == m_keyMap.cend())
+        return false;
+    else
+        return it->second;
+}
+
+void Engine::setKeyState(std::string name, bool pressed)
+{
+    std::transform(name.begin(), name.end(), name.begin(), ::tolower);
+    m_keyMap[name] = pressed;
+}
+
 double Engine::mouseX() const
 {
     return m_mouseX;

src/engine/internal/engine.h

@@ -42,6 +42,9 @@ class Engine : public IEngine
         double fps() const override;
         void setFps(double fps) override;
 
+        bool keyPressed(std::string name) const override;
+        void setKeyState(std::string name, bool pressed) override;
+
         double mouseX() const override;
         void setMouseX(double x) override;
 
@@ -130,8 +133,9 @@ class Engine : public IEngine
 
         std::unique_ptr<ITimer> m_defaultTimer;
         ITimer *m_timer = nullptr;
-        double m_fps = 30;                         // default FPS
-        std::chrono::milliseconds m_frameDuration; // will be computed in run()
+        double m_fps = 30;                              // default FPS
+        std::chrono::milliseconds m_frameDuration;      // will be computed in run()
+        std::unordered_map<std::string, bool> m_keyMap; // holds key states
         double m_mouseX = 0;
         double m_mouseY = 0;
         unsigned int m_stageWidth = 480;

test/engine/engine_test.cpp

@@ -61,6 +61,44 @@ TEST(EngineTest, Fps)
     ASSERT_EQ(engine.fps(), 60.25);
 }
 
+TEST(EngineTest, KeyState)
+{
+    Engine engine;
+    ASSERT_FALSE(engine.keyPressed("a"));
+    ASSERT_FALSE(engine.keyPressed("b"));
+    ASSERT_FALSE(engine.keyPressed("up arrow"));
+
+    engine.setKeyState("a", true);
+    ASSERT_TRUE(engine.keyPressed("a"));
+    ASSERT_FALSE(engine.keyPressed("b"));
+    ASSERT_FALSE(engine.keyPressed("up arrow"));
+
+    engine.setKeyState("up arrow", true);
+    ASSERT_TRUE(engine.keyPressed("a"));
+    ASSERT_FALSE(engine.keyPressed("b"));
+    ASSERT_TRUE(engine.keyPressed("up arrow"));
+
+    engine.setKeyState("b", true);
+    ASSERT_TRUE(engine.keyPressed("a"));
+    ASSERT_TRUE(engine.keyPressed("b"));
+    ASSERT_TRUE(engine.keyPressed("up arrow"));
+
+    engine.setKeyState("a", false);
+    ASSERT_FALSE(engine.keyPressed("a"));
+    ASSERT_TRUE(engine.keyPressed("b"));
+    ASSERT_TRUE(engine.keyPressed("up arrow"));
+
+    engine.setKeyState("up arrow", false);
+    ASSERT_FALSE(engine.keyPressed("a"));
+    ASSERT_TRUE(engine.keyPressed("b"));
+    ASSERT_FALSE(engine.keyPressed("up arrow"));
+
+    engine.setKeyState("b", false);
+    ASSERT_FALSE(engine.keyPressed("a"));
+    ASSERT_FALSE(engine.keyPressed("b"));
+    ASSERT_FALSE(engine.keyPressed("up arrow"));
+}
+
 TEST(EngineTest, MouseX)
 {
     Engine engine;

test/mocks/enginemock.h

@@ -30,6 +30,9 @@ class EngineMock : public IEngine
         MOCK_METHOD(double, fps, (), (const, override));
         MOCK_METHOD(void, setFps, (double fps), (override));
 
+        MOCK_METHOD(bool, keyPressed, (std::string), (const, override));
+        MOCK_METHOD(void, setKeyState, (std::string, bool), (override));
+
         MOCK_METHOD(double, mouseX, (), (const, override));
         MOCK_METHOD(void, setMouseX, (double x), (override));