inspector.hpp

Go to the documentation of this file.

// Inspector — an overlay over the screen showing the view tree, the focus
// chain, the yoga box and the theme values of a view, and the frame's timings.
// Copyright (C) 2026 JigSawFr.  GPLv3-or-later (see LICENSE.GPL).
#pragma once
 
#include <nanovg.h>
 
#include <string>
#include <utility>
#include <vector>
 
namespace aurore
{
 
class View;
class FrameContext;
class InputManager;
struct ControllerState;
 
class Inspector
{
  public:
    enum class Mode
    {
        CLOSED,
        LIVE,
        BROWSE,
    };
 
    static void setEnabled(bool enabled);
    static bool isEnabled() { return enabled; }
 
    static void setMode(Mode mode);
    static Mode getMode() { return mode; }
    static bool isOpen() { return mode != Mode::CLOSED; }
 
    static void processInput(InputManager* input, ControllerState* state);
 
    // In Application::frame(), when open. The timings shown are the
    // Profiler's, which measures while the inspector is open.
    static void beginFrame();
    static void draw(FrameContext* ctx);
 
    static void forgetView(View* view);
 
    // Hooks of View, ThemeValues and StyleValues. `recordTarget` is the
    // selected view while the inspector is open (nullptr otherwise), and
    // `recording` is true while that view itself (not its children) draws.
    inline static View* recordTarget = nullptr;
    inline static bool recording     = false;
    static void recordColor(const std::string& name, NVGcolor color);
    static void recordMetric(const std::string& name, float value);
 
  private:
    inline static bool enabled = false;
    inline static Mode mode    = Mode::CLOSED;
};
 
} // namespace aurore