inspector_window.hpp

Go to the documentation of this file.

// inspector_window.hpp — Tabbed inspector window with collapsable property panels
#pragma once
 
#include <pulp/view/view.hpp>
#include <pulp/view/widgets.hpp>
#include <pulp/view/ui_components.hpp>
#include <pulp/view/tree_view.hpp>
#include <pulp/view/inspector.hpp>
#include <pulp/inspect/console_capture.hpp>
#include <pulp/inspect/state_inspector.hpp>
#include <pulp/render/render_pass.hpp>
 
#include <chrono>
#include <functional>
#include <map>
#include <memory>
#include <string>
#include <vector>
 
namespace pulp::view { class TextEditor; }  // wiring-tab note field (pointer only)
 
namespace pulp::inspect {
 
using namespace pulp::view;
using namespace pulp::canvas;
 
// ── CollapsableSection ─────────────────────────────────────────────────────
 
class CollapsableSection : public View {
public:
    CollapsableSection(std::string title, bool initially_expanded = true);
 
    bool is_expanded() const { return expanded_; }
    void set_expanded(bool e);

    View* content() const { return content_; }
 
    void paint(canvas::Canvas& canvas) override;
    void on_mouse_event(const MouseEvent& event) override;
 
private:
    std::string title_;
    bool expanded_;
    View* header_ = nullptr;   // owned as child
    View* content_ = nullptr;  // owned as child
 
    static constexpr float kHeaderHeight = 24.0f;
};
 
// ── ConsoleEntry (visual row) ──────────────────────────────────────────────

class ConsoleEntryView : public View {
public:
    void set_entry(const ConsoleCapture::Entry& entry);
 
    void paint(canvas::Canvas& canvas) override;
 
    float intrinsic_height() const override { return 22.0f; }
 
private:
    std::string level_;
    std::string message_;
    std::string timestamp_;
};
 
// ── InspectorWindow ────────────────────────────────────────────────────────
 
class InspectorWindow : public View {
public:
    InspectorWindow();
    ~InspectorWindow();

    explicit InspectorWindow(View& root);
 
    // ── Data sources ────────────────────────────────────────────────
    void set_inspected_root(View* root);

    void set_console_capture(ConsoleCapture* capture) { console_capture_ = capture; }

    void set_render_pass_manager(render::RenderPassManager* rpm) { rpm_ = rpm; }

    void set_state_inspector(StateInspector* si) { state_inspector_ = si; }

    void refresh();

    void select_tab(std::string_view title);

    void set_figma_file_key(std::string key) { figma_file_key_ = std::move(key); }

    bool export_wiring_annotations(const std::string& path) const;

    std::function<void(View* view)> on_view_selected;

    void select_view(View* view);

    void reflect_selection(View* view);

    void set_selection_readonly(bool readonly) {
        selection_readonly_ = readonly;
    }
    bool selection_readonly() const { return selection_readonly_; }
 
    // ── Figma-style tool strip (Select / Text) ─────────────────────
    //
    // A compact horizontal strip in the window header showing the two
    // tools (pointer = Select, "T" = Text) with the active one
    // highlighted. The strip is wired BOTH WAYS to the overlay's tool
    // mode via the host:
    //   * Click a tool button → on_tool_picked(0=Select, 1=Text) fires;
    //     the host calls InspectorOverlay::set_tool().
    //   * Keyboard V/T flips the overlay tool → the host calls
    //     set_active_tool() so the strip's highlight reflects it.
    void set_active_tool(int tool_index);
    int active_tool() const { return active_tool_; }

    std::function<void(int tool_index)> on_tool_picked;
 
private:
    // ── Tab construction ────────────────────────────────────────────
    std::unique_ptr<View> build_elements_tab();
    std::unique_ptr<View> build_console_tab();
    std::unique_ptr<View> build_performance_tab();
    std::unique_ptr<View> build_state_tab();
    std::unique_ptr<View> build_wiring_tab();
 
    // ── Refresh helpers ─────────────────────────────────────────────
    void refresh_elements();
    void refresh_console();
    void refresh_performance();
    void refresh_state();
    // Walks the inspected tree for DesignFrameView overlays that carry a Figma
    // source_node_id, lists each with its node id + kind + wired/unwired badge.
    void refresh_wiring();
    // Select a wiring row by node id: loads its note into the editor + updates
    // the detail line. Shared by row clicks and tests.
    void select_wiring_node(const std::string& node);
    // Figma editor URL for a node id (file_key + node-id), or "" if no file key.
    std::string figma_reveal_url(const std::string& node) const;
 
    void populate_tree_from_view(TreeNode& parent, View* view);
    void show_properties_for(View* view);
 
