Automatically update serial port dropdown when a serial port changes.

Author: Mysticial

SerialPrograms/Source/CommonFramework/Globals.cpp

@@ -39,7 +39,7 @@ namespace PokemonAutomation{
 #endif
 
 #ifndef PA_VERSION_PATCH
-#define PA_VERSION_PATCH 2
+#define PA_VERSION_PATCH 3
 #endif
 
 const bool IS_BETA_VERSION = PA_IS_BETA;

SerialPrograms/Source/Controllers/PABotBase2/SerialPABotBase2_SelectorWidget.h

@@ -25,7 +25,10 @@ namespace SerialPABotBase{
 
 
 
-class SerialPABotBase2_SelectorWidget : public NoWheelCompactComboBox{
+class SerialPABotBase2_SelectorWidget
+    : public NoWheelCompactComboBox
+    , public SerialPortPoller::Listener
+{
 public:
     SerialPABotBase2_SelectorWidget(
         ControllerSelectorWidget& parent,
@@ -52,7 +55,7 @@ class SerialPABotBase2_SelectorWidget : public NoWheelCompactComboBox{
             parent.session().set_device(descriptor);
         }
 
-        refresh_devices();
+        refresh_devices(SerialPortPoller::instance().ports());
 
         connect(
             this, static_cast<void(QComboBox::*)(int)>(&QComboBox::activated),
@@ -69,13 +72,18 @@ class SerialPABotBase2_SelectorWidget : public NoWheelCompactComboBox{
                 }
 
                 parent.session().set_device(selected);
-                refresh_devices();
+                refresh_devices(SerialPortPoller::instance().ports());
             }
         );
+
+        SerialPortPoller::instance().add_listener(*this);
+    }
+    ~SerialPABotBase2_SelectorWidget(){
+        SerialPortPoller::instance().remove_listener(*this);
     }
 
-    void refresh_devices(){
-        SerialPortPoller::instance().begin_refresh_now();
+    void refresh_devices(const QList<QSerialPortInfo>& ports){
+//        SerialPortPoller::instance().begin_refresh_now();
 //        cout << "Current = " << width() << " x " << height() << endl;
 //        cout << "sizeHint = " << sizeHint().width() << " x " << sizeHint().height() << endl;
 //        cout << "minimumContentsLength = " << this->minimumContentsLength() << endl;
@@ -87,7 +95,7 @@ class SerialPABotBase2_SelectorWidget : public NoWheelCompactComboBox{
 
 
         m_ports.emplace_back(new SerialPABotBase2_Descriptor());
-        for (QSerialPortInfo& port : SerialPortPoller::instance().ports()){
+        for (const QSerialPortInfo& port : ports){
             if (filter_serial_port(port)){
                 m_ports.emplace_back(
                     new SerialPABotBase2_Descriptor(port.portName().toStdString())
@@ -115,6 +123,10 @@ class SerialPABotBase2_SelectorWidget : public NoWheelCompactComboBox{
         setCurrentIndex(index);
     }
 
+    virtual void on_serial_ports_changed(const QList<QSerialPortInfo>& ports) override{
+        refresh_devices(ports);
+    }
+
 
 private:
     ControllerSelectorWidget& m_parent;

SerialPrograms/Source/Controllers/SerialPortPollerQt.cpp

@@ -21,7 +21,9 @@ SerialPortPoller& SerialPortPoller::instance(){
     return poller;
 }
 
-SerialPortPoller::SerialPortPoller(){
+SerialPortPoller::SerialPortPoller()
+    : m_last_change(current_time())
+{
     global_periodic_runner().add_runnable(*this, std::chrono::seconds(10));
 }
 SerialPortPoller::~SerialPortPoller(){
@@ -35,6 +37,10 @@ void SerialPortPoller::stop(){
 void SerialPortPoller::begin_refresh_now(){
     global_periodic_runner().run_now_nonblocking(*this);
 }
+WallClock SerialPortPoller::last_changed() const{
+    ReadSpinLock lg(m_lock);
+    return m_last_change;
+}
 QList<QSerialPortInfo> SerialPortPoller::ports() const{
     ReadSpinLock lg(m_lock);
     return m_list;
@@ -59,15 +65,20 @@ void SerialPortPoller::run() noexcept{
             current.emplace(port.portName().toStdString(), port);
         }
 
+        WallClock now = current_time();
+        bool changed = false;
+
         WriteSpinLock lg(m_lock);
         auto iter0 = m_last.begin();
         auto iter1 = current.begin();
         while (iter0 != m_last.end() && iter1 != current.end()){
             if (iter0->first < iter1->first){
                 global_logger_tagged().log("Serial Port Removed: " + iter0->first, COLOR_RED);
+                changed = true;
                 ++iter0;
             }else if (iter0->first > iter1->first){
                 global_logger_tagged().log("Serial Port Added: " + iter1->first, COLOR_BLUE);
+                changed = true;
                 ++iter1;
             }else{
                 ++iter0;
@@ -76,12 +87,20 @@ void SerialPortPoller::run() noexcept{
         }
         for (; iter0 != m_last.end(); ++iter0){
             global_logger_tagged().log("Serial Port Removed: " + iter0->first, COLOR_RED);
+            changed = true;
         }
         for (; iter1 != current.end(); ++iter1){
             global_logger_tagged().log("Serial Port Added: " + iter1->first, COLOR_BLUE);
+            changed = true;
         }
         m_last = std::move(current);
         m_list = std::move(list);
+
+        if (changed){
+            m_last_change = now;
+            m_listeners.run_method(&Listener::on_serial_ports_changed, m_list);
+        }
+
     }catch (...){}
 //    cout << "SerialPortPoller::run() - end" << endl;
 }

SerialPrograms/Source/Controllers/SerialPortPollerQt.h

@@ -13,6 +13,7 @@
 
 #include <map>
 #include <QSerialPortInfo>
+#include "Common/Cpp/ListenerSet.h"
 #include "Common/Cpp/Concurrency/SpinLock.h"
 #include "Common/Cpp/Concurrency/PeriodicRunner.h"
 
@@ -21,12 +22,24 @@ namespace PokemonAutomation{
 
 
 class SerialPortPoller : public PeriodicRunner::Runnable{
+public:
+    struct Listener{
+        virtual void on_serial_ports_changed(const QList<QSerialPortInfo>& ports) = 0;
+    };
+    void add_listener(Listener& listener){
+        m_listeners.add(listener);
+    }
+    void remove_listener(Listener& listener){
+        m_listeners.remove(listener);
+    }
+
 public:
     static SerialPortPoller& instance();
 
     void stop();
 
     void begin_refresh_now();
+    WallClock last_changed() const;
     QList<QSerialPortInfo> ports() const;
     QSerialPortInfo get_port(const std::string& name) const;
 
@@ -37,8 +50,11 @@ class SerialPortPoller : public PeriodicRunner::Runnable{
     ~SerialPortPoller();
 
     mutable SpinLock m_lock;
+    WallClock m_last_change;
     std::map<std::string, QSerialPortInfo> m_last;
     QList<QSerialPortInfo> m_list;
+
+    ListenerSet<Listener> m_listeners;
 };