InputCommon/ControllerEmu: Break out functionality of EmulatedController

to eliminate redundant unused members in Wii Remote extension objects.

Source/Core/InputCommon/ControllerEmu/ControlGroup/Attachments.cpp

@@ -5,11 +5,16 @@
 
 namespace ControllerEmu
 {
+
+void AttachedController::LoadDefaults()
+{
+}
+
 Attachments::Attachments(const std::string& name_) : ControlGroup(name_, GroupType::Attachments)
 {
 }
 
-void Attachments::AddAttachment(std::unique_ptr<EmulatedController> att)
+void Attachments::AddAttachment(std::unique_ptr<AttachedController> att)
 {
   m_attachments.emplace_back(std::move(att));
 }
@@ -40,9 +45,61 @@ SubscribableSettingValue<int>& Attachments::GetAttachmentSetting()
   return m_selection_value;
 }
 
-const std::vector<std::unique_ptr<EmulatedController>>& Attachments::GetAttachmentList() const
+const std::vector<std::unique_ptr<AttachedController>>& Attachments::GetAttachmentList() const
 {
   return m_attachments;
 }
 
+void Attachments::LoadConfig(Common::IniFile::Section* sec, const std::string& base)
+{
+  ControlGroup::LoadConfig(sec, base);
+
+  SetSelectedAttachment(0);
+
+  std::string attachment_text;
+  sec->Get(base + name, &attachment_text, "");
+
+  // First assume attachment string is a valid expression.
+  // If it instead matches one of the names of our attachments it is overridden below.
+  GetSelectionSetting().GetInputReference().SetExpression(attachment_text);
+
+  u32 n = 0;
+  for (auto& ai : GetAttachmentList())
+  {
+    ai->LoadGroupsConfig(sec, base + ai->GetName() + "/");
+
+    if (ai->GetName() == attachment_text)
+      SetSelectedAttachment(n);
+
+    ++n;
+  }
+}
+
+void Attachments::SaveConfig(Common::IniFile::Section* sec, const std::string& base)
+{
+  if (GetSelectionSetting().IsSimpleValue())
+  {
+    sec->Set(base + name, GetAttachmentList()[GetSelectedAttachment()]->GetName(), "None");
+  }
+  else
+  {
+    std::string expression = GetSelectionSetting().GetInputReference().GetExpression();
+    ReplaceBreaksWithSpaces(expression);
+    sec->Set(base + name, expression, "None");
+  }
+
+  for (auto& ai : GetAttachmentList())
+    ai->SaveGroupsConfig(sec, base + ai->GetName() + "/");
+}
+
+void Attachments::UpdateReferences(ciface::ExpressionParser::ControlEnvironment& env)
+{
+  ControlGroup::UpdateReferences(env);
+
+  GetSelectionSetting().GetInputReference().UpdateReference(env);
+
+  for (auto& attachment : GetAttachmentList())
+    attachment->UpdateGroupsReferences(env);
+}
+
 }  // namespace ControllerEmu

Source/Core/InputCommon/ControllerEmu/ControlGroup/Attachments.h

@@ -3,19 +3,23 @@
 
 #pragma once
 
