Partial refactor of VirtualController.

Author: Mysticial

SerialPrograms/CMakeLists.txt

@@ -609,6 +609,9 @@ file(GLOB MAIN_SOURCES
     Source/Controllers/ControllerSession.h
     Source/Controllers/ControllerSelectorWidget.cpp
     Source/Controllers/ControllerSelectorWidget.h
+    Source/Controllers/GlobalQtKeyMap.cpp
+    Source/Controllers/GlobalQtKeyMap.h
+    Source/Controllers/KeyboardStateTracker.h
     Source/Controllers/NullController.cpp
     Source/Controllers/NullController.h
     Source/Controllers/SuperscalarScheduler.cpp

SerialPrograms/SerialPrograms.pro

@@ -310,6 +310,7 @@ SOURCES += \
     Source/Controllers/ControllerSelectorWidget.cpp \
     Source/Controllers/ControllerSession.cpp \
     Source/Controllers/ControllerDescriptor.cpp \
+    Source/Controllers/GlobalQtKeyMap.cpp \
     Source/Controllers/NullController.cpp \
     Source/Controllers/SerialPABotBase/SerialPABotBase.cpp \
     Source/Controllers/SerialPABotBase/SerialPABotBase_Handle.cpp \
@@ -1426,6 +1427,8 @@ HEADERS += \
     Source/Controllers/ControllerSelectorWidget.h \
     Source/Controllers/ControllerSession.h \
     Source/Controllers/ControllerDescriptor.h \
+    Source/Controllers/GlobalQtKeyMap.h \
+    Source/Controllers/KeyboardStateTracker.h \
     Source/Controllers/NullController.h \
     Source/Controllers/SerialPABotBase/SerialPABotBase.h \
     Source/Controllers/SerialPABotBase/SerialPABotBase_Handle.h \

SerialPrograms/Source/CommonTools/InferenceCallbacks/VisualInferenceCallback.h

@@ -7,9 +7,7 @@
 #ifndef PokemonAutomation_CommonTools_VisualInferenceCallback_H
 #define PokemonAutomation_CommonTools_VisualInferenceCallback_H
 
-#include <memory>
 #include <string>
-#include "Common/Compiler.h"
 #include "Common/Cpp/Time.h"
 #include "InferenceCallback.h"
 

SerialPrograms/Source/Controllers/GlobalQtKeyMap.cpp

@@ -0,0 +1,40 @@
+/*  Global Qt Key Map
+ *
+ *  From: https://github.com/PokemonAutomation/Arduino-Source
+ *
+ */
+
+#include <QKeyEvent>
+#include "Common/Cpp/Exceptions.h"
+#include "Common/Cpp/Concurrency/SpinLock.h"
+#include "GlobalQtKeyMap.h"
+
+namespace PokemonAutomation{
+
+
+
+void QtKeyMap::record(const QKeyEvent& event){
+    uint32_t native_key = event.nativeVirtualKey();
+    if (native_key == 0){
+        return;
+    }
+    Qt::Key qkey = (Qt::Key)event.key();
+    WriteSpinLock lg(m_lock);
+    m_map[native_key].insert(qkey);
+}
+
+const std::set<Qt::Key>& QtKeyMap::get_QtKeys(uint32_t native_key) const{
+    ReadSpinLock lg(m_lock);
+    auto iter = m_map.find(native_key);
+    if (iter == m_map.end()){
+        throw InternalProgramError(
+            nullptr, PA_CURRENT_FUNCTION,
+            "Attempted to look up unrecognized native keyboard key: " + std::to_string(native_key)
+        );
+    }
+    return iter->second;
+}
+
+
+
+}

SerialPrograms/Source/Controllers/GlobalQtKeyMap.h

@@ -0,0 +1,45 @@
+/*  Global Qt Key Map
+ *
+ *  From: https://github.com/PokemonAutomation/Arduino-Source
+ *
+ */
+
+#ifndef PokemonAutomation_Controllers_GlobalQtKeyMap_H
+#define PokemonAutomation_Controllers_GlobalQtKeyMap_H
+
+#include <set>
+#include <map>
+#include <QKeyEvent>
+#include "Common/Cpp/Concurrency/SpinLock.h"
+
+namespace PokemonAutomation{
+
+
+
+
+class QtKeyMap{
+public:
+    static QtKeyMap& instance(){
+        static QtKeyMap map;
+        return map;
+    }
+
+    void record(const QKeyEvent& event);
+
+    const std::set<Qt::Key>& get_QtKeys(uint32_t native_key) const;
+
+
+private:
+    QtKeyMap() = default;
+
+
+private:
+    mutable SpinLock m_lock;
+    //  Map of native key to Qt's key ID.
+    std::map<uint32_t, std::set<Qt::Key>> m_map;
+};
+
+
+
+}
+#endif

SerialPrograms/Source/Controllers/KeyboardStateTracker.h

@@ -0,0 +1,107 @@
+/*  Keyboard State Tracker
+ *
+ *  From: https://github.com/PokemonAutomation/Arduino-Source
+ *
+ */
+
+#ifndef PokemonAutomation_Controllers_KeyboardStateTracker_H
+#define PokemonAutomation_Controllers_KeyboardStateTracker_H
+
+#include <deque>
+#include <set>
+#include "Common/Cpp/Time.h"
+
+namespace PokemonAutomation{
+
+
+
+class KeyboardStateTracker{
+public:
+    KeyboardStateTracker(std::chrono::milliseconds debounce_period = std::chrono::milliseconds(10))
+        : m_debounce_period(debounce_period)
+    {}
+
+
+public:
+    void clear(){
+        m_committed.clear();
+        m_pending.clear();
+    }
+    void press(uint32_t key){
+        WallClock now = current_time();
+        m_pending.emplace_back(Event{now, true, key});
+        move_old_events(now);
+    }
+    void release(uint32_t key){
+        WallClock now = current_time();
+        m_pending.emplace_back(Event{now, false, key});
+        move_old_events(now);
+    }
+
+
+public:
+    WallClock next_state_change() const{
+        return m_pending.empty()
+            ? WallClock::max()
+            : m_pending.begin()->timestamp + m_debounce_period;
+    }
+    std::set<uint32_t> get_currently_pressed(){
+        WallClock now = current_time();
+        move_old_events(now);
+
+        //  Copy the current committed set.
+        std::set<uint32_t> ret = m_committed;
+
+        //  Now process all the pending ones - ignoring the release events.
+        for (const Event& event : m_pending){
+            if (event.press){
+                ret.insert(event.key);
+            }
+        }
+
+        return ret;
+    }
+
+
+private:
+    //  Move all pending events that are old enough to the committed set.
+    void move_old_events(WallClock now){
+        WallClock threshold = now - m_debounce_period;
+        while (!m_pending.empty()){
+            Event& event = m_pending.front();
+
+            //  Always commit presses.
+            if (event.press){
+                m_committed.insert(event.key);
+                m_pending.pop_front();
+                continue;
+            }
+
+            //  Release is old enough. Commit it.
+            if (event.timestamp < threshold){
+                m_committed.erase(event.key);
+                m_pending.pop_front();
+                continue;
+            }
+
+            //  We've hit an uncommittable release. We're done.
+            break;
+        }
+    }
+
+
+private:
+    struct Event{
+        WallClock timestamp;
+        bool press;
+        uint32_t key;
+    };
+    std::chrono::milliseconds m_debounce_period;
+    std::set<uint32_t> m_committed;
+    std::deque<Event> m_pending;
+};
+
+
+
+}
+#endif

SerialPrograms/Source/Controllers/NullController.h

@@ -4,8 +4,8 @@
  *
  */
 
-#ifndef PokemonAutomation_Controllers_Null_H
-#define PokemonAutomation_Controllers_Null_H
+#ifndef PokemonAutomation_Controllers_NullController_H
+#define PokemonAutomation_Controllers_NullController_H
 
 #include "ControllerDescriptor.h"