    // ── Data sources ────────────────────────────────────────────────
    View* inspected_root_ = nullptr;
    ConsoleCapture* console_capture_ = nullptr;
    render::RenderPassManager* rpm_ = nullptr;
    StateInspector* state_inspector_ = nullptr;
 
    // ── Widgets (non-owning, owned as children) ─────────────────────
    TabPanel* tabs_ = nullptr;
 
    // ── Tool strip ─────────────────────────────────────────────────
    // The strip View (custom paint + click handling) lives as the first
    // child of the window, above the tab panel. active_tool_ is the index
    // it highlights (0 = Select, 1 = Text). The strip reads active_tool_
    // each paint and calls on_tool_picked on a button click.
    class ToolStrip;
    ToolStrip* tool_strip_ = nullptr;
    int active_tool_ = 0;
 
    // Elements tab
    TreeView* tree_view_ = nullptr;
    ScrollView* tree_scroll_ = nullptr;  // viewport wrapping tree_view_
    CollapsableSection* identity_section_ = nullptr;
    CollapsableSection* layout_section_ = nullptr;
    CollapsableSection* visual_section_ = nullptr;
    CollapsableSection* widget_section_ = nullptr;
    CollapsableSection* theme_section_ = nullptr;
    View* elements_props_container_ = nullptr;
 
    // Console tab
    ScrollView* console_scroll_ = nullptr;
    View* console_list_ = nullptr;
 
    // Performance tab
    Label* fps_label_ = nullptr;
    Label* frame_time_label_ = nullptr;
    Label* gpu_render_label_ = nullptr;
    Label* budget_label_ = nullptr;
    View* pass_list_ = nullptr;
    Label* view_count_label_ = nullptr;
 
    // State tab
    ScrollView* state_scroll_ = nullptr;
    View* state_list_ = nullptr;
 
    ScrollView* wiring_scroll_ = nullptr;
    View* wiring_list_ = nullptr;
    TextEditor* wiring_note_editor_ = nullptr;  // note for the selected control
    Label* wiring_detail_ = nullptr;            // selected node id + kind + state
    Label* wiring_status_ = nullptr;            // export / reveal status line
    std::string figma_file_key_;                // for Reveal-in-Figma URLs
    std::string wiring_selected_;               // selected control's node id
    std::map<std::string, std::string> wiring_notes_;  // node id → developer note
    // Snapshot of the listed controls (rebuilt each refresh) so Export doesn't
    // have to re-walk the tree.
    struct WiringEntry { std::string node; std::string kind; bool wired = false; };
    std::vector<WiringEntry> wiring_entries_;
 
    // Currently selected view (Elements tab)
    View* selected_view_ = nullptr;
 
    // When true, tree-row clicks only display properties read-only and
    // never drive the shared selection (opt-out). Default false for
    // two-way selection. See set_selection_readonly().
    bool selection_readonly_ = false;
 
    // reflect_selection() (the canvas → window mirror) highlights the
    // matching tree row and shows props, the same as a tree-row pick.
    // Two-way selection is intentional; the only forbidden behavior is a
    // stray selection box inside the inspector window, blocked in the
    // paint hook.
 
    // Tree-structure signature, to suppress the empty-content flicker.
    // refresh_elements() runs on every idle tick (~30 Hz); rebuilding the
    // whole TreeView each tick clears then repopulates it, which flashes
    // empty. We hash the inspected tree's structure (type + id per node)
    // and only rebuild when it actually changed; otherwise we just refresh
    // the property labels for the current selection. Zero means "never built".
    std::size_t tree_signature_ = 0;
    // Compute the structural signature of the inspected tree.
    std::size_t compute_tree_signature(const View* view) const;
 
    // Property labels (Elements tab, Identity section)
    Label* prop_type_label_ = nullptr;
    Label* prop_id_label_ = nullptr;
 
    // Layout section labels
    Label* prop_bounds_label_ = nullptr;
    Label* prop_direction_label_ = nullptr;
    Label* prop_gap_label_ = nullptr;
    Label* prop_padding_label_ = nullptr;
    Label* prop_margin_label_ = nullptr;
    Label* prop_grow_shrink_label_ = nullptr;
 
    // Visual section labels
    Label* prop_opacity_label_ = nullptr;
    Label* prop_bgcolor_label_ = nullptr;
    Label* prop_border_label_ = nullptr;
    Label* prop_corner_label_ = nullptr;
    Label* prop_visible_label_ = nullptr;
    Label* prop_enabled_label_ = nullptr;
 
    // Widget section labels
    Label* prop_widget_value_label_ = nullptr;
};
 
} // namespace pulp::inspect