-#include <atomic>
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "Common/CommonTypes.h"
-#include "Core/HW/WiimoteEmu/ExtensionPort.h"
 #include "InputCommon/ControllerEmu/ControlGroup/ControlGroup.h"
 #include "InputCommon/ControllerEmu/ControllerEmu.h"
 #include "InputCommon/ControllerEmu/Setting/NumericSetting.h"
 
 namespace ControllerEmu
 {
+class AttachedController : public ControlGroupContainer
+{
+public:
+  virtual void LoadDefaults();
+};
+
 // A container of the selected and available attachments
 // for configuration saving/loading purposes
 class Attachments : public ControlGroup
@@ -23,7 +27,7 @@ class Attachments : public ControlGroup
 public:
   explicit Attachments(const std::string& name);
 
-  void AddAttachment(std::unique_ptr<EmulatedController> att);
+  void AddAttachment(std::unique_ptr<AttachedController> att);
 
   u32 GetSelectedAttachment() const;
   void SetSelectedAttachment(u32 val);
@@ -31,16 +35,20 @@ public:
   NumericSetting<int>& GetSelectionSetting();
   SubscribableSettingValue<int>& GetAttachmentSetting();
 
-  const std::vector<std::unique_ptr<EmulatedController>>& GetAttachmentList() const;
+  const std::vector<std::unique_ptr<AttachedController>>& GetAttachmentList() const;
+
+  void LoadConfig(Common::IniFile::Section* sec, const std::string& base) override;
+  void SaveConfig(Common::IniFile::Section* sec, const std::string& base) override;
+
+  void UpdateReferences(ciface::ExpressionParser::ControlEnvironment& env) override;
 
 private:
   SubscribableSettingValue<int> m_selection_value;
   // This is here and not added to the list of numeric_settings because it's serialized differently,
   // by string (to be independent from the enum), and visualized differently in the UI.
   // For the rest, it's treated similarly to other numeric_settings in the group.
-  NumericSetting<int> m_selection_setting = {
-      &m_selection_value, {""}, 0, 0, WiimoteEmu::ExtensionNumber::MAX - 1};
+  NumericSetting<int> m_selection_setting = {&m_selection_value, {""}, 0, 0, 0};
 
-  std::vector<std::unique_ptr<EmulatedController>> m_attachments;
+  std::vector<std::unique_ptr<AttachedController>> m_attachments;
 };
 }  // namespace ControllerEmu

Source/Core/InputCommon/ControllerEmu/ControlGroup/ControlGroup.cpp

@@ -3,13 +3,11 @@
 
 #include "InputCommon/ControllerEmu/ControlGroup/ControlGroup.h"
 
-#include "Common/CommonTypes.h"
 #include "Common/IniFile.h"
 
 #include "InputCommon/ControlReference/ControlReference.h"
 #include "InputCommon/ControllerEmu/Control/Input.h"
 #include "InputCommon/ControllerEmu/Control/Output.h"
-#include "InputCommon/ControllerEmu/ControlGroup/Attachments.h"
 #include "InputCommon/ControllerEmu/ControllerEmu.h"
 #include "InputCommon/ControllerEmu/Setting/NumericSetting.h"
 
@@ -50,8 +48,7 @@ void ControlGroup::AddDeadzoneSetting(SettingValue<double>* value, double maximu
 
 ControlGroup::~ControlGroup() = default;
 
-void ControlGroup::LoadConfig(Common::IniFile::Section* sec, const std::string& defdev,
-                              const std::string& base)
+void ControlGroup::LoadConfig(Common::IniFile::Section* sec, const std::string& base)
 {
   const std::string group(base + name + "/");
 
@@ -75,36 +72,9 @@ void ControlGroup::LoadConfig(Common::IniFile::Section* sec, const std::string&
     sec->Get(group + c->name + "/Range", &c->control_ref->range, 100.0);
     c->control_ref->range /= 100;
   }
-
-  // extensions
-  if (type == GroupType::Attachments)
-  {
-    auto* const ext = static_cast<Attachments*>(this);
-
-    ext->SetSelectedAttachment(0);
-    u32 n = 0;
-    std::string attachment_text;
-    sec->Get(base + name, &attachment_text, "");
-
-    // First assume attachment string is a valid expression.
-    // If it instead matches one of the names of our attachments it is overridden below.
-    ext->GetSelectionSetting().GetInputReference().SetExpression(attachment_text);
-
-    for (auto& ai : ext->GetAttachmentList())
-    {
-      ai->SetDefaultDevice(defdev);
-      ai->LoadConfig(sec, base + ai->GetName() + "/");
-
-      if (ai->GetName() == attachment_text)
-        ext->SetSelectedAttachment(n);
-
-      n++;
-    }
-  }
 }
 
-void ControlGroup::SaveConfig(Common::IniFile::Section* sec, const std::string& defdev,
-                              const std::string& base)
+void ControlGroup::SaveConfig(Common::IniFile::Section* sec, const std::string& base)
 {
   const std::string group(base + name + "/");
 
@@ -125,27 +95,15 @@ void ControlGroup::SaveConfig(Common::IniFile::Section* sec, const std::string&
     // range
     sec->Set(group + c->name + "/Range", c->control_ref->range * 100.0, 100.0);
   }
+}
 
-  // extensions
-  if (type == GroupType::Attachments)
-  {
-    auto* const ext = static_cast<Attachments*>(this);
+void ControlGroup::UpdateReferences(ciface::ExpressionParser::ControlEnvironment& env)
+{
+  for (auto& control : controls)
+    control->control_ref->UpdateReference(env);
 
-    if (ext->GetSelectionSetting().IsSimpleValue())
-    {
-      sec->Set(base + name, ext->GetAttachmentList()[ext->GetSelectedAttachment()]->GetName(),
-               "None");
-    }
-    else
-    {
-      std::string expression = ext->GetSelectionSetting().GetInputReference().GetExpression();
-      ReplaceBreaksWithSpaces(expression);
-      sec->Set(base + name, expression, "None");
-    }
-
-    for (auto& ai : ext->GetAttachmentList())
-      ai->SaveConfig(sec, base + ai->GetName() + "/");
-  }
+  for (auto& setting : numeric_settings)
+    setting->GetInputReference().UpdateReference(env);
 }
 
 void ControlGroup::SetControlExpression(int index, const std::string& expression)

Source/Core/InputCommon/ControllerEmu/ControlGroup/ControlGroup.h

@@ -13,7 +13,6 @@
 #include <type_traits>
 #include <vector>
 
-#include "Common/CommonTypes.h"
 #include "Common/IniFile.h"
 #include "InputCommon/ControllerEmu/Control/Control.h"
 #include "InputCommon/ControllerInterface/CoreDevice.h"
@@ -69,10 +68,10 @@ public:
                DefaultValue default_value = DefaultValue::AlwaysEnabled);
   virtual ~ControlGroup();
 
