trace.h

Go to the documentation of this file.

#pragma once

 
#include "fl/stl/tuple.h"
#include "fl/stl/chrono.h"  // IWYU pragma: keep
#include "fl/stl/stdint.h"
#include "fl/stl/string.h"  // IWYU pragma: keep
#include "fl/stl/vector.h"
#include "fl/stl/compiler_control.h"  // For FL_FUNCTION  // IWYU pragma: keep
#include "fl/stl/noexcept.h"
 
namespace fl {

using TracePoint = fl::tuple<const char*, int, fl::u32>;

class ScopedTrace {
public:
    explicit ScopedTrace(const char* function, int line) FL_NOEXCEPT;

    ~ScopedTrace() FL_NOEXCEPT;
 
    // Non-copyable, non-movable
    ScopedTrace(const ScopedTrace&) FL_NOEXCEPT = delete;
    ScopedTrace& operator=(const ScopedTrace&) FL_NOEXCEPT = delete;
    ScopedTrace(ScopedTrace&&) FL_NOEXCEPT = delete;
    ScopedTrace& operator=(ScopedTrace&&) FL_NOEXCEPT = delete;

    static void push(const char* function, int line) FL_NOEXCEPT;

    static void pop() FL_NOEXCEPT;

    static fl::size depth() FL_NOEXCEPT;

    static fl::string dump() FL_NOEXCEPT;

    static void dump(fl::vector<TracePoint>* out) FL_NOEXCEPT;

    static void clear() FL_NOEXCEPT;
};
 
} // namespace fl

#define FL_TRACE fl::make_tuple(__FILE__, int(__LINE__), fl::millis())
 
#ifdef FASTLED_DEBUG_STACK_TRACE
#define FL_SCOPED_TRACE_CONCAT(name, line) fl::ScopedTrace __fl_trace_##line(name, line)

#define FL_SCOPED_TRACE_IMPL(name, line) FL_SCOPED_TRACE_CONCAT(name, line)

#define FL_SCOPED_TRACE_NAMED(name) FL_SCOPED_TRACE_IMPL(name, __LINE__)

#define FL_SCOPED_TRACE FL_SCOPED_TRACE_IMPL(FL_FUNCTION, __LINE__)

#define FL_TRACE_DUMP() FL_DBG(fl::ScopedTrace::dump())
 
#else
// No-op macros when stack tracing is disabled
#define FL_SCOPED_TRACE_NAMED(name) do {} while(0)
#define FL_SCOPED_TRACE do {} while(0)
#define FL_TRACE_DUMP() do {} while(0)
#endif // FASTLED_DEBUG_STACK_TRACE