More controller feature check to run-time.

Author: Mysticial

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

@@ -100,19 +100,19 @@ CollapsibleGroupBox* make_panel_header(
     const std::string& display_name,
     const std::string& doc_link,
     const std::string& description,
-    const ControllerRequirements& requirements,
+    const ControllerFeatures& required_features,
     FasterIfTickPrecise faster_if_tick_precise
 ){
     CollapsibleGroupBox* header = make_panel_header(parent, display_name, doc_link, description);
     QLayout* layout = header->widget()->layout();
 
     std::string text;
     do{
-        if (requirements.contains(ControllerFeature::NintendoSwitch_DateSkip)){
+        if (required_features.contains(ControllerFeature::NintendoSwitch_DateSkip)){
             text = html_color_text("(This program requires advanced RPCs. It requires Serial PABotBase.)", COLOR_RED);
             break;
         }
-        if (requirements.contains(ControllerFeature::TickPrecise)){
+        if (required_features.contains(ControllerFeature::TickPrecise)){
             text = html_color_text("(This program requires a tick-precise controller.)", COLOR_PURPLE);
             break;
         }

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

@@ -40,7 +40,7 @@ CollapsibleGroupBox* make_panel_header(
     const std::string& display_name,
     const std::string& doc_link,
     const std::string& description,
-    const ControllerRequirements& requirements,
+    const ControllerFeatures& required_features,
     FasterIfTickPrecise faster_if_tick_precise
 );
 

SerialPrograms/Source/CommonTools/StartupChecks/StartProgramChecks.cpp

@@ -10,6 +10,7 @@
 #include "CommonFramework/VideoPipeline/VideoOverlayScopes.h"
 #include "CommonFramework/Tools/VideoStream.h"
 #include "CommonTools/VisualDetectors/BlackBorderDetector.h"
+#include "Controllers/ControllerCapability.h"
 #include "StartProgramChecks.h"
 
 namespace PokemonAutomation{
@@ -21,26 +22,50 @@ void check_feedback(VideoStream& stream, FeedbackType feedback){
         return;
     }
     VideoSnapshot screen = stream.video().snapshot();
-    if (!screen){
-        if (feedback == FeedbackType::REQUIRED || feedback == FeedbackType::VIDEO_AUDIO){
-            throw UserSetupError(stream.logger(), "This program requires video feedback. Please make sure the video is working.");
-        }
+    if (screen){
         return;
     }
+    if (feedback == FeedbackType::REQUIRED || feedback == FeedbackType::VIDEO_AUDIO){
+        throw UserSetupError(
+            stream.logger(),
+            "This program requires video feedback. Please make sure the video is working."
+        );
+    }
 }
 
 void check_border(VideoStream& stream){
     BlackBorderDetector detector;
     VideoOverlaySet set(stream.overlay());
     detector.make_overlays(set);
     VideoSnapshot screen = stream.video().snapshot();
-    if (detector.detect(screen)){
-        throw UserSetupError(stream.logger(), "Black border detected! Please set your screen size to 100% in the TV Settings on your Nintendo Switch.");
+    if (!detector.detect(screen)){
+        return;
     }
+    throw UserSetupError(
+        stream.logger(),
+        "Black border detected! Please set your screen size to 100% in the TV Settings on your Nintendo Switch."
+    );
+}
+
 
+
+void check_controller_features(
+    Logger& logger,
+    const ControllerFeatures& capabilities,
+    const ControllerFeatures& required_features
+){
+    std::string missing_feature = capabilities.contains_all(required_features);
+    if (missing_feature.empty()){
+        return;
+    }
+    throw UserSetupError(
+        logger,
+        "Cannot start program. The controller is missing the feature: " + missing_feature
+    );
 }
 
 
 
+
 }
 }

SerialPrograms/Source/CommonTools/StartupChecks/StartProgramChecks.h

@@ -7,17 +7,26 @@
 #ifndef PokemonAutomation_CommonTools_StartProgramChecks_H
 #define PokemonAutomation_CommonTools_StartProgramChecks_H
 
+#include <set>
 #include "CommonFramework/Globals.h"
 
 namespace PokemonAutomation{
+    class Logger;
     class VideoStream;
+    class ControllerFeatures;
 namespace StartProgramChecks{
 
 
 
 void check_feedback(VideoStream& stream, FeedbackType feedback);
 void check_border(VideoStream& stream);
 
+void check_controller_features(
+    Logger& logger,
+    const ControllerFeatures& capabilities,
+    const ControllerFeatures& required_features
+);
+
 
 
 }

SerialPrograms/Source/Controllers/Controller.h

@@ -18,6 +18,7 @@ class QKeyEvent;
 namespace PokemonAutomation{
 
 enum class ControllerType;
+class ControllerFeatures;
 
 
 
@@ -42,6 +43,7 @@ class AbstractController{
     //  Static Information
 
     virtual ControllerType controller_type() const = 0;
+    virtual const ControllerFeatures& controller_features() const = 0;
 
     //  If the controller is polled at a fixed interval, this is that interval.
     //  Otherwise, returns zero.
@@ -56,7 +58,6 @@ class AbstractController{
     //  Status
 
     virtual bool is_ready() const = 0;
-    virtual std::string error_string() const = 0;
 
 
 public:

SerialPrograms/Source/Controllers/ControllerCapability.cpp

@@ -11,18 +11,10 @@ namespace PokemonAutomation{
 
 
 
-
-
-ControllerRequirements::ControllerRequirements(std::initializer_list<ControllerFeature> args)
-    : m_features(std::move(args))
-    , m_sanitizer("ControllerRequirements")
-{}
-
-std::string ControllerRequirements::check_compatibility(const std::set<ControllerFeature>& features) const{
+std::string ControllerFeatures::contains_all(const ControllerFeatures& features) const{
     auto scope_check = m_sanitizer.check_scope();
-
-    for (ControllerFeature feature : m_features){
-        if (features.find(feature) == features.end()){
+    for (ControllerFeature feature : features.m_features){
+        if (!contains(feature)){
             return CONTROLLER_FEATURE_STRINGS.get_string(feature);
         }
     }
@@ -32,4 +24,5 @@ std::string ControllerRequirements::check_compatibility(const std::set<Controlle
 
 
 
+
 }

SerialPrograms/Source/Controllers/ControllerCapability.h

@@ -27,19 +27,23 @@
 namespace PokemonAutomation{
 
 
-
-class ControllerRequirements{
+class ControllerFeatures{
 public:
-    ControllerRequirements(std::initializer_list<ControllerFeature> args);
+    ControllerFeatures()
+        : m_sanitizer("ControllerFeatures")
+    {}
+    ControllerFeatures(std::initializer_list<ControllerFeature> list)
+        : m_features(std::move(list))
+        , m_sanitizer("ControllerFeatures")
+    {}
 
     bool contains(ControllerFeature feature) const{
         return m_features.contains(feature);
     }
 
-    //  Check compatibility. If compatible, returns empty string.
-    //  Otherwise returns one of the missing features.
-    std::string check_compatibility(const std::set<ControllerFeature>& features) const;
-
+    //  Returns empty string if this class contains everything in "features".
+    //  Otherwise, returns the name of one of the missing features.
+    std::string contains_all(const ControllerFeatures& features) const;
 
 private:
     std::set<ControllerFeature> m_features;
@@ -49,6 +53,5 @@ class ControllerRequirements{
 
 
 
-
 }
 #endif

SerialPrograms/Source/Controllers/ControllerConnection.h

@@ -7,7 +7,6 @@
 #ifndef PokemonAutomation_Controllers_ControllerConnection_H
 #define PokemonAutomation_Controllers_ControllerConnection_H
 
-#include <set>
 #include "Common/Cpp/ListenerSet.h"
 #include "Common/Cpp/Concurrency/SpinLock.h"
 #include "ControllerDescriptor.h"
@@ -18,7 +17,7 @@ namespace PokemonAutomation{
 
 struct ControllerModeStatus{
     ControllerType current_controller = ControllerType::None;
-    std::map<ControllerType, std::set<ControllerFeature>> supported_controllers;
+    std::map<ControllerType, ControllerFeatures> supported_controllers;
 };
 
 

SerialPrograms/Source/Controllers/ControllerDescriptor.h

@@ -107,8 +107,7 @@ class ControllerDescriptor{
     virtual std::unique_ptr<AbstractController> make_controller(
         Logger& logger,
         ControllerConnection& connection,
-        ControllerType controller_type,
-        const ControllerRequirements& requirements
+        ControllerType controller_type
     ) const{
         return nullptr;
     }

SerialPrograms/Source/Controllers/ControllerSession.cpp

@@ -43,10 +43,10 @@ ControllerSession::~ControllerSession(){
 ControllerSession::ControllerSession(
     Logger& logger,
     ControllerOption& option,
-    const ControllerRequirements& requirements
+    const ControllerFeatures& required_features
 )
     : m_logger(logger)
-    , m_requirements(requirements)
+    , m_required_features(required_features)
     , m_option(option)
     , m_controller_type(ControllerType::None)
     , m_options_locked(false)
@@ -109,12 +109,6 @@ std::string ControllerSession::status_text() const{
     if (!m_connection){
         return "<font color=\"red\">No controller selected.</font>";
     }
-    if (m_controller){
-        std::string error_string = m_controller->error_string();
-        if (!error_string.empty()){
-            return error_string;
-        }
-    }
     return m_connection->status_text();
 }
 ControllerConnection& ControllerSession::connection() const{
@@ -310,7 +304,7 @@ void ControllerSession::post_connection_ready(
     ControllerConnection& connection,
     const ControllerModeStatus& mode_status
 ){
-    const std::map<ControllerType, std::set<ControllerFeature>>& supported_controllers = mode_status.supported_controllers;
+    const std::map<ControllerType, ControllerFeatures>& supported_controllers = mode_status.supported_controllers;
     if (supported_controllers.empty()){
         return;
     }
@@ -370,20 +364,14 @@ void ControllerSession::post_connection_ready(
             m_controller = m_descriptor->make_controller(
                 m_logger,
                 *m_connection,
-                current_controller,
-                m_requirements
+                current_controller
             );
         }
 
         //  Commit all changes.
 //        cout << "current_controller = " << CONTROLLER_TYPE_STRINGS.get_string(current_controller) << endl;
         m_controller_type = current_controller;
         ready = m_controller && m_controller->is_ready();
-
-        WriteSpinLock lg1(m_message_lock);
-        if (m_controller){
-            m_controller_error = m_controller->error_string();
-        }
     }
 
     signal_controller_changed(current_controller, available_controllers);