-  virtual void LoadConfig(Common::IniFile::Section* sec, const std::string& defdev = "",
-                          const std::string& base = "");
-  virtual void SaveConfig(Common::IniFile::Section* sec, const std::string& defdev = "",
-                          const std::string& base = "");
+  virtual void LoadConfig(Common::IniFile::Section* sec, const std::string& base);
+  virtual void SaveConfig(Common::IniFile::Section* sec, const std::string& base);
+
+  virtual void UpdateReferences(ciface::ExpressionParser::ControlEnvironment& env);
 
   void SetControlExpression(int index, const std::string& expression);
 

Source/Core/InputCommon/ControllerEmu/ControllerEmu.cpp

@@ -11,10 +11,7 @@
 #include "Common/IniFile.h"
 
 #include "InputCommon/ControlReference/ControlReference.h"
-#include "InputCommon/ControllerEmu/Control/Control.h"
-#include "InputCommon/ControllerEmu/ControlGroup/Attachments.h"
 #include "InputCommon/ControllerEmu/ControlGroup/ControlGroup.h"
-#include "InputCommon/ControllerEmu/Setting/NumericSetting.h"
 #include "InputCommon/ControllerInterface/ControllerInterface.h"
 
 namespace ControllerEmu
@@ -23,7 +20,7 @@ namespace ControllerEmu
 // though no EmulatedController usually run in parallel, so it makes little difference
 static std::recursive_mutex s_get_state_mutex;
 
-std::string EmulatedController::GetDisplayName() const
+std::string ControlGroupContainer::GetDisplayName() const
 {
   return GetName();
 }
@@ -47,34 +44,18 @@ void EmulatedController::UpdateReferences(const ControllerInterface& devi)
 
   ciface::ExpressionParser::ControlEnvironment env(devi, GetDefaultDevice(), m_expression_vars);
 
-  UpdateReferences(env);
+  UpdateGroupsReferences(env);
 
   env.CleanUnusedVariables();
 }
 
