async_logger.h

Go to the documentation of this file.

#pragma once

 
#include "fl/log/async_log_queue.h"
#include "fl/stl/int.h"
#include "fl/stl/singleton.h"
#include "fl/task/task.h"
#include "fl/stl/noexcept.h"
 
namespace fl {
 
// Scheduler is now fl::task::Scheduler (aliased via fl/stl/async.h)

class AsyncLogger {
public:
    AsyncLogger() FL_NO_EXCEPT;
    ~AsyncLogger() FL_NO_EXCEPT = default;  // No cleanup needed (embedded storage)
 
    void push(const fl::string& msg) FL_NO_EXCEPT;
    void push(const char* msg) FL_NO_EXCEPT;
    void flush() FL_NO_EXCEPT;
    fl::size size() const FL_NO_EXCEPT;
    bool empty() const FL_NO_EXCEPT;
    void clear() FL_NO_EXCEPT;
    fl::u32 droppedCount() const FL_NO_EXCEPT;

    fl::size flushN(fl::size maxMessages) FL_NO_EXCEPT;

    bool enableBackgroundFlush(fl::u32 interval_ms, fl::size messages_per_tick = 5) FL_NO_EXCEPT;

    void disableBackgroundFlush() FL_NO_EXCEPT;

    bool isBackgroundFlushEnabled() const FL_NO_EXCEPT;
 
private:
    AsyncLogQueue<128, 4096> mQueue;  // Embedded storage (zero heap allocation)
};

enum class LogCategory : fl::u8 {
    PARLIO_ISR = 0,
    PARLIO_MAIN = 1,
    RMT_ISR = 2,
    RMT_MAIN = 3,
    SPI_ISR = 4,
    SPI_MAIN = 5,
    AUDIO_ISR = 6,
    AUDIO_MAIN = 7,
    INTERRUPT_ISR = 8,
    INTERRUPT_MAIN = 9,
    // Add new categories here (max 16 total)
    MAX_CATEGORIES = 10
};
 
namespace detail {
    // Forward declare BackgroundFlushState for async_log_service
    struct BackgroundFlushState;
 
    // Forward declare printLoggerDisabledError (defined in async_logger.cpp.hpp)
    void printLoggerDisabledError(const char* category_name, const char* define_name) FL_NO_EXCEPT;

    template<typename InfoProvider>
    inline void checkLoggerEnabled() FL_NO_EXCEPT {
        if (!InfoProvider::isEnabled()) {
            static bool error_printed = false;
            if (!error_printed) {
                error_printed = true;
                printLoggerDisabledError(InfoProvider::categoryName(), InfoProvider::defineName());
            }
        }
    }

    struct ParlioLoggerInfo {
        static const char* categoryName() FL_NO_EXCEPT { return "PARLIO"; }
        static const char* defineName() FL_NO_EXCEPT { return "FASTLED_LOG_PARLIO_ENABLED"; }
        static bool isEnabled() FL_NO_EXCEPT {
            #ifdef FASTLED_LOG_PARLIO_ENABLED
            return true;
            #else
            return false;
            #endif
        }
    };
 
    struct RmtLoggerInfo {
        static const char* categoryName() FL_NO_EXCEPT { return "RMT"; }
        static const char* defineName() FL_NO_EXCEPT { return "FASTLED_LOG_RMT_ENABLED"; }
        static bool isEnabled() FL_NO_EXCEPT {
            #ifdef FASTLED_LOG_RMT_ENABLED
            return true;
            #else
            return false;
            #endif
        }
    };
 
    struct SpiLoggerInfo {
        static const char* categoryName() FL_NO_EXCEPT { return "SPI"; }
        static const char* defineName() FL_NO_EXCEPT { return "FASTLED_LOG_SPI_ENABLED"; }
        static bool isEnabled() FL_NO_EXCEPT {
            #ifdef FASTLED_LOG_SPI_ENABLED
            return true;
            #else
            return false;
            #endif
        }
    };
 
    struct AudioLoggerInfo {
        static const char* categoryName() FL_NO_EXCEPT { return "AUDIO"; }
        static const char* defineName() FL_NO_EXCEPT { return "FASTLED_LOG_AUDIO_ENABLED"; }
        static bool isEnabled() FL_NO_EXCEPT {
            #ifdef FASTLED_LOG_AUDIO_ENABLED
            return true;
            #else
            return false;
            #endif
        }
    };
 
    struct InterruptLoggerInfo {
        static const char* categoryName() FL_NO_EXCEPT { return "INTERRUPT"; }
        static const char* defineName() FL_NO_EXCEPT { return "FASTLED_LOG_INTERRUPT_ENABLED"; }
        static bool isEnabled() FL_NO_EXCEPT {
            #ifdef FASTLED_LOG_INTERRUPT_ENABLED
            return true;
            #else
            return false;
            #endif
        }
    };
 
    struct FlexIOLoggerInfo {
        static const char* categoryName() FL_NO_EXCEPT { return "FLEX_IO"; }
        static const char* defineName() FL_NO_EXCEPT { return "FASTLED_LOG_FLEXIO_ENABLED"; }
        static bool isEnabled() FL_NO_EXCEPT {
            #ifdef FASTLED_LOG_FLEXIO_ENABLED
            return true;
            #else
            return false;
            #endif
        }
    };
 
    struct ObjectFLEDLoggerInfo {
        static const char* categoryName() FL_NO_EXCEPT { return "OBJECT_FLED"; }
        static const char* defineName() FL_NO_EXCEPT { return "FASTLED_LOG_OBJECTFLED_ENABLED"; }
        static bool isEnabled() FL_NO_EXCEPT {
            #ifdef FASTLED_LOG_OBJECTFLED_ENABLED
            return true;
            #else
            return false;
            #endif
        }
    };

