engine_events.cpp.hpp

Go to the documentation of this file.

#include "fl/system/engine_events.h"
#include "fl/stl/int.h"
// Note: fl/stl/cstdio.h intentionally NOT included — workaround for
// zackees/zccache#619 (Windows PCH path-spelling drift). The comment
// above said "for printf debug" but no printf-debug call survived.
#include "fl/stl/noexcept.h"
#if !FL_PLATFORM_HAS_TINY_MEMORY
#include "fl/channels/dither_frame.h"
#endif
 
 
namespace fl {
 
namespace {
// FL_LINT_ALLOW_GLOBAL(frame-task callback registry backing)
EngineEvents::Listener *gFrameTaskListener = nullptr;
}
 
// Explicitly define constructor and destructor
EngineEvents::EngineEvents() FL_NO_EXCEPT = default;
EngineEvents::~EngineEvents() FL_NO_EXCEPT = default;
 
 
EngineEvents::Listener::Listener() FL_NO_EXCEPT {}
 
EngineEvents::Listener::~Listener() FL_NO_EXCEPT {
#if FASTLED_HAS_ENGINE_EVENTS
    EngineEvents *ptr = EngineEvents::getInstance();
    const bool has_listener = ptr && ptr->_hasListener(this);
    if (has_listener) {
        // Warning, the listener should be removed by the subclass. If we are
        // here then the subclass did not remove the listener and we are now in
        // a partial state of destruction and the results may be undefined for
        // multithreaded applications. However, for single threaded (the only
        // option as of 2024, October) this will be ok.
        ptr->_removeListener(this);
    }
#endif
}
 
void EngineEvents::setFrameTaskListener(Listener *listener) FL_NO_EXCEPT {
    gFrameTaskListener = listener;
}
 
void EngineEvents::onBeginFrame() FL_NO_EXCEPT {
#if !FL_PLATFORM_HAS_TINY_MEMORY
    detail::advanceDitherFrame();
#endif
#if FASTLED_HAS_ENGINE_EVENTS
    EngineEvents::getInstance()->_onBeginFrame();
#endif
    if (gFrameTaskListener) {
        gFrameTaskListener->onBeginFrame();
    }
}
 
void EngineEvents::onEndFrame() FL_NO_EXCEPT {
#if FASTLED_HAS_ENGINE_EVENTS
    EngineEvents::getInstance()->_onEndFrame();
#endif
    if (gFrameTaskListener) {
        gFrameTaskListener->onEndFrame();
    }
}
 
#if FASTLED_HAS_ENGINE_EVENTS
EngineEvents *EngineEvents::getInstance() FL_NO_EXCEPT {
    return &Singleton<EngineEvents>::instance();
}
#endif
 
#if FASTLED_HAS_ENGINE_EVENTS
void EngineEvents::_onPlatformPreLoop() FL_NO_EXCEPT {
    for (auto &item : mListeners) {
        auto listener = item.listener;
        listener->onPlatformPreLoop();
    }
    for (auto &item : mListeners) {
        auto listener = item.listener;
        listener->onPlatformPreLoop2();
    }
}
 
bool EngineEvents::_hasListener(Listener *listener) FL_NO_EXCEPT {
    auto predicate = [listener](const Pair &pair) {
        return pair.listener == listener;
    };
    return mListeners.find_if(predicate) != mListeners.end();
}
 
void EngineEvents::_addListener(Listener *listener, int priority) FL_NO_EXCEPT {
    if (_hasListener(listener)) {
        return;
    }
    for (auto it = mListeners.begin(); it != mListeners.end(); ++it) {
        if (it->priority < priority) {
            // this is now the highest priority in this spot.
            EngineEvents::Pair pair = EngineEvents::Pair(listener, priority);
            mListeners.insert(it, pair);
            return;
        }
    }
    EngineEvents::Pair pair = EngineEvents::Pair(listener, priority);
    mListeners.push_back(pair);
}
 
void EngineEvents::_removeListener(Listener *listener) FL_NO_EXCEPT {
    auto predicate = [listener](const Pair &pair) {
        return pair.listener == listener;
    };
    auto it = mListeners.find_if(predicate);
    if (it != mListeners.end()) {
        mListeners.erase(it);
    }
}
 
void EngineEvents::_onBeginFrame() FL_NO_EXCEPT {
    // Make the copy of the listener list to avoid issues with listeners being
    // added or removed during the loop.
    ListenerList copy = mListeners;
    for (auto &item : copy) {
        auto listener = item.listener;
        listener->onBeginFrame();
    }
}
 
void EngineEvents::_onEndShowLeds() FL_NO_EXCEPT {
    // Make the copy of the listener list to avoid issues with listeners being
    // added or removed during the loop.
    ListenerList copy = mListeners;
    for (auto &item : copy) {
        auto listener = item.listener;
        listener->onEndShowLeds();
    }
}
 
void EngineEvents::_onEndFrame() FL_NO_EXCEPT {
    // Make the copy of the listener list to avoid issues with listeners being
    // added or removed during the loop.
    ListenerList copy = mListeners;
    for (auto &item : copy) {
        auto listener = item.listener;
        listener->onEndFrame();
    }
}
 
void EngineEvents::_onStripAdded(CLEDController *strip, fl::u32 num_leds) FL_NO_EXCEPT {
    // Make the copy of the listener list to avoid issues with listeners being
    // added or removed during the loop.
    ListenerList copy = mListeners;
    for (auto &item : copy) {
        auto listener = item.listener;
        listener->onStripAdded(strip, num_leds);
    }
}
 
void EngineEvents::_onCanvasUiSet(CLEDController *strip,
                                  const ScreenMap &screenmap) FL_NO_EXCEPT {
    // Make the copy of the listener list to avoid issues with listeners being
    // added or removed during the loop.
    ListenerList copy = mListeners;
    for (auto &item : copy) {
        auto listener = item.listener;
        listener->onCanvasUiSet(strip, screenmap);
    }
}
 
void EngineEvents::_onExit() FL_NO_EXCEPT {
    // Make the copy of the listener list to avoid issues with listeners being
    // added or removed during the loop.
    ListenerList copy = mListeners;
    for (auto &item : copy) {
        auto listener = item.listener;
        listener->onExit();
    }
}
 
#endif // FASTLED_HAS_ENGINE_EVENTS
 
} // namespace fl