-void EmulatedController::UpdateReferences(ciface::ExpressionParser::ControlEnvironment& env)
+void ControlGroupContainer::UpdateGroupsReferences(
+    ciface::ExpressionParser::ControlEnvironment& env)
 {
-  const auto lock = GetStateLock();
+  const auto lock = EmulatedController::GetStateLock();
 
-  for (auto& ctrlGroup : groups)
-  {
-    for (auto& control : ctrlGroup->controls)
-      control->control_ref->UpdateReference(env);
-
-    for (auto& setting : ctrlGroup->numeric_settings)
-      setting->GetInputReference().UpdateReference(env);
-
-    // Attachments:
-    if (ctrlGroup->type == GroupType::Attachments)
-    {
-      auto* const attachments = static_cast<Attachments*>(ctrlGroup.get());
-
-      attachments->GetSelectionSetting().GetInputReference().UpdateReference(env);
-
-      for (auto& attachment : attachments->GetAttachmentList())
-        attachment->UpdateReferences(env);
-    }
-  }
+  for (auto& group : groups)
+    group->UpdateReferences(env);
 }
 
 void EmulatedController::UpdateSingleControlReference(const ControllerInterface& devi,
@@ -125,43 +106,40 @@ void EmulatedController::SetDefaultDevice(const std::string& device)
 void EmulatedController::SetDefaultDevice(ciface::Core::DeviceQualifier devq)
 {
   m_default_device = std::move(devq);
-
-  for (auto& ctrlGroup : groups)
-  {
-    // Attachments:
-    if (ctrlGroup->type == GroupType::Attachments)
-    {
-      for (auto& ai : static_cast<Attachments*>(ctrlGroup.get())->GetAttachmentList())
-      {
-        ai->SetDefaultDevice(m_default_device);
-      }
-    }
-  }
 }
 
-void EmulatedController::LoadConfig(Common::IniFile::Section* sec, const std::string& base)
+ControlGroupContainer::~ControlGroupContainer() = default;
+
+void EmulatedController::LoadConfig(Common::IniFile::Section* sec)
 {
-  const auto lock = GetStateLock();
-  std::string defdev = GetDefaultDevice().ToString();
-  if (base.empty())
-  {
-    sec->Get(base + "Device", &defdev, "");
+  const auto lock = EmulatedController::GetStateLock();
+
+  std::string defdev;
+  if (sec->Get("Device", &defdev, ""))
     SetDefaultDevice(defdev);
-  }
 
-  for (auto& cg : groups)
-    cg->LoadConfig(sec, defdev, base);
+  LoadGroupsConfig(sec, "");
 }
 
-void EmulatedController::SaveConfig(Common::IniFile::Section* sec, const std::string& base)
+void ControlGroupContainer::LoadGroupsConfig(Common::IniFile::Section* sec, const std::string& base)
 {
-  const auto lock = GetStateLock();
-  const std::string defdev = GetDefaultDevice().ToString();
-  if (base.empty())
-    sec->Set(/*std::string(" ") +*/ base + "Device", defdev, "");
+  for (auto& cg : groups)
+    cg->LoadConfig(sec, base);
+}
 
-  for (auto& ctrlGroup : groups)
-    ctrlGroup->SaveConfig(sec, defdev, base);
+void EmulatedController::SaveConfig(Common::IniFile::Section* sec)
+{
+  const auto lock = EmulatedController::GetStateLock();
+
+  sec->Set("Device", GetDefaultDevice().ToString(), "");
+
+  SaveGroupsConfig(sec, "");
+}
+
+void ControlGroupContainer::SaveGroupsConfig(Common::IniFile::Section* sec, const std::string& base)
+{
+  for (auto& cg : groups)
+    cg->SaveConfig(sec, base);
 }
 
 void EmulatedController::LoadDefaults(const ControllerInterface& ciface)
@@ -178,12 +156,12 @@ void EmulatedController::LoadDefaults(const ControllerInterface& ciface)
   }
 }
 
-void EmulatedController::SetInputOverrideFunction(InputOverrideFunction override_func)
+void ControlGroupContainer::SetInputOverrideFunction(InputOverrideFunction override_func)
 {
   m_input_override_function = std::move(override_func);
 }
 
-void EmulatedController::ClearInputOverrideFunction()
+void ControlGroupContainer::ClearInputOverrideFunction()
 {
   m_input_override_function = {};
 }

Source/Core/InputCommon/ControllerEmu/ControllerEmu.h

@@ -172,29 +172,83 @@ struct RawValue
   }
 };
 
