Migrate to the new capabilities implementation.

Author: Mysticial

SerialPrograms/CMakeLists.txt

@@ -609,12 +609,13 @@ file(GLOB MAIN_SOURCES
     Source/Controllers/ControllerSession.h
     Source/Controllers/ControllerSelectorWidget.cpp
     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_Globals.h
     Source/Controllers/SerialPABotBase/SerialPABotBase_Handle.cpp
     Source/Controllers/SerialPABotBase/SerialPABotBase_Handle.h
     Source/Integrations/DiscordIntegrationSettings.cpp

SerialPrograms/SerialPrograms.pro

@@ -309,6 +309,7 @@ SOURCES += \
     Source/Controllers/ControllerSelectorWidget.cpp \
     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 \
@@ -1425,9 +1426,9 @@ HEADERS += \
     Source/Controllers/ControllerSelectorWidget.h \
     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_Globals.h \
     Source/Controllers/SerialPABotBase/SerialPABotBase_Handle.h \
     Source/Integrations/DiscordIntegrationSettings.h \
     Source/Integrations/DiscordIntegrationTable.h \

SerialPrograms/Source/CommonFramework/Panels/UI/PanelElements.cpp

@@ -90,31 +90,6 @@ CollapsibleGroupBox* make_panel_header(
     text->setWordWrap(true);
     layout->addWidget(text);
 
-#if 0
-    switch (serial_level){
-    case PABotBaseLevel::NOT_PABOTBASE:
-        break;
-    case PABotBaseLevel::PABOTBASE_12KB:{
-#if 0
-        QLabel* text = new QLabel(
-            "<font color=\"blue\">(This program will run on both Arduino Uno R3 and Teensy 2.0.</font>)",
-            header
-        );
-        text->setWordWrap(true);
-        layout->addWidget(text);
-#endif
-        break;
-    }case PABotBaseLevel::PABOTBASE_31KB:{
-        QLabel* label = new QLabel(
-            "<font color=\"red\">(This program requires a Teensy or higher. PABotBase for Arduino Uno R3 does not have all the features required by this program.)</font>",
-            header
-        );
-        label->setWordWrap(true);
-        layout->addWidget(label);
-        break;
-    }
-    }
-#endif
     return header;
 }
 

SerialPrograms/Source/Controllers/ControllerCapability.h

@@ -61,21 +61,28 @@ class ControllerRequirements{
         return m_map;
     }
 
-    bool is_compatible_with(const std::string& device, const std::set<std::string>& features) const{
+    bool contains_device(const std::string& device) const{
+        auto scope_check = m_sanitizer.check_scope();
+        return m_map.find(device) != m_map.end();
+    }
+
+    //  Check compatibility. If compatible, returns empty string. Otherwise
+    //  returns one of the missing features.
+    std::string check_compatibility(const std::string& device, const std::set<std::string>& features) const{
         auto scope_check = m_sanitizer.check_scope();
 
         auto iter0 = m_map.find(device);
         if (iter0 == m_map.end()){
-            return false;
+            return device;
         }
 
         const std::set<std::string>& required = iter0->second;
         for (const std::string& feature : required){
             if (features.find(feature) == features.end()){
-                return false;
+                return feature;
             }
         }
-        return true;
+        return "";
     }
 
 

SerialPrograms/Source/Controllers/ControllerDescriptor.cpp

@@ -8,6 +8,7 @@
 #include "Common/Cpp/Json/JsonObject.h"
 #include "ControllerDescriptor.h"
 
+#include "Controllers/SerialPABotBase/SerialPABotBase.h"
 #include "Controllers/SerialPABotBase/SerialPABotBase_Descriptor.h"
 #include "ControllerConnection.h"
 
@@ -59,14 +60,14 @@ void ControllerOption::load_json(const JsonValue& json){
         m_current = std::move(descriptor);
         return;
     }
-    if (type == SerialPABotBase::SerialDescriptor::TYPENAME){
+    if (type == SerialPABotBase::INTERFACE_NAME){
         auto descriptor = std::make_unique<SerialPABotBase::SerialDescriptor>();
         descriptor->load_json(params);
         m_current = std::move(descriptor);
         return;
     }
 
-    throw ParseException("Invalid Device Connection Type: " + type);
+    m_current.reset(new NullControllerDescriptor());
 }
 JsonValue ControllerOption::to_json() const{
     if (!m_current){

SerialPrograms/Source/Controllers/ControllerSelectorWidget.cpp

@@ -6,7 +6,9 @@
 
 #include <QHBoxLayout>
 #include "Common/Qt/NoWheelComboBox.h"
+#include "Controllers/ControllerCapability.h"
 #include "ControllerSelectorWidget.h"
+#include "SerialPABotBase/SerialPABotBase.h"
 #include "SerialPABotBase/SerialPABotBase_Descriptor.h"
 
 //#include <iostream>
@@ -80,16 +82,20 @@ void ControllerSelectorWidget::refresh(){
     m_device_list.clear();
     m_devices_dropdown->clear();
 
+
+    //  Add the "no selection" option.
     m_device_list.emplace_back(new NullControllerDescriptor());
 
-    //  TODO: Apply the requirements filter here to decide which set of devices
-    //  to actually add to the list.
-    //  Also, move this logic into ControllerSession since it isn't UI.
-    if (true){
+    //  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();
         std::move(serial.begin(), serial.end(), std::back_inserter(m_device_list));
     }
 
+    //  If we add new interfaces, add them here.
+
+
+
     std::shared_ptr<const ControllerDescriptor> current = m_session.descriptor();
 
     size_t index = 0;

SerialPrograms/Source/Controllers/ControllerSession.cpp

@@ -83,11 +83,11 @@ std::string ControllerSession::status_text() const{
     }
     return m_connection->status_text();
 }
-ControllerConnection& ControllerSession::controller() const{
+ControllerConnection& ControllerSession::connection() const{
     if (m_connection){
         return *m_connection;
     }
-    throw InternalProgramError(nullptr, PA_CURRENT_FUNCTION, "Controller is null.");
+    throw InternalProgramError(nullptr, PA_CURRENT_FUNCTION, "Connection is null.");
 }
 
 

SerialPrograms/Source/Controllers/ControllerSession.h

@@ -37,6 +37,10 @@ class ControllerSession{
         const ControllerRequirements& requirements
     );
 
+    const ControllerRequirements& requirements(){
+        return m_requirements;
+    }
+
     void get(ControllerOption& option);
     void set(const ControllerOption& option);
 
@@ -47,7 +51,7 @@ class ControllerSession{
     const ControllerOption& option() const{
         return m_option;
     }
-    ControllerConnection& controller() const;
+    ControllerConnection& connection() const;
 
 
 public:

SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase.cpp

@@ -0,0 +1,60 @@
+/*  Serial Port (PABotBase)
+ *
+ *  From: https://github.com/PokemonAutomation/Arduino-Source
+ *
+ */
+
+#include "SerialPABotBase.h"
+
+namespace PokemonAutomation{
+namespace SerialPABotBase{
+
+
+const char INTERFACE_NAME[] = "SerialPABotBase";
+
+
+const char* to_string(Features feature){
+    switch (feature){
+    case Features::TickPrecise:             return "TickPrecise";
+    case Features::NintendoSwitch_Basic:    return "NintendoSwitch_Basic";
+    case Features::NintendoSwitch_Macros:   return "NintendoSwitch_Macros";
+    case Features::NintendoSwitch_DateSkip: return "NintendoSwitch_DateSkip";
+    }
+    return nullptr;
+}
+
+
+
+std::set<std::string> program_id_to_features(uint8_t id){
+    switch (id){
+    case PABB_PID_PABOTBASE_12KB:
+    case PABB_PID_PABOTBASE_31KB:
+        return {
+            to_string(Features::TickPrecise),
+            to_string(Features::NintendoSwitch_Basic),
+            to_string(Features::NintendoSwitch_Macros),
+            to_string(Features::NintendoSwitch_DateSkip),
+        };
+    }
+    return {};
+}
+
+
+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),
+    }
+};
+
+
+
+
+
+
+
+}
+}

SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase.h

@@ -0,0 +1,48 @@
+/*  Serial Port (PABotBase)
+ *
+ *  From: https://github.com/PokemonAutomation/Arduino-Source
+ *
+ */
+
+#ifndef PokemonAutomation_Controllers_SerialPABotBase_H
+#define PokemonAutomation_Controllers_SerialPABotBase_H
+
+#include <stdint.h>
+#include <string>
+#include <set>
+#include "Common/PokemonSwSh/PokemonProgramIDs.h"
+
+namespace PokemonAutomation{
+namespace SerialPABotBase{
+
+
+extern const char INTERFACE_NAME[];
+
+
+enum class Features{
+    TickPrecise,
+    NintendoSwitch_Basic,
+    NintendoSwitch_Macros,
+    NintendoSwitch_DateSkip,
+};
+
+
+const char* to_string(Features feature);
+
+
+std::set<std::string> program_id_to_features(uint8_t id);
+
+extern const std::pair<std::string, std::set<std::string>> OLD_SERIAL_DEFAULT;
+
+
+
+
+
+};
+
+
+
+
+
+}
+#endif