#include <DebugConsole.h>

Collaboration diagram for DebugConsole:

Static Public Member Functions
static void	setLocalTunnelHandlers (std::function< std::string()> startHandler, std::function< void()> stopHandler)

static void	setIdentityLogger (std::function< std::string()> identityLogger)

static void	addToggle (const DebugToggle &t)

static void	clearToggles ()

static void	RunActiveDebugToggles ()

static void	setDebugExecEnabled (bool v)

static bool	isDebugExecEnabled ()

static void	setVisible (bool v)

static bool	isVisible ()

static void	setActiveChannel (const std::string &ch)

static const std::string &	activeChannel ()

static void	bootstrapStdCapture ()

static void	Render ()

Static Private Member Functions
static void	buildChannelLists_ (std::vector< std::string > &display, std::vector< std::string > &order)

static void	renderLeftPanel_ ()

static void	renderRightPanel_ ()

static ImVec4	colorForLevel_ (Logger::Level lvl)

Static Private Attributes
static bool	visible_ = false

static std::string	activeChannel_ = "main"

static bool	autoScroll_ = true

static std::function< std::string()>	ltStart_

static std::function< std::string()>	identityLogger_

static std::function< void()>	ltStop_

static std::vector< DebugToggle >	toggles_

static bool	debugExecEnabled_ = false

static std::vector< std::string >	displayNames_

static std::vector< std::string >	channelOrder_

Detailed Description

Definition at line 18 of file DebugConsole.h.

Member Function Documentation

◆ activeChannel()

static const std::string & DebugConsole::activeChannel ( )

inlinestatic

Definition at line 82 of file DebugConsole.h.

    {
        return activeChannel_;
    }

◆ addToggle()

static void DebugConsole::addToggle ( const DebugToggle & t )

inlinestatic

Definition at line 36 of file DebugConsole.h.

    {
        toggles_.push_back(t);
    }

Here is the caller graph for this function:

◆ bootstrapStdCapture()

static void DebugConsole::bootstrapStdCapture ( )

inlinestatic

