ConsolePanel.hpp

浏览该文件的文档.

#pragma once
 
#include "common/Export.h"
 
#include <cstdint>
#include <deque>
#include <mutex>
#include <string>
#include <vector>
 
struct SQVM;
typedef struct SQVM* HSQUIRRELVM;
 
namespace eve::dev {
 
struct EVENGINE_API_FOUNDATION_INLINE ConsoleLine {
    std::uint64_t seq = 0;    // process-lifetime sequence number; never reused
    std::string   timestamp;  // HH:MM:SS
    std::string   level;      // debug | info | warn | error | print | cmd | result | engine
    std::string   text;
};
 
struct EVENGINE_API_FOUNDATION_INLINE ConsoleSlice {
    std::vector<ConsoleLine> lines;
    std::uint64_t            firstSeq       = 0;  // oldest retained seq (nextSeq when empty)
    std::uint64_t            nextSeq        = 0;  // seq the next appended line will receive
    std::uint64_t            droppedThrough = 0;  // highest seq no longer retained
    std::uint64_t cursor    = 0;
    bool          truncated = false;  // cursor predates the retained window
};
 
class EVENGINE_API_FOUNDATION ConsolePanel {
public:
    static ConsolePanel& instance();
 
    ConsolePanel(const ConsolePanel&)            = delete;
    ConsolePanel& operator=(const ConsolePanel&) = delete;
 
    void setVisible(bool on);
    bool isVisible() const;
    void toggleVisible();
 
    void addLog(std::string level, std::string text);
    void addInfo(std::string text);
    void addWarn(std::string text);
    void addError(std::string text);
    void addEngineLine(const std::string& text);
    [[nodiscard]] bool isCapturingStderr() const;
 
    void                     clear();
    void                     setMaxEntries(size_t n);
    std::vector<ConsoleLine> recent(size_t max = 128) const;
    std::string              format(size_t max = 128) const;
 
    std::uint64_t nextSeq() const;
    std::uint64_t droppedThrough() const;
    [[nodiscard]] ConsoleSlice read(std::uint64_t afterSeq, size_t max = 64, const std::string& level = {}) const;
 
    void attach(HSQUIRRELVM vm);
    void detach();
    bool isAttached() const { return vm_ != nullptr; }
 
    std::string eval(const std::string& expression);
 
    void drawImGui();
 
    using ImGuiDrawer = void (*)(ConsolePanel& panel);
    static void setImGuiDrawer(ImGuiDrawer fn);
 
private:
    // Immortal<ConsolePanel> constructs the singleton (devtools/Immortal.hpp).
    template <typename>
    friend struct Immortal;
    ConsolePanel() = default;
 
    static std::string nowStamp();
 
    void appendLocked(std::string level, std::string text);
 
    mutable std::mutex      mu_;
    bool                    visible_    = true;
    size_t                  maxEntries_ = 500;
    std::deque<ConsoleLine> log_;
    HSQUIRRELVM             vm_ = nullptr;
    // Monotonic for the process lifetime: clear() drops lines but never rewinds
    // these, so an existing reader cursor stays meaningful.
    std::uint64_t nextSeq_        = 1;
    std::uint64_t droppedThrough_ = 0;
};
 
}  // namespace eve::dev