Add hotkey settings

scwx-qt/source/scwx/qt/settings/hotkey_settings.cpp

@@ -0,0 +1,117 @@
+#include <scwx/qt/settings/hotkey_settings.hpp>
+
+#include <QKeySequence>
+
+namespace scwx
+{
+namespace qt
+{
+namespace settings
+{
+
+static const std::string logPrefix_ = "scwx::qt::settings::hotkey_settings";
+
+static const std::unordered_map<types::Hotkey, QKeySequence> kDefaultHotkeys_ {
+   {types::Hotkey::ChangeMapStyle, QKeySequence {Qt::Key::Key_Z}},
+   {types::Hotkey::CopyCursorCoordinates,
+    QKeySequence {QKeyCombination {Qt::KeyboardModifier::ControlModifier,
+                                   Qt::Key::Key_C}}},
+   {types::Hotkey::CopyMapCoordinates,
+    QKeySequence {QKeyCombination {Qt::KeyboardModifier::ControlModifier |
+                                      Qt::KeyboardModifier::ShiftModifier,
+                                   Qt::Key::Key_C}}},
+   {types::Hotkey::MapPanUp, QKeySequence {Qt::Key::Key_W}},
+   {types::Hotkey::MapPanDown, QKeySequence {Qt::Key::Key_S}},
+   {types::Hotkey::MapPanLeft, QKeySequence {Qt::Key::Key_A}},
+   {types::Hotkey::MapPanRight, QKeySequence {Qt::Key::Key_D}},
+   {types::Hotkey::MapRotateClockwise, QKeySequence {Qt::Key::Key_E}},
+   {types::Hotkey::MapRotateCounterclockwise, QKeySequence {Qt::Key::Key_Q}},
+   {types::Hotkey::MapZoomIn, QKeySequence {Qt::Key::Key_Equal}},
+   {types::Hotkey::MapZoomOut, QKeySequence {Qt::Key::Key_Minus}},
+   {types::Hotkey::ProductTiltDecrease,
+    QKeySequence {Qt::Key::Key_BracketLeft}},
+   {types::Hotkey::ProductTiltIncrease,
+    QKeySequence {Qt::Key::Key_BracketRight}},
+   {types::Hotkey::Unknown, QKeySequence {}}};
+
+static bool IsHotkeyValid(const std::string& value);
+
+class HotkeySettings::Impl
+{
+public:
+   explicit Impl()
+   {
+      for (const auto& hotkey : types::HotkeyIterator())
+      {
+         const std::string& name = types::GetHotkeyShortName(hotkey);
+         const std::string  defaultValue =
+            kDefaultHotkeys_.at(hotkey).toString().toStdString();
+
+         auto result =
+            hotkey_.emplace(hotkey, SettingsVariable<std::string> {name});
+
+         SettingsVariable<std::string>& settingsVariable = result.first->second;
+
+         settingsVariable.SetDefault(defaultValue);
+         settingsVariable.SetValidator(&IsHotkeyValid);
+
+         variables_.push_back(&settingsVariable);
+      }
+
+      // Add an empty hotkey (not part of registered variables) for error
+      // handling
+      hotkey_.emplace(types::Hotkey::Unknown,
+                      SettingsVariable<std::string> {"?"});
+   }
+
+   ~Impl() {}
+
+   std::unordered_map<types::Hotkey, SettingsVariable<std::string>> hotkey_ {};
+   std::vector<SettingsVariableBase*> variables_ {};
+};
+
+HotkeySettings::HotkeySettings() :
+    SettingsCategory("hotkeys"), p(std::make_unique<Impl>())
+{
+   RegisterVariables(p->variables_);
+   SetDefaults();
+
+   p->variables_.clear();
+}
+HotkeySettings::~HotkeySettings() = default;
+
+HotkeySettings::HotkeySettings(HotkeySettings&&) noexcept            = default;
+HotkeySettings& HotkeySettings::operator=(HotkeySettings&&) noexcept = default;
+
+SettingsVariable<std::string>&
+HotkeySettings::hotkey(scwx::qt::types::Hotkey hotkey) const
+{
+   auto hotkeyVariable = p->hotkey_.find(hotkey);
+   if (hotkeyVariable == p->hotkey_.cend())
+   {
+      hotkeyVariable = p->hotkey_.find(types::Hotkey::Unknown);
+   }
+   return hotkeyVariable->second;
+}
+
+HotkeySettings& HotkeySettings::Instance()
+{
+   static HotkeySettings hotkeySettings_;
+   return hotkeySettings_;
+}
+
+bool operator==(const HotkeySettings& lhs, const HotkeySettings& rhs)
+{
+   return (lhs.p->hotkey_ == rhs.p->hotkey_);
+}
+
+static bool IsHotkeyValid(const std::string& value)
+{
+   return QKeySequence {QString::fromStdString(value)}
+             .toString()
+             .toStdString() == value;
+}
+
+} // namespace settings
+} // namespace qt
+} // namespace scwx

scwx-qt/source/scwx/qt/settings/hotkey_settings.hpp

@@ -0,0 +1,42 @@
+#pragma once
+
+#include <scwx/qt/settings/settings_category.hpp>
+#include <scwx/qt/settings/settings_variable.hpp>
+#include <scwx/qt/types/hotkey_types.hpp>
+
+#include <memory>
+#include <string>
+
+namespace scwx
+{
+namespace qt
+{
+namespace settings
+{
+
+class HotkeySettings : public SettingsCategory
+{
+public:
+   explicit HotkeySettings();
+   ~HotkeySettings();
+
+   HotkeySettings(const HotkeySettings&)            = delete;
+   HotkeySettings& operator=(const HotkeySettings&) = delete;
+
+   HotkeySettings(HotkeySettings&&) noexcept;
+   HotkeySettings& operator=(HotkeySettings&&) noexcept;
+
+   SettingsVariable<std::string>& hotkey(scwx::qt::types::Hotkey hotkey) const;
+
+   static HotkeySettings& Instance();
+
+   friend bool operator==(const HotkeySettings& lhs, const HotkeySettings& rhs);
+
+private:
+   class Impl;
+   std::unique_ptr<Impl> p;
+};
+
+} // namespace settings
+} // namespace qt
+} // namespace scwx