    struct ActiveLoggerRegistry {
        fl::vector_fixed<AsyncLogger*, 16> mActiveLoggers;
 
        static ActiveLoggerRegistry& instance() FL_NO_EXCEPT {
            return SingletonShared<ActiveLoggerRegistry>::instance();
        }
 
        void registerLogger(AsyncLogger* logger) FL_NO_EXCEPT {
            // Check if already registered
            for (fl::size i = 0; i < mActiveLoggers.size(); ++i) {
                if (mActiveLoggers[i] == logger) {
                    return;  // Already registered
                }
            }
            // Add to active list
            mActiveLoggers.push_back(logger);
        }
 
        template<typename Func>
        void forEach(Func func) FL_NO_EXCEPT {
            for (fl::size i = 0; i < mActiveLoggers.size(); ++i) {
                func(*mActiveLoggers[i]);
            }
        }
    };

    class AsyncLoggerServiceTask {
    public:
        static AsyncLoggerServiceTask& instance() FL_NO_EXCEPT;

        void setInterval(u32 interval_ms) FL_NO_EXCEPT;

        u32 getInterval() const FL_NO_EXCEPT { return mIntervalMs; }

        void setMessagesPerTick(fl::size messages_per_tick) FL_NO_EXCEPT;

        fl::size getMessagesPerTick() const FL_NO_EXCEPT { return mMessagesPerTick; }

        void serviceLoggers() FL_NO_EXCEPT;
 
    private:
        friend class fl::SingletonShared<AsyncLoggerServiceTask>;
 
        AsyncLoggerServiceTask() FL_NO_EXCEPT;
        ~AsyncLoggerServiceTask() FL_NO_EXCEPT = default;
 
        u32 mIntervalMs;
        fl::size mMessagesPerTick;
        fl::task::Handle mTask;  // Task object (stored to allow dynamic interval changes)
    };
 
} // namespace detail

template<fl::size N, typename InfoProvider>
inline AsyncLogger& get_async_logger_by_index() FL_NO_EXCEPT {
    // Get singleton instance (only this specific N is instantiated)
    static AsyncLogger* logger_ptr = []() {
        AsyncLogger* ptr = &SingletonShared<AsyncLogger, N>::instance();
        detail::ActiveLoggerRegistry::instance().registerLogger(ptr);
 
        // Auto-instantiate service task on first logger access
        // This ensures automatic background servicing via fl::delay() and fl::task::Scheduler
        (void)detail::AsyncLoggerServiceTask::instance();
 
        return ptr;
    }();
 
    // Check if logging is enabled, print error once if not
    // (Implementation in async_logger.cpp.hpp uses FL_ERROR)
    detail::checkLoggerEnabled<InfoProvider>();
 
    return *logger_ptr;
}
 
// Convenience wrappers for category-based access (linker removes unused ones)
// Each wrapper uses an info provider to check if logging is enabled
// and prints an error message on first access if logging is disabled
 
inline AsyncLogger& get_parlio_async_logger_isr() FL_NO_EXCEPT {
    return get_async_logger_by_index<0, detail::ParlioLoggerInfo>();
}
 
inline AsyncLogger& get_parlio_async_logger_main() FL_NO_EXCEPT {
    return get_async_logger_by_index<1, detail::ParlioLoggerInfo>();
}
 
inline AsyncLogger& get_rmt_async_logger_isr() FL_NO_EXCEPT {
    return get_async_logger_by_index<2, detail::RmtLoggerInfo>();
}
 
inline AsyncLogger& get_rmt_async_logger_main() FL_NO_EXCEPT {
    return get_async_logger_by_index<3, detail::RmtLoggerInfo>();
}
 
inline AsyncLogger& get_spi_async_logger_isr() FL_NO_EXCEPT {
    return get_async_logger_by_index<4, detail::SpiLoggerInfo>();
}
 
inline AsyncLogger& get_spi_async_logger_main() FL_NO_EXCEPT {
    return get_async_logger_by_index<5, detail::SpiLoggerInfo>();
}
 
inline AsyncLogger& get_audio_async_logger_isr() FL_NO_EXCEPT {
    return get_async_logger_by_index<6, detail::AudioLoggerInfo>();
}
 
inline AsyncLogger& get_audio_async_logger_main() FL_NO_EXCEPT {
    return get_async_logger_by_index<7, detail::AudioLoggerInfo>();
}
 
inline AsyncLogger& get_interrupt_async_logger_isr() FL_NO_EXCEPT {
    return get_async_logger_by_index<8, detail::InterruptLoggerInfo>();
}
 
inline AsyncLogger& get_interrupt_async_logger_main() FL_NO_EXCEPT {
    return get_async_logger_by_index<9, detail::InterruptLoggerInfo>();
}
 
inline AsyncLogger& get_flexio_async_logger_isr() FL_NO_EXCEPT {
    return get_async_logger_by_index<10, detail::FlexIOLoggerInfo>();
}
 
inline AsyncLogger& get_flexio_async_logger_main() FL_NO_EXCEPT {
    return get_async_logger_by_index<11, detail::FlexIOLoggerInfo>();
}
 
inline AsyncLogger& get_objectfled_async_logger_isr() FL_NO_EXCEPT {
    return get_async_logger_by_index<12, detail::ObjectFLEDLoggerInfo>();
}
 
inline AsyncLogger& get_objectfled_async_logger_main() FL_NO_EXCEPT {
    return get_async_logger_by_index<13, detail::ObjectFLEDLoggerInfo>();
}
 
} // namespace fl