Complete the key state API

Author: adazem009

include/scratchcpp/iengine.h

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

src/engine/internal/engine.cpp

@@ -14,6 +14,7 @@
 #include <scratchcpp/variable.h>
 #include <scratchcpp/list.h>
 #include <scratchcpp/costume.h>
+#include <scratchcpp/keyevent.h>
 #include <cassert>
 #include <iostream>
 #include <thread>
@@ -378,21 +379,30 @@ void Engine::setFps(double fps)
     updateFrameDuration();
 }
 
-bool Engine::keyPressed(std::string name) const
+bool Engine::keyPressed(const std::string &name) const
 {
-    std::transform(name.begin(), name.end(), name.begin(), ::tolower);
-    auto it = m_keyMap.find(name);
+    if (name == "any") {
+        for (const auto &[key, value] : m_keyMap) {
+            if (value)
+                return true;
+        }
+
+        return false;
+    }
+
+    KeyEvent event(name);
+    auto it = m_keyMap.find(event.name());
 
     if (it == m_keyMap.cend())
         return false;
     else
         return it->second;
 }
 
-void Engine::setKeyState(std::string name, bool pressed)
+void Engine::setKeyState(const std::string &name, bool pressed)
 {
-    std::transform(name.begin(), name.end(), name.begin(), ::tolower);
-    m_keyMap[name] = pressed;
+    KeyEvent event(name);
+    m_keyMap[event.name()] = pressed;
 }
 
 double Engine::mouseX() const

src/engine/internal/engine.h

@@ -42,8 +42,8 @@ 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;
+        bool keyPressed(const std::string &name) const override;
+        void setKeyState(const std::string &name, bool pressed) override;
 
         double mouseX() const override;
         void setMouseX(double x) override;

test/engine/engine_test.cpp

@@ -67,36 +67,62 @@ TEST(EngineTest, KeyState)
     ASSERT_FALSE(engine.keyPressed("a"));
     ASSERT_FALSE(engine.keyPressed("b"));
     ASSERT_FALSE(engine.keyPressed("up arrow"));
+    ASSERT_FALSE(engine.keyPressed("any"));
 
-    engine.setKeyState("a", true);
+    engine.setKeyState("A", true);
     ASSERT_TRUE(engine.keyPressed("a"));
     ASSERT_FALSE(engine.keyPressed("b"));
     ASSERT_FALSE(engine.keyPressed("up arrow"));
+    ASSERT_TRUE(engine.keyPressed("any"));
 
     engine.setKeyState("up arrow", true);
     ASSERT_TRUE(engine.keyPressed("a"));
     ASSERT_FALSE(engine.keyPressed("b"));
     ASSERT_TRUE(engine.keyPressed("up arrow"));
+    ASSERT_FALSE(engine.keyPressed("U"));
+    ASSERT_TRUE(engine.keyPressed("any"));
 
+    engine.setKeyState("up arrow", false);
+    engine.setKeyState("UP arrow", true);
+    ASSERT_TRUE(engine.keyPressed("a"));
+    ASSERT_FALSE(engine.keyPressed("b"));
+    ASSERT_FALSE(engine.keyPressed("up arrow"));
+    ASSERT_TRUE(engine.keyPressed("u"));
+    ASSERT_TRUE(engine.keyPressed("U"));
+    ASSERT_TRUE(engine.keyPressed("any"));
+
+    engine.setKeyState("up arrow", true);
     engine.setKeyState("b", true);
     ASSERT_TRUE(engine.keyPressed("a"));
     ASSERT_TRUE(engine.keyPressed("b"));
     ASSERT_TRUE(engine.keyPressed("up arrow"));
+    ASSERT_TRUE(engine.keyPressed("any"));
 
     engine.setKeyState("a", false);
     ASSERT_FALSE(engine.keyPressed("a"));
     ASSERT_TRUE(engine.keyPressed("b"));
     ASSERT_TRUE(engine.keyPressed("up arrow"));
+    ASSERT_TRUE(engine.keyPressed("any"));
 
     engine.setKeyState("up arrow", false);
     ASSERT_FALSE(engine.keyPressed("a"));
     ASSERT_TRUE(engine.keyPressed("b"));
     ASSERT_FALSE(engine.keyPressed("up arrow"));
+    ASSERT_TRUE(engine.keyPressed("any"));
 
     engine.setKeyState("b", false);
     ASSERT_FALSE(engine.keyPressed("a"));
     ASSERT_FALSE(engine.keyPressed("b"));
     ASSERT_FALSE(engine.keyPressed("up arrow"));
+    ASSERT_TRUE(engine.keyPressed("any"));
+
+    engine.setKeyState("u", false);
+    ASSERT_FALSE(engine.keyPressed("any"));
+
+    engine.setKeyState("32", true);
+    ASSERT_TRUE(engine.keyPressed("32"));
+    ASSERT_TRUE(engine.keyPressed("space"));
+    ASSERT_TRUE(engine.keyPressed("any"));
 }
 
 TEST(EngineTest, MouseX)

test/mocks/enginemock.h

@@ -30,8 +30,8 @@ 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(bool, keyPressed, (const std::string &), (const, override));
+        MOCK_METHOD(void, setKeyState, (const std::string &, bool), (override));
 
         MOCK_METHOD(double, mouseX, (), (const, override));
         MOCK_METHOD(void, setMouseX, (double x), (override));