Definition at line 88 of file DebugConsole.h.

    {
        Logger::instance().installStdCapture();
        Logger::instance().log("main", "DebugConsole ready");
        Logger::instance().log("localtunnel", "(lt ready)");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildChannelLists_()

static void DebugConsole::buildChannelLists_	(	std::vector< std::string > &	display,
		std::vector< std::string > &	order )

inlinestaticprivate

Definition at line 126 of file DebugConsole.h.

    {
        auto chans = Logger::instance().channels();
 
        auto has = [&](const std::string& name)
        {
            return std::find(chans.begin(), chans.end(), name) != chans.end();
        };
        display.clear();
        order.clear();
 
        if (has("main"))
        {
            display.push_back("Main");
            order.push_back("main");
        }
        if (has("localtunnel"))
        {
            display.push_back("LocalTunnel");
            order.push_back("localtunnel");
        }
 
        for (auto& c : chans)
        {
            if (c != "main" && c != "localtunnel")
            {
                display.push_back(c);
                order.push_back(c);
            }
        }
        if (order.empty())
        { // ensure something is present
            display.push_back("Main");
            order.push_back("main");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearToggles()

static void DebugConsole::clearToggles ( )

inlinestatic

Definition at line 40 of file DebugConsole.h.

    {
        toggles_.clear();
    }

◆ colorForLevel_()

static ImVec4 DebugConsole::colorForLevel_ ( Logger::Level lvl )

inlinestaticprivate

Definition at line 306 of file DebugConsole.h.

    {
        switch (lvl)
        {
            case Logger::Level::Trace:
                return ImVec4(0.65f, 0.65f, 0.65f, 1.0f);
            case Logger::Level::Debug:
                return ImVec4(0.85f, 0.85f, 0.85f, 1.0f);
            case Logger::Level::Info:
                return ImVec4(0.60f, 0.80f, 1.00f, 1.0f);
            case Logger::Level::Warn:
                return ImVec4(1.00f, 0.85f, 0.40f, 1.0f);
            case Logger::Level::Success:
                return ImVec4(0.45f, 0.95f, 0.55f, 1.0f);
            case Logger::Level::Error:
                return ImVec4(1.00f, 0.45f, 0.45f, 1.0f);
        }
        return ImVec4(0.85f, 0.85f, 0.85f, 1.0f);
    }

Here is the caller graph for this function:

◆ isDebugExecEnabled()

static bool DebugConsole::isDebugExecEnabled ( )

inlinestatic

Definition at line 62 of file DebugConsole.h.

    {
        return debugExecEnabled_;
    }

◆ isVisible()

static bool DebugConsole::isVisible ( )

inlinestatic

Definition at line 72 of file DebugConsole.h.

    {
        return visible_;
    }

Here is the caller graph for this function:

◆ Render()

static void DebugConsole::Render ( )

inlinestatic

Definition at line 96 of file DebugConsole.h.

    {
        if (!visible_)
            return;
 
        ImGui::SetNextWindowSize(ImVec2(980, 560), ImGuiCond_FirstUseEver);
        ImGui::SetNextWindowBgAlpha(1.0f); // ensure opaque window
        if (ImGui::Begin("Console", &visible_, ImGuiWindowFlags_NoCollapse))
        {
            float leftWidth = 320.0f;
 
            ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.12f, 0.12f, 0.14f, 1.0f));
            ImGui::BeginChild("LeftPanel", ImVec2(leftWidth, 0), true);
            renderLeftPanel_();
            ImGui::EndChild();
            ImGui::PopStyleColor();
 
            ImGui::SameLine();
 
            ImGui::PushStyleColor(ImGuiCol_ChildBg, ImVec4(0.10f, 0.10f, 0.12f, 1.0f));
            ImGui::BeginChild("RightPanel", ImVec2(0, 0), true);
            renderRightPanel_();
            ImGui::EndChild();
            ImGui::PopStyleColor();
        }
        ImGui::End();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderLeftPanel_()

static void DebugConsole::renderLeftPanel_ ( )

inlinestaticprivate

Definition at line 164 of file DebugConsole.h.

    {
        ImGui::TextUnformatted("Console Select");
        ImGui::Separator();
 
        buildChannelLists_(displayNames_, channelOrder_);
        int sel = 0;
        for (int i = 0; i < (int)channelOrder_.size(); ++i)
        {
            if (channelOrder_[i] == activeChannel_)
            {
                sel = i;
                break;
            }
        }
 
        if (ImGui::BeginCombo("##ChannelCombo", displayNames_.empty() ? "<none>" : displayNames_[sel].c_str()))
        {
            for (int i = 0; i < (int)displayNames_.size(); ++i)
            {
                bool selected = (i == sel);
                if (ImGui::Selectable(displayNames_[i].c_str(), selected))
                {
                    sel = i;
                    activeChannel_ = channelOrder_[i];
                }
 
                if (selected)
                    ImGui::SetItemDefaultFocus();
            }
            ImGui::EndCombo();
        }
 
        if (ImGui::Button("Clear Console"))
        {
            Logger::instance().clearChannel(activeChannel_);
        }
 
        ImGui::Dummy(ImVec2(0, 6));
        ImGui::Separator();
        ImGui::TextUnformatted("LocalTunnel");
        if (ImGui::Button("Start"))
        {
            if (ltStart_)
            {
                auto url = ltStart_();
                if (!url.empty())
                    Logger::instance().log("localtunnel", Logger::Level::Success, "Started: " + url);
                else
                    Logger::instance().log("localtunnel", Logger::Level::Error, "Failed to start LT");
            }
            else
            {
                Logger::instance().log("localtunnel", Logger::Level::Error, "Start handler not set");
            }
        }
        ImGui::SameLine();
        if (ImGui::Button("Stop"))
        {
            if (ltStop_)
            {
                ltStop_();
                Logger::instance().log("localtunnel", "Stopped");
            }
            else
            {
                Logger::instance().log("localtunnel", "Stop handler not set");
            }
        }
 
        ImGui::Dummy(ImVec2(0, 6));
        ImGui::Separator();
 
        if (ImGui::Button("Print Identity"))
        {
            if (identityLogger_)
            {
                auto log = identityLogger_();
                Logger::instance().log("identity", log);
            }
            else
            {
                Logger::instance().log("localtunnel", "Identity handler not set");
            }
        }
 
        ImGui::Dummy(ImVec2(0, 6));
        ImGui::Separator();
        // Master switch for executing debug actions per-frame
        ImGui::Checkbox("Run Debug Actions", &debugExecEnabled_);
        ImGui::SetItemTooltip("When ON, the per-frame debug callbacks of active toggles will run.");
 
        ImGui::TextUnformatted("Debug Toggles");
        ImGui::BeginChild("TogglesScroll", ImVec2(0, -30), false, ImGuiWindowFlags_HorizontalScrollbar);
        for (auto& t : toggles_)
        {
            bool val = t.flagPtr ? *t.flagPtr : false;
            if (ImGui::Checkbox(t.label.c_str(), &val))
            {
                if (t.flagPtr)
                    *t.flagPtr = val;
                if (t.onChanged)
                    t.onChanged(val); // run once on change
            }
        }
        ImGui::EndChild();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderRightPanel_()

static void DebugConsole::renderRightPanel_ ( )

inlinestaticprivate

Definition at line 272 of file DebugConsole.h.

    {
        ImGui::Checkbox("Auto-scroll", &autoScroll_);
        ImGui::SameLine();
        static bool showTimestamps = true; // default ON
        ImGui::Checkbox("Timestamps", &showTimestamps);
 
        ImGui::Separator();
 
        auto entries = Logger::instance().getChannel(activeChannel_);
 
        ImGui::BeginChild("LogScroll", ImVec2(0, 0), false, ImGuiWindowFlags_HorizontalScrollbar);
        for (auto& e : entries)
        {
            ImVec4 col = colorForLevel_(e.level); // see helper below
 
            if (showTimestamps)
            {
                if (e.tsStr.empty())
                    e.tsStr = Logger::formatTs(e.tsMs);
                ImGui::PushStyleColor(ImGuiCol_Text, colorForLevel_(e.level)); // if you color by level
                ImGui::TextWrapped("%s", e.text.c_str());                      // wraps at window edge
                ImGui::PopStyleColor();
            }
            else
            {
                ImGui::TextColored(col, "%s", e.text.c_str());
            }
        }
        if (autoScroll_ && ImGui::GetScrollY() >= ImGui::GetScrollMaxY() - 5.0f)
            ImGui::SetScrollHereY(1.0f);
        ImGui::EndChild();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RunActiveDebugToggles()

static void DebugConsole::RunActiveDebugToggles ( )

inlinestatic

Definition at line 45 of file DebugConsole.h.

    {
        if (!debugExecEnabled_)
            return;
        for (auto& t : toggles_)
        {
            if (t.flagPtr && *t.flagPtr && t.onTick)
            {
                t.onTick(); // execute the active debug behavior for this frame
            }
        }
    }

Here is the caller graph for this function:

◆ setActiveChannel()

static void DebugConsole::setActiveChannel ( const std::string & ch )

inlinestatic

Definition at line 78 of file DebugConsole.h.

    {
        activeChannel_ = ch;
    }

◆ setDebugExecEnabled()

static void DebugConsole::setDebugExecEnabled ( bool v )

inlinestatic

Definition at line 58 of file DebugConsole.h.

    {
        debugExecEnabled_ = v;
    }

◆ setIdentityLogger()

static void DebugConsole::setIdentityLogger ( std::function< std::string()> identityLogger )

inlinestatic

Definition at line 30 of file DebugConsole.h.

    {
        identityLogger_ = std::move(identityLogger);
    }

Here is the caller graph for this function:

◆ setLocalTunnelHandlers()

static void DebugConsole::setLocalTunnelHandlers	(	std::function< std::string()>	startHandler,
		std::function< void()>	stopHandler )

inlinestatic

Definition at line 23 of file DebugConsole.h.

    {
        ltStart_ = std::move(startHandler);
        ltStop_ = std::move(stopHandler);
        Logger::instance().log("localtunnel", Logger::Level::Success, "Start and Stop Handlers Set!!!");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVisible()

static void DebugConsole::setVisible ( bool v )

inlinestatic

Definition at line 68 of file DebugConsole.h.

    {
        visible_ = v;
    }

Here is the caller graph for this function:

Member Data Documentation

◆ activeChannel_

std::string DebugConsole::activeChannel_ = "main"

inlinestaticprivate

Definition at line 328 of file DebugConsole.h.

◆ autoScroll_

bool DebugConsole::autoScroll_ = true

inlinestaticprivate

Definition at line 329 of file DebugConsole.h.

◆ channelOrder_

std::vector<std::string> DebugConsole::channelOrder_

inlinestaticprivate

Definition at line 338 of file DebugConsole.h.

◆ debugExecEnabled_

bool DebugConsole::debugExecEnabled_ = false

inlinestaticprivate

Definition at line 335 of file DebugConsole.h.

◆ displayNames_

std::vector<std::string> DebugConsole::displayNames_

inlinestaticprivate

Definition at line 337 of file DebugConsole.h.

◆ identityLogger_

std::function<std::string()> DebugConsole::identityLogger_

inlinestaticprivate

Definition at line 332 of file DebugConsole.h.

◆ ltStart_

std::function<std::string()> DebugConsole::ltStart_

inlinestaticprivate

Definition at line 331 of file DebugConsole.h.

◆ ltStop_

std::function<void()> DebugConsole::ltStop_

inlinestaticprivate

Definition at line 333 of file DebugConsole.h.

◆ toggles_

std::vector<DebugToggle> DebugConsole::toggles_

inlinestaticprivate

Definition at line 334 of file DebugConsole.h.

◆ visible_

bool DebugConsole::visible_ = false

inlinestaticprivate

Definition at line 327 of file DebugConsole.h.

The documentation for this class was generated from the following file:

include/debug/DebugConsole.h

Static Public Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ activeChannel()

◆ addToggle()

◆ bootstrapStdCapture()

◆ buildChannelLists_()

◆ clearToggles()

◆ colorForLevel_()

◆ isDebugExecEnabled()

◆ isVisible()

◆ Render()

◆ renderLeftPanel_()

◆ renderRightPanel_()

◆ RunActiveDebugToggles()

◆ setActiveChannel()

◆ setDebugExecEnabled()

◆ setIdentityLogger()

◆ setLocalTunnelHandlers()

◆ setVisible()

Member Data Documentation

◆ activeChannel_

◆ autoScroll_

◆ channelOrder_

◆ debugExecEnabled_

◆ displayNames_

◆ identityLogger_

◆ ltStart_

◆ ltStop_

◆ toggles_

◆ visible_