Delay construction of QSerialPortInfo to allow serialization even if invalid.

Author: Mysticial

SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase_Connection.cpp

@@ -19,29 +19,34 @@
 #include "SerialPABotBase.h"
 #include "SerialPABotBase_Connection.h"
 
+//#include <iostream>
+//using std::cout;
+//using std::endl;
+
 namespace PokemonAutomation{
 namespace SerialPABotBase{
 
 
 
 
-
 SerialPABotBase_Connection::SerialPABotBase_Connection(
     Logger& logger,
-    const QSerialPortInfo* port,
+    const std::string& name,
     bool set_to_null_controller
 )
     : m_logger(logger, GlobalSettings::instance().LOG_EVERYTHING)
 {
     set_status_line0("Not Connected", COLOR_RED);
 
-    //  No port selected.
-    if (port == nullptr || port->isNull()){
+    QSerialPortInfo info(QString::fromStdString(name));
+
+    //  Port is invalid.
+    if (info.isNull()){
         return;
     }
 
-    //  Prolific is banned.
-    if (port->description().indexOf("Prolific") != -1){
+    //  Prolific is banned
+    if (info.description().indexOf("Prolific") != -1){
         QMessageBox box;
         box.critical(
             nullptr,
@@ -56,11 +61,11 @@ SerialPABotBase_Connection::SerialPABotBase_Connection(
         return;
     }
 
-    m_device_name = port->portName().toStdString();
+    m_device_name = info.portName().toStdString();
     std::string error;
     try{
         set_status_line0("Connecting...", COLOR_DARKGREEN);
-        std::unique_ptr<SerialConnection> connection(new SerialConnection(port->systemLocation().toStdString(), PABB_BAUD_RATE));
+        std::unique_ptr<SerialConnection> connection(new SerialConnection(info.systemLocation().toStdString(), PABB_BAUD_RATE));
         m_botbase.reset(new PABotBase(m_logger, std::move(connection), nullptr));
     }catch (const ConnectionException& e){
         error = e.message();

SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase_Connection.h

@@ -17,8 +17,6 @@
 #include "Controllers/SerialPABotBase/Connection/MessageLogger.h"
 #include "Controllers/ControllerConnection.h"
 
-class QSerialPortInfo;
-
 namespace PokemonAutomation{
     class PABotBase;
 namespace SerialPABotBase{
@@ -28,7 +26,7 @@ class SerialPABotBase_Connection : public ControllerConnection{
 public:
     SerialPABotBase_Connection(
         Logger& logger,
-        const QSerialPortInfo* port,
+        const std::string& name,
         bool set_to_null_controller
     );
     ~SerialPABotBase_Connection();

SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase_Descriptor.cpp

@@ -32,36 +32,30 @@ bool SerialPABotBase_Descriptor::operator==(const ControllerDescriptor& x) const
     if (typeid(*this) != typeid(x)){
         return false;
     }
-    return m_port.portName() == static_cast<const SerialPABotBase_Descriptor&>(x).m_port.portName();
+    return m_name == static_cast<const SerialPABotBase_Descriptor&>(x).m_name;
 }
 
 
 std::string SerialPABotBase_Descriptor::display_name() const{
-    if (m_port.isNull()){
-        return "";
-    }
-//    if (PreloadSettings::instance().DEVELOPER_MODE){
-        return m_port.portName().toStdString();
-//    }
-//    return m_port.portName().toStdString() + " - " + m_port.description().toStdString();
+    return m_name;
 }
 void SerialPABotBase_Descriptor::load_json(const JsonValue& json){
     const std::string* name = json.to_string();
     if (name == nullptr || name->empty()){
         return;
     }
-    m_port = (QSerialPortInfo(QString::fromStdString(*name)));
+    m_name = *name;
 }
 JsonValue SerialPABotBase_Descriptor::to_json() const{
-    return m_port.isNull() ? "" : m_port.portName().toStdString();
+    return m_name;
 }
 
 std::unique_ptr<ControllerConnection> SerialPABotBase_Descriptor::open_connection(
     Logger& logger,
     bool set_to_null_controller
 ) const{
     return std::unique_ptr<ControllerConnection>(
-        new SerialPABotBase_Connection(logger, &m_port, set_to_null_controller)
+        new SerialPABotBase_Connection(logger, m_name, set_to_null_controller)
     );
 }
 std::unique_ptr<AbstractController> SerialPABotBase_Descriptor::make_controller(

SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase_Descriptor.h

@@ -7,7 +7,6 @@
 #ifndef PokemonAutomation_Controllers_SerialPABotBase_Descriptor_H
 #define PokemonAutomation_Controllers_SerialPABotBase_Descriptor_H
 
-#include <QSerialPortInfo>
 #include "Controllers/ControllerDescriptor.h"
 
 namespace PokemonAutomation{
@@ -24,13 +23,13 @@ class SerialPABotBase_Descriptor : public ControllerDescriptor{
     SerialPABotBase_Descriptor()
         : ControllerDescriptor(INTERFACE_NAME)
     {}
-    SerialPABotBase_Descriptor(const QSerialPortInfo& info)
+    SerialPABotBase_Descriptor(std::string name)
         : ControllerDescriptor(INTERFACE_NAME)
-        , m_port(info)
+        , m_name(std::move(name))
     {}
 
-    const QSerialPortInfo& port() const{
-        return m_port;
+    const std::string& name() const{
+        return m_name;
     }
 
     virtual bool operator==(const ControllerDescriptor& x) const override;
@@ -53,7 +52,7 @@ class SerialPABotBase_Descriptor : public ControllerDescriptor{
     virtual QWidget* make_selector_QtWidget(ControllerSelectorWidget& parent) const override;
 
 private:
-    QSerialPortInfo m_port;
+    std::string m_name;
 };
 
 

SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase_SelectorWidget.h

@@ -7,6 +7,7 @@
 #ifndef PokemonAutomation_Controllers_SerialPABotBase_SelectorWidget_H
 #define PokemonAutomation_Controllers_SerialPABotBase_SelectorWidget_H
 
+#include <QSerialPortInfo>
 #include "Common/Qt/NoWheelComboBox.h"
 #include "Controllers/ControllerDescriptor.h"
 #include "Controllers/ControllerSelectorWidget.h"
@@ -89,7 +90,7 @@ class SerialPABotBase_SelectorWidget : public NoWheelComboBox{
                 continue;
             }
 #endif
-            m_ports.emplace_back(new SerialPABotBase_Descriptor(port));
+            m_ports.emplace_back(new SerialPABotBase_Descriptor(port.portName().toStdString()));
         }
 
         size_t width = 6;

SerialPrograms/Source/Tests/NintendoSwitch_Tests.cpp

@@ -29,7 +29,7 @@ using namespace NintendoSwitch;
 int test_NintendoSwitch_UpdatePopupDetector(const ImageViewRGB32& image, bool target){
     auto& logger = global_logger_command_line();
     DummyBotBase botbase(logger);
-    SerialPABotBase::SerialPABotBase_Connection connection(logger, nullptr, false);
+    SerialPABotBase::SerialPABotBase_Connection connection(logger, "", false);
     SerialPABotBase_WiredController controller(
         logger, connection,
         ControllerType::NintendoSwitch_WiredController,

SerialPrograms/Source/Tests/PokemonLA_Tests.cpp

@@ -491,7 +491,7 @@ int test_pokemonLA_SaveScreenDetector(const ImageViewRGB32& image, const std::ve
 int test_pokemonLA_shinySoundDetector(const std::vector<AudioSpectrum>& spectrums, bool target){
     auto& logger = global_logger_command_line();
     DummyBotBase botbase(logger);
-    SerialPABotBase::SerialPABotBase_Connection connection(logger, nullptr, false);
+    SerialPABotBase::SerialPABotBase_Connection connection(logger, "", false);
     SerialPABotBase_WiredController controller(
         logger, connection,
         ControllerType::NintendoSwitch_WiredController,