-class EmulatedController
+// Maps a float from -1.0..+1.0 to an integer in the provided range.
+template <typename T, typename F>
+T MapFloat(F input_value, T zero_value, T neg_1_value = std::numeric_limits<T>::min(),
+           T pos_1_value = std::numeric_limits<T>::max())
+{
+  static_assert(std::is_integral<T>(), "T is only sane for int types.");
+  static_assert(std::is_floating_point<F>(), "F is only sane for float types.");
+
+  static_assert(std::numeric_limits<long long>::min() <= std::numeric_limits<T>::min() &&
+                    std::numeric_limits<long long>::max() >= std::numeric_limits<T>::max(),
+                "long long is not a superset of T. use of std::llround is not sane.");
+
+  // Here we round when converting from float to int.
+  // After applying our deadzone, resizing, and reshaping math
+  // we sometimes have a near-zero value which is slightly negative. (e.g. -0.0001)
+  // Casting would round down but rounding will yield our "zero_value".
+
+  if (input_value > 0)
+    return T(std::llround((pos_1_value - zero_value) * input_value + zero_value));
+  else
+    return T(std::llround((zero_value - neg_1_value) * input_value + zero_value));
+}
+
+// The inverse of the function above.
+// Maps an integer in the provided range to a float in the range -1.0..1.0.
+template <typename F, typename T>
+F MapToFloat(T input_value, T zero_value, T neg_1_value = std::numeric_limits<T>::min(),
+             T pos_1_value = std::numeric_limits<T>::max())
+{
+  static_assert(std::is_integral<T>(), "T is only sane for int types.");
+  static_assert(std::is_floating_point<F>(), "F is only sane for float types.");
+
+  if (input_value >= zero_value)
+    return F(input_value - zero_value) / F(pos_1_value - zero_value);
+  else
+    return -F(zero_value - input_value) / F(zero_value - neg_1_value);
+}
+
+class ControlGroupContainer
 {
 public:
-  virtual ~EmulatedController();
+  virtual ~ControlGroupContainer();
+
+  virtual void LoadGroupsConfig(Common::IniFile::Section* sec, const std::string& base);
+  virtual void SaveGroupsConfig(Common::IniFile::Section* sec, const std::string& base);
 
   virtual std::string GetName() const = 0;
   virtual std::string GetDisplayName() const;
 
+  void UpdateGroupsReferences(ciface::ExpressionParser::ControlEnvironment& env);
+
+  void SetInputOverrideFunction(InputOverrideFunction override_func);
+  void ClearInputOverrideFunction();
+
+  std::vector<std::unique_ptr<ControlGroup>> groups;
+
+protected:
+  InputOverrideFunction m_input_override_function;
+};
+
+class EmulatedController : public ControlGroupContainer
+{
+public:
+  virtual ~EmulatedController();
+
   virtual InputConfig* GetConfig() const = 0;
 
   virtual void LoadDefaults(const ControllerInterface& ciface);
 
-  virtual void LoadConfig(Common::IniFile::Section* sec, const std::string& base = "");
-  virtual void SaveConfig(Common::IniFile::Section* sec, const std::string& base = "");
+  void LoadConfig(Common::IniFile::Section* sec);
+  void SaveConfig(Common::IniFile::Section* sec);
 
   bool IsDefaultDeviceConnected() const;
   const ciface::Core::DeviceQualifier& GetDefaultDevice() const;
   void SetDefaultDevice(const std::string& device);
   void SetDefaultDevice(ciface::Core::DeviceQualifier devq);
 
-  void SetInputOverrideFunction(InputOverrideFunction override_func);
-  void ClearInputOverrideFunction();
-
   void UpdateReferences(const ControllerInterface& devi);
   void UpdateSingleControlReference(const ControllerInterface& devi, ControlReference* ref);
 
@@ -209,55 +263,9 @@ public:
   // Resets the values while keeping the list.
   void ResetExpressionVariables();
 
-  std::vector<std::unique_ptr<ControlGroup>> groups;
-
-  // Maps a float from -1.0..+1.0 to an integer in the provided range.
-  template <typename T, typename F>
-  static T MapFloat(F input_value, T zero_value, T neg_1_value = std::numeric_limits<T>::min(),
-                    T pos_1_value = std::numeric_limits<T>::max())
-  {
-    static_assert(std::is_integral<T>(), "T is only sane for int types.");
-    static_assert(std::is_floating_point<F>(), "F is only sane for float types.");
-
-    static_assert(std::numeric_limits<long long>::min() <= std::numeric_limits<T>::min() &&
-                      std::numeric_limits<long long>::max() >= std::numeric_limits<T>::max(),
-                  "long long is not a superset of T. use of std::llround is not sane.");
-
-    // Here we round when converting from float to int.
-    // After applying our deadzone, resizing, and reshaping math
-    // we sometimes have a near-zero value which is slightly negative. (e.g. -0.0001)
-    // Casting would round down but rounding will yield our "zero_value".
-
-    if (input_value > 0)
-      return T(std::llround((pos_1_value - zero_value) * input_value + zero_value));
-    else
-      return T(std::llround((zero_value - neg_1_value) * input_value + zero_value));
-  }
-
-  // The inverse of the function above.
-  // Maps an integer in the provided range to a float in the range -1.0..1.0.
-  template <typename F, typename T>
-  static F MapToFloat(T input_value, T zero_value, T neg_1_value = std::numeric_limits<T>::min(),
-                      T pos_1_value = std::numeric_limits<T>::max())
-  {
-    static_assert(std::is_integral<T>(), "T is only sane for int types.");
-    static_assert(std::is_floating_point<F>(), "F is only sane for float types.");
-
-    if (input_value >= zero_value)
-      return F(input_value - zero_value) / F(pos_1_value - zero_value);
-    else
-      return -F(zero_value - input_value) / F(zero_value - neg_1_value);
-  }
-
 protected:
-  // TODO: Wiimote attachments actually end up using their parent controller value for this,
-  // so theirs won't be used (and thus shouldn't even exist).
   ciface::ExpressionParser::ControlEnvironment::VariableContainer m_expression_vars;
 
-  InputOverrideFunction m_input_override_function;
-
-  void UpdateReferences(ciface::ExpressionParser::ControlEnvironment& env);
-
 private:
   ciface::Core::DeviceQualifier m_default_device;
   bool m_default_device_is_connected{false};

Source/Core/InputCommon/ControllerEmu/StickGate.cpp

@@ -10,7 +10,6 @@
 #include <fmt/format.h>
 #include <fmt/ranges.h>
 
-#include "Common/Common.h"
 #include "Common/MathUtil.h"
 #include "Common/Matrix.h"
 #include "Common/StringUtil.h"
@@ -228,10 +227,9 @@ void ReshapableInput::SetCenter(ReshapableInput::ReshapeData center)
   m_center = center;
 }
 
