Listener cleanup.

Author: Mysticial

SerialPrograms/Source/CommonFramework/Environment/SystemSleep.cpp

@@ -29,17 +29,13 @@ SystemSleepController::SystemSleepController()
 {}
 
 void SystemSleepController::add_listener(Listener& listener){
-    std::lock_guard<std::mutex> lg(m_lock);
-    m_listeners.insert(&listener);
+    m_listeners.add(listener);
 }
 void SystemSleepController::remove_listener(Listener& listener){
-    std::lock_guard<std::mutex> lg(m_lock);
-    m_listeners.erase(&listener);
+    m_listeners.remove(listener);
 }
 void SystemSleepController::notify_listeners(SleepSuppress state){
-    for (Listener* listener : m_listeners){
-        listener->sleep_suppress_state_changed(state);
-    }
+    m_listeners.run_method_unique(&Listener::sleep_suppress_state_changed, state);
 }
 
 SleepSuppress SystemSleepController::current_state() const{

SerialPrograms/Source/CommonFramework/Environment/SystemSleep.h

@@ -7,11 +7,10 @@
 #ifndef PokemonAutomation_SystemSleep_H
 #define PokemonAutomation_SystemSleep_H
 
-#include <memory>
 #include <set>
 #include <atomic>
 #include <mutex>
-#include "Common/Compiler.h"
+#include "Common/Cpp/ListenerSet.h"
 
 #if _WIN32
 #define PA_ENABLE_SLEEP_SUPPRESS
@@ -76,7 +75,7 @@ class SystemSleepController{
     std::atomic<SleepSuppress> m_state;
 
     std::mutex m_lock;
-    std::set<Listener*> m_listeners;
+    ListenerSet<Listener> m_listeners;
 };
 
 

SerialPrograms/Source/CommonFramework/ProgramSession.cpp

@@ -17,12 +17,10 @@ namespace PokemonAutomation{
 
 
 void ProgramSession::add_listener(Listener& listener){
-    std::lock_guard<std::mutex> lg(m_lock);
-    m_listeners.insert(&listener);
+    m_listeners.add(listener);
 }
 void ProgramSession::remove_listener(Listener& listener){
-    std::lock_guard<std::mutex> lg(m_lock);
-    m_listeners.erase(&listener);
+    m_listeners.remove(listener);
 }
 
 
@@ -99,19 +97,17 @@ void ProgramSession::set_state(ProgramState state){
         break;
     }
     m_state.store(state, std::memory_order_relaxed);
-    for (Listener* listener : m_listeners){
-        listener->state_change(state);
-    }
+    m_listeners.run_method_unique(&Listener::state_change, state);
 }
 void ProgramSession::push_stats(){
-    for (Listener* listener : m_listeners){
-        listener->stats_update(m_current_stats.get(), m_historical_stats.get());
-    }
+    m_listeners.run_method_unique(
+        &Listener::stats_update,
+        m_current_stats.get(),
+        m_historical_stats.get()
+    );
 }
 void ProgramSession::push_error(const std::string& message){
-    for (Listener* listener : m_listeners){
-        listener->error(message);
-    }
+    m_listeners.run_method_unique(&Listener::error, message);
 }
 
 void ProgramSession::load_historical_stats(){

SerialPrograms/Source/CommonFramework/ProgramSession.h

@@ -16,11 +16,11 @@
 #ifndef PokemonAutomation_CommonFramework_ProgramSession_H
 #define PokemonAutomation_CommonFramework_ProgramSession_H
 
-#include <set>
 #include <mutex>
 #include <atomic>
 #include <thread>
 #include "Common/Cpp/Time.h"
+#include "Common/Cpp/ListenerSet.h"
 #include "CommonFramework/Globals.h"
 #include "CommonFramework/Logging/Logger.h"
 #include "Integrations/ProgramTrackerInterfaces.h"
@@ -138,7 +138,7 @@ class ProgramSession : public TrackableProgram{
     std::unique_ptr<StatsTracker> m_current_stats;
 //    CancellableScope* m_scope = nullptr;
 
-    std::set<Listener*> m_listeners;
+    ListenerSet<Listener> m_listeners;
 };
 
 

SerialPrograms/Source/CommonFramework/VideoPipeline/VideoOverlayScopes.h

@@ -57,8 +57,8 @@ class OverlayBoxScope : public OverlayBox{
 
 
 
-// A text as part of the video overlay.
-// It handles its own life time on video overlay: once it's destroyed, it removes itself from VideoOverlay.
+//  A text as part of the video overlay.
+//  It handles its own life time on video overlay: once it's destroyed, it removes itself from VideoOverlay.
 class OverlayTextScope : public OverlayText{
     OverlayTextScope(const OverlayTextScope&) = delete;
     void operator=(const OverlayTextScope&) = delete;

SerialPrograms/Source/CommonFramework/VideoPipeline/VideoOverlaySession.cpp

@@ -17,9 +17,11 @@ namespace PokemonAutomation{
 void VideoOverlaySession::add_listener(Listener& listener){
     WriteSpinLock lg(m_lock);
     m_listeners.insert(&listener);
+    listener.update_stats(&m_stats_order);
 }
 void VideoOverlaySession::remove_listener(Listener& listener){
     WriteSpinLock lg(m_lock);
+//    listener.update_stats(nullptr);
     m_listeners.erase(&listener);
 }
 
@@ -111,7 +113,8 @@ void VideoOverlaySession::push_box_update(){
         return;
     }
 
-    // We create a newly allocated Box vector to avoid listeners accessing `m_boxes` asynchronously.
+    //  We create a newly allocated Box vector to avoid listeners accessing
+    //  `m_boxes` asynchronously.
     std::shared_ptr<std::vector<OverlayBox>> ptr = std::make_shared<std::vector<OverlayBox>>();
     for (const auto& item : m_boxes){
         ptr->emplace_back(*item);
@@ -146,7 +149,8 @@ void VideoOverlaySession::push_text_update(){
         return;
     }
 
-    // We create a newly allocated Box vector to avoid listeners accessing `m_texts` asynchronously.
+    //  We create a newly allocated Box vector to avoid listeners accessing
+    //  `m_texts` asynchronously.
     std::shared_ptr<std::vector<OverlayText>> ptr = std::make_shared<std::vector<OverlayText>>();
     for (const auto& item : m_texts){
         ptr->emplace_back(*item);
@@ -187,7 +191,8 @@ void VideoOverlaySession::push_log_text_update(){
         return;
     }
 
-    // We create a newly allocated Box vector to avoid listeners accessing `m_log_texts` asynchronously.
+    //  We create a newly allocated Box vector to avoid listeners accessing
+    //  `m_log_texts` asynchronously.
     std::shared_ptr<std::vector<OverlayLogLine>> ptr = std::make_shared<std::vector<OverlayLogLine>>();
     for(const auto& item : m_log_texts){
         ptr->emplace_back(item);

SerialPrograms/Source/CommonFramework/VideoPipeline/VideoOverlaySession.h

@@ -19,10 +19,8 @@
 #include <set>
 #include <map>
 #include <deque>
-#include "Common/Compiler.h"
 #include "Common/Cpp/Color.h"
 #include "Common/Cpp/Concurrency/SpinLock.h"
-#include "CommonFramework/ImageTools/ImageBoxes.h"
 #include "VideoOverlay.h"
 #include "VideoOverlayOption.h"
 
@@ -56,14 +54,17 @@ class VideoOverlaySession : public VideoOverlay{
         //  change the structure of the list itself, you must first call this
         //  with null to remove it from all the listeners. Then add the updated
         //  one back when you're done.
+        //  This is called immediately when attaching a listener to give the
+        //  current stats. The listener must drop all references to the stats
+        //  before detaching.
         virtual void update_stats(const std::list<OverlayStat*>* stats){}
 
     };
 
-    // Add a UI class to listen to any overlay change. The UI class needs to inherit Listener.
-    // Must call `remove_listener()` before listener is destroyed.
+    //  Add a UI class to listen to any overlay change. The UI class needs to inherit Listener.
+    //  Must call `remove_listener()` before listener is destroyed.
     void add_listener(Listener& listener);
-    // remove a UI class that listens to the overlay change, added by `add_listener()`.
+    //  Remove a UI class that listens to the overlay change, added by `add_listener()`.
     void remove_listener(Listener& listener);
 
 public:

SerialPrograms/Source/NintendoSwitch/Framework/NintendoSwitch_MultiSwitchProgramSession.cpp

@@ -46,9 +46,9 @@ MultiSwitchProgramSession::MultiSwitchProgramSession(MultiSwitchProgramOption& o
     , m_scope(nullptr)
     , m_sanitizer("MultiSwitchProgramSession")
 {
-    WriteSpinLock lg(m_lock);
-    m_system.add_listener(*this);
+//    WriteSpinLock lg(m_lock);
     m_option.instance().update_active_consoles(option.system().count());
+    m_system.add_listener(*this);
 }
 
 MultiSwitchProgramSession::~MultiSwitchProgramSession(){

SerialPrograms/Source/NintendoSwitch/Framework/NintendoSwitch_MultiSwitchSystemSession.cpp

@@ -15,6 +15,7 @@ namespace NintendoSwitch{
 void MultiSwitchSystemSession::add_listener(Listener& listener){
     std::lock_guard<std::mutex> lg(m_lock);
     m_listeners.insert(&listener);
+    listener.startup(m_consoles.size());
 }
 void MultiSwitchSystemSession::remove_listener(Listener& listener){
     std::lock_guard<std::mutex> lg(m_lock);

SerialPrograms/Source/NintendoSwitch/Framework/NintendoSwitch_MultiSwitchSystemSession.h

@@ -31,6 +31,9 @@ class MultiSwitchSystemSession{
         virtual void shutdown() = 0;
 
         //  Sent after new Switches are started up.
+        //  This is called immediately when attaching a listener to give the
+        //  current switch count. The listener must drop all references to the
+        //  switch sessions before detaching.
         virtual void startup(size_t switch_count) = 0;
     };
     void add_listener(Listener& listener);