Merge pull request #7923 from jordan-woyak/full-surface-rename

ControllerInterface: Rename full surface analog inputs.

Source/Core/InputCommon/ControllerInterface/Device.cpp

@@ -55,7 +55,7 @@ Device::Input* Device::FindInput(const std::string& name) const
 {
   for (Input* input : m_inputs)
   {
-    if (input->GetName() == name)
+    if (input->IsMatchingName(name))
       return input;
   }
 
@@ -66,18 +66,42 @@ Device::Output* Device::FindOutput(const std::string& name) const
 {
   for (Output* output : m_outputs)
   {
-    if (output->GetName() == name)
+    if (output->IsMatchingName(name))
       return output;
   }
 
   return nullptr;
 }
 
+bool Device::Control::IsMatchingName(const std::string& name) const
+{
+  return GetName() == name;
+}
+
 ControlState Device::FullAnalogSurface::GetState() const
 {
   return (1 + std::max(0.0, m_high.GetState()) - std::max(0.0, m_low.GetState())) / 2;
 }
 
+std::string Device::FullAnalogSurface::GetName() const
+{
+  // E.g. "Full Axis X+"
+  return "Full " + m_high.GetName();
+}
+
+bool Device::FullAnalogSurface::IsMatchingName(const std::string& name) const
+{
+  if (Control::IsMatchingName(name))
+    return true;
+
+  // Old naming scheme was "Axis X-+" which is too visually similar to "Axis X+".
+  // This has caused countless problems for users with mysterious misconfigurations.
+  // We match this old name to support old configurations.
+  const auto old_name = m_low.GetName() + *m_high.GetName().rbegin();
+
+  return old_name == name;
+}
+
 //
 // DeviceQualifier :: ToString
 //

Source/Core/InputCommon/ControllerInterface/Device.h

@@ -46,6 +46,10 @@ public:
     virtual ~Control() {}
     virtual Input* ToInput() { return nullptr; }
     virtual Output* ToOutput() { return nullptr; }
+
+    // May be overridden to allow multiple valid names.
+    // Useful for backwards-compatible configurations when names change.
+    virtual bool IsMatchingName(const std::string& name) const;
   };
 
   //
@@ -114,12 +118,13 @@ protected:
   void AddInput(Input* const i);
   void AddOutput(Output* const o);
 
-  class FullAnalogSurface : public Input
+  class FullAnalogSurface final : public Input
   {
   public:
     FullAnalogSurface(Input* low, Input* high) : m_low(*low), m_high(*high) {}
     ControlState GetState() const override;
-    std::string GetName() const override { return m_low.GetName() + *m_high.GetName().rbegin(); }
+    std::string GetName() const override;
+    bool IsMatchingName(const std::string& name) const override;
 
   private:
     Input& m_low;