Cleanup the controller class tree.

Author: Mysticial

SerialPrograms/CMakeLists.txt

@@ -611,10 +611,6 @@ file(GLOB MAIN_SOURCES
     Source/Controllers/ControllerSelectorWidget.h
     Source/Controllers/SerialPABotBase/SerialPABotBase.cpp
     Source/Controllers/SerialPABotBase/SerialPABotBase.h
-    Source/Controllers/SerialPABotBase/SerialPABotBase_Connection.cpp
-    Source/Controllers/SerialPABotBase/SerialPABotBase_Connection.h
-    Source/Controllers/SerialPABotBase/SerialPABotBase_Descriptor.cpp
-    Source/Controllers/SerialPABotBase/SerialPABotBase_Descriptor.h
     Source/Controllers/SerialPABotBase/SerialPABotBase_Handle.cpp
     Source/Controllers/SerialPABotBase/SerialPABotBase_Handle.cpp
     Source/Controllers/SerialPABotBase/SerialPABotBase_Handle.h

SerialPrograms/SerialPrograms.pro

@@ -310,8 +310,6 @@ SOURCES += \
     Source/Controllers/ControllerSession.cpp \
     Source/Controllers/ControllerDescriptor.cpp \
     Source/Controllers/SerialPABotBase/SerialPABotBase.cpp \
-    Source/Controllers/SerialPABotBase/SerialPABotBase_Connection.cpp \
-    Source/Controllers/SerialPABotBase/SerialPABotBase_Descriptor.cpp \
     Source/Controllers/SerialPABotBase/SerialPABotBase_Handle.cpp \
     Source/Integrations/DiscordIntegrationSettings.cpp \
     Source/Integrations/DiscordIntegrationTable.cpp \
@@ -1427,8 +1425,6 @@ HEADERS += \
     Source/Controllers/ControllerSession.h \
     Source/Controllers/ControllerDescriptor.h \
     Source/Controllers/SerialPABotBase/SerialPABotBase.h \
-    Source/Controllers/SerialPABotBase/SerialPABotBase_Connection.h \
-    Source/Controllers/SerialPABotBase/SerialPABotBase_Descriptor.h \
     Source/Controllers/SerialPABotBase/SerialPABotBase_Handle.h \
     Source/Integrations/DiscordIntegrationSettings.h \
     Source/Integrations/DiscordIntegrationTable.h \

SerialPrograms/Source/Controllers/ControllerCapability.h

@@ -44,13 +44,6 @@ namespace PokemonAutomation{
 //
 class ControllerRequirements{
 public:
-#if 0
-    template <class... Args>
-    ControllerRequirements(Args&&... args)
-        : m_map(std::forward<Args>(args)...)
-        , m_sanitizer("ControllerRequirements")
-    {}
-#endif
     ControllerRequirements(std::initializer_list<std::map<std::string, std::set<std::string>>::value_type> args)
         : m_map(std::move(args))
         , m_sanitizer("ControllerRequirements")

SerialPrograms/Source/Controllers/ControllerConnection.h

@@ -13,8 +13,6 @@
 
 namespace PokemonAutomation{
 
-class BotBaseRequest;   //  REMOVE
-
 
 class ControllerConnection{
 public:
@@ -34,15 +32,11 @@ class ControllerConnection{
     std::string status_text() const;
 
 
-public:
-    virtual std::string stop_pending_commands() = 0;
-    virtual std::string set_next_command_replace() = 0;
-    virtual std::string send_request(const BotBaseRequest& request) = 0;    //  REMOVE
-
 protected:
     void signal_ready_changed(bool ready);
     void signal_status_text_changed(const std::string& text);
 
+
 protected:
     std::atomic<bool> m_ready;
 

SerialPrograms/Source/Controllers/ControllerDescriptor.cpp

@@ -7,17 +7,13 @@
 #include "Common/Cpp/Json/JsonValue.h"
 #include "Common/Cpp/Json/JsonObject.h"
 #include "ControllerDescriptor.h"
-
 #include "Controllers/SerialPABotBase/SerialPABotBase.h"
-#include "Controllers/SerialPABotBase/SerialPABotBase_Descriptor.h"
+#include "NintendoSwitch/Controllers/NintendoSwitch_SerialPABotBase.h"
 #include "ControllerConnection.h"
 
 namespace PokemonAutomation{
 
 
-std::unique_ptr<ControllerDescriptor> NullControllerDescriptor::clone() const{
-    return std::unique_ptr<ControllerDescriptor>(new NullControllerDescriptor());
-}
 bool NullControllerDescriptor::operator==(const ControllerDescriptor& x) const{
     return typeid(*this) == typeid(x);
 }
@@ -60,8 +56,8 @@ void ControllerOption::load_json(const JsonValue& json){
         m_current = std::move(descriptor);
         return;
     }
-    if (type == SerialPABotBase::INTERFACE_NAME){
-        auto descriptor = std::make_unique<SerialPABotBase::SerialDescriptor>();
+    if (type == SerialPABotBase::NintendoSwitch_Basic){
+        auto descriptor = std::make_unique<NintendoSwitch::SwitchController_SerialPABotBase_Descriptor>();
         descriptor->load_json(params);
         m_current = std::move(descriptor);
         return;

SerialPrograms/Source/Controllers/ControllerDescriptor.h

@@ -22,7 +22,6 @@ class ControllerConnection;
 class ControllerDescriptor{
 public:
     virtual ~ControllerDescriptor() = default;
-    virtual std::unique_ptr<ControllerDescriptor> clone() const = 0;
     virtual bool operator==(const ControllerDescriptor& x) const = 0;
 
     virtual const char* type_name() const = 0;
@@ -39,7 +38,6 @@ class ControllerDescriptor{
 
 class NullControllerDescriptor : public ControllerDescriptor{
 public:
-    virtual std::unique_ptr<ControllerDescriptor> clone() const override;
     virtual bool operator==(const ControllerDescriptor& x) const override;
     virtual const char* type_name() const override;
     virtual std::string display_name() const override;

SerialPrograms/Source/Controllers/ControllerSelectorWidget.cpp

@@ -9,7 +9,7 @@
 #include "Controllers/ControllerCapability.h"
 #include "ControllerSelectorWidget.h"
 #include "SerialPABotBase/SerialPABotBase.h"
-#include "SerialPABotBase/SerialPABotBase_Descriptor.h"
+#include "NintendoSwitch/Controllers/NintendoSwitch_SerialPABotBase.h"
 
 //#include <iostream>
 //using std::cout;
@@ -87,8 +87,9 @@ void ControllerSelectorWidget::refresh(){
     m_device_list.emplace_back(new NullControllerDescriptor());
 
     //  If SerialPABotBase is supported, add them to the list.
-    if (m_session.requirements().contains_device(SerialPABotBase::INTERFACE_NAME)){
-        std::vector<std::unique_ptr<const ControllerDescriptor>> serial = SerialPABotBase::get_all_devices();
+    if (m_session.requirements().contains_device(SerialPABotBase::NintendoSwitch_Basic)){  //  REMOVE
+        std::vector<std::unique_ptr<const ControllerDescriptor>> serial =
+            NintendoSwitch::SwitchController_SerialPABotBase_Descriptor::get_all_devices();
         std::move(serial.begin(), serial.end(), std::back_inserter(m_device_list));
     }
 

SerialPrograms/Source/Controllers/ControllerSession.cpp

@@ -176,30 +176,6 @@ std::string ControllerSession::reset(){
 
     return "";
 }
-std::string ControllerSession::stop_pending_commands(){
-    std::lock_guard<std::mutex> lg(m_state_lock);
-//    cout << "ControllerSession::stop_pending_commands() = " << m_connection.get() << endl;
-    if (!m_connection){
-        return "No controller set.";
-    }
-    return m_connection->stop_pending_commands();
-}
-std::string ControllerSession::set_next_command_replace(){
-    std::lock_guard<std::mutex> lg(m_state_lock);
-//    cout << "ControllerSession::stop_pending_commands() = " << m_connection.get() << endl;
-    if (!m_connection){
-        return "No controller set.";
-    }
-    return m_connection->set_next_command_replace();
-}
-std::string ControllerSession::send_request(const BotBaseRequest& request){
-    std::lock_guard<std::mutex> lg(m_state_lock);
-//    cout << "ControllerSession::stop_pending_commands() = " << m_connection.get() << endl;
-    if (!m_connection){
-        return "No controller set.";
-    }
-    return m_connection->send_request(request);
-}
 
 
 

SerialPrograms/Source/Controllers/ControllerSession.h

@@ -9,6 +9,7 @@
 
 #include <mutex>
 #include "Common/Cpp/ListenerSet.h"
+#include "Common/Cpp/Exceptions.h"
 #include "ControllerDescriptor.h"
 #include "ControllerConnection.h"
 
@@ -66,12 +67,31 @@ class ControllerSession{
 public:
     bool set_device(const std::shared_ptr<const ControllerDescriptor>& device);
 
+
 public:
     //  Returns empty string on success. Otherwise returns error message.
     std::string reset();
-    std::string stop_pending_commands();
-    std::string set_next_command_replace();
-    std::string send_request(const BotBaseRequest& request);    //  REMOVE
+
+    //  Try to run the following lambda on the underlying controller type.
+    //  Returns true if successful.
+    template <typename ControllerType, typename Lambda>
+    bool try_run(Lambda&& function){
+        std::lock_guard<std::mutex> lg(m_state_lock);
+        if (!m_connection){
+            return false;
+        }
+
+        //  This will be a cross-cast in most cases.
+        ControllerType* child = dynamic_cast<ControllerType*>(m_connection.get());
+        if (child == nullptr){
+            throw InternalProgramError(
+                &m_logger, PA_CURRENT_FUNCTION,
+                "Incompatible controller type cast."
+            );
+        }
+        function(*child);
+        return true;
+    }
 
 
 private:

SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase.cpp

@@ -4,15 +4,18 @@
  *
  */
 
+#include "Common/PokemonSwSh/PokemonProgramIDs.h"
 #include "SerialPABotBase.h"
 
 namespace PokemonAutomation{
 namespace SerialPABotBase{
 
 
-const char INTERFACE_NAME[] = "SerialPABotBase";
 
+const char NintendoSwitch_Basic[] = "NintendoSwitch-SerialPABotBase";
 
+
+//  Feature List
 const char* to_string(Features feature){
     switch (feature){
     case Features::TickPrecise:             return "TickPrecise";
@@ -24,10 +27,28 @@ const char* to_string(Features feature){
 }
 
 
+//  Defaults
+const std::pair<std::string, std::set<std::string>> OLD_NINTENDO_SWITCH_DEFAULT_REQUIREMENTS{
+    NintendoSwitch_Basic,
+    {
+        to_string(SerialPABotBase::Features::TickPrecise),
+        to_string(SerialPABotBase::Features::NintendoSwitch_Basic),
+        to_string(SerialPABotBase::Features::NintendoSwitch_Macros),
+        to_string(SerialPABotBase::Features::NintendoSwitch_DateSkip),
+    }
+};
+
 
+//  Internal Parsing
 std::set<std::string> program_id_to_features(uint8_t id){
     switch (id){
     case PABB_PID_PABOTBASE_12KB:
+        return {
+            to_string(Features::TickPrecise),
+            to_string(Features::NintendoSwitch_Basic),
+            to_string(Features::NintendoSwitch_Macros),
+//            to_string(Features::NintendoSwitch_DateSkip),
+        };
     case PABB_PID_PABOTBASE_31KB:
         return {
             to_string(Features::TickPrecise),
@@ -40,15 +61,6 @@ std::set<std::string> program_id_to_features(uint8_t id){
 }
 
 
-const std::pair<std::string, std::set<std::string>> OLD_SERIAL_DEFAULT{
-    SerialPABotBase::INTERFACE_NAME,
-    {
-        to_string(SerialPABotBase::Features::TickPrecise),
-        to_string(SerialPABotBase::Features::NintendoSwitch_Basic),
-        to_string(SerialPABotBase::Features::NintendoSwitch_Macros),
-        to_string(SerialPABotBase::Features::NintendoSwitch_DateSkip),
-    }
-};