-void ReshapableInput::LoadConfig(Common::IniFile::Section* section,
-                                 const std::string& default_device, const std::string& base_name)
+void ReshapableInput::LoadConfig(Common::IniFile::Section* section, const std::string& base_name)
 {
-  ControlGroup::LoadConfig(section, default_device, base_name);
+  ControlGroup::LoadConfig(section, base_name);
 
   const std::string group(base_name + name + '/');
 
@@ -271,10 +269,9 @@ void ReshapableInput::LoadConfig(Common::IniFile::Section* section,
   }
 }
 
-void ReshapableInput::SaveConfig(Common::IniFile::Section* section,
-                                 const std::string& default_device, const std::string& base_name)
+void ReshapableInput::SaveConfig(Common::IniFile::Section* section, const std::string& base_name)
 {
-  ControlGroup::SaveConfig(section, default_device, base_name);
+  ControlGroup::SaveConfig(section, base_name);
 
   const std::string group(base_name + name + '/');
 

Source/Core/InputCommon/ControllerEmu/StickGate.h

@@ -8,7 +8,6 @@
 
 #include "Common/Matrix.h"
 
-#include "InputCommon/ControlReference/ControlReference.h"
 #include "InputCommon/ControllerEmu/ControlGroup/ControlGroup.h"
 #include "InputCommon/ControllerEmu/Setting/NumericSetting.h"
 
@@ -117,8 +116,8 @@ protected:
   virtual Control* GetModifierInput() const;
 
 private:
-  void LoadConfig(Common::IniFile::Section*, const std::string&, const std::string&) override;
-  void SaveConfig(Common::IniFile::Section*, const std::string&, const std::string&) override;
+  void LoadConfig(Common::IniFile::Section*, const std::string& base_name) override;
+  void SaveConfig(Common::IniFile::Section*, const std::string& base_name) override;
 
   CalibrationData m_calibration;
   SettingValue<double> m_deadzone_setting;