mirrors/ghostty
1
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2026-04-14 11:35:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

inspector: surface info is back

Browse Source
This commit is contained in:
Mitchell Hashimoto
2026-01-28 13:01:25 -08:00
parent 53b2a777e7
commit 7f008d126f
4 changed files with 333 additions and 323 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/inspector/Inspector.zig
View File

@@ -31,7 +31,7 @@ first_render: bool = true,
/// Mouse state that we track in addition to normal mouse states that
/// Ghostty always knows about.
mouse: inspector.surface.Mouse = .{},
mouse: widgets.surface.Mouse = .{},
/// A selected cell.
cell: CellInspect = .{ .idle = {} },
@@ -214,7 +214,7 @@ pub fn recordPtyRead(self: *Inspector, data: []const u8) !void {
/// Render the frame.
pub fn render(self: *Inspector) void {
self.gui.draw(self.surface);
self.gui.draw(self.surface, self.mouse);
if (true) return;
const dock_id = cimgui.c.ImGui_DockSpaceOverViewport();

2
src/inspector/main.zig
View File

@@ -2,7 +2,7 @@ const std = @import("std");
pub const cell = @import("cell.zig");
pub const key = @import("key.zig");
pub const page = @import("page.zig");
pub const surface = @import("surface.zig");
pub const termio = @import("termio.zig");
pub const Cell = cell.Cell;

319
src/inspector/surface.zig
View File

@@ -1,319 +0,0 @@
const cimgui = @import("dcimgui");
const input = @import("../input.zig");
const renderer = @import("../renderer.zig");
const terminal = @import("../terminal/main.zig");
const Surface = @import("../Surface.zig");
pub const Mouse = struct {
/// Last hovered x/y
last_xpos: f64 = 0,
last_ypos: f64 = 0,
// Last hovered screen point
last_point: ?terminal.Pin = null,
};
/// Window to show surface information.
pub const Window = struct {
/// Window name/id.
pub const name = "Surface Info";
pub const FrameData = struct {
/// The surface that we're inspecting.
surface: *Surface,
/// Mouse state that we track in addition to normal mouse states that
/// Ghostty always knows about.
mouse: Mouse = .{},
};
/// Render
pub fn render(self: *Window, data: FrameData) void {
_ = self;
// Start our window. If we're collapsed we do nothing.
defer cimgui.c.ImGui_End();
if (!cimgui.c.ImGui_Begin(
name,
null,
cimgui.c.ImGuiWindowFlags_NoFocusOnAppearing,
)) return;
if (cimgui.c.ImGui_CollapsingHeader(
"Help",
cimgui.c.ImGuiTreeNodeFlags_None,
)) {
cimgui.c.ImGui_TextWrapped(
"This window displays information about the surface (window). " ++
"A surface is the graphical area that displays the terminal " ++
"content. It includes dimensions, font sizing, and mouse state " ++
"information specific to this window instance.",
);
}
cimgui.c.ImGui_SeparatorText("Dimensions");
{
_ = cimgui.c.ImGui_BeginTable(
"table_size",
2,
cimgui.c.ImGuiTableFlags_None,
);
defer cimgui.c.ImGui_EndTable();
// Screen Size
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Screen Size");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"%dpx x %dpx",
data.surface.size.screen.width,
data.surface.size.screen.height,
);
}
}
// Grid Size
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Grid Size");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
const grid_size = data.surface.size.grid();
cimgui.c.ImGui_Text(
"%dc x %dr",
grid_size.columns,
grid_size.rows,
);
}
}
// Cell Size
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Cell Size");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"%dpx x %dpx",
data.surface.size.cell.width,
data.surface.size.cell.height,
);
}
}
// Padding
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Window Padding");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"T=%d B=%d L=%d R=%d px",
data.surface.size.padding.top,
data.surface.size.padding.bottom,
data.surface.size.padding.left,
data.surface.size.padding.right,
);
}
}
}
cimgui.c.ImGui_SeparatorText("Font");
{
_ = cimgui.c.ImGui_BeginTable(
"table_font",
2,
cimgui.c.ImGuiTableFlags_None,
);
defer cimgui.c.ImGui_EndTable();
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Size (Points)");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"%.2f pt",
data.surface.font_size.points,
);
}
}
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Size (Pixels)");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"%.2f px",
data.surface.font_size.pixels(),
);
}
}
}
cimgui.c.ImGui_SeparatorText("Mouse");
{
_ = cimgui.c.ImGui_BeginTable(
"table_mouse",
2,
cimgui.c.ImGuiTableFlags_None,
);
defer cimgui.c.ImGui_EndTable();
const mouse = &data.surface.mouse;
const t = data.surface.renderer_state.terminal;
{
const hover_point: terminal.point.Coordinate = pt: {
const p = data.mouse.last_point orelse break :pt .{};
const pt = t.screens.active.pages.pointFromPin(
.active,
p,
) orelse break :pt .{};
break :pt pt.coord();
};
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Hover Grid");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"row=%d, col=%d",
hover_point.y,
hover_point.x,
);
}
}
{
const coord: renderer.Coordinate.Terminal = (renderer.Coordinate{
.surface = .{
.x = data.mouse.last_xpos,
.y = data.mouse.last_ypos,
},
}).convert(.terminal, data.surface.size).terminal;
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Hover Point");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"(%dpx, %dpx)",
@as(i64, @intFromFloat(coord.x)),
@as(i64, @intFromFloat(coord.y)),
);
}
}
const any_click = for (mouse.click_state) |state| {
if (state == .press) break true;
} else false;
click: {
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Click State");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
if (!any_click) {
cimgui.c.ImGui_Text("none");
break :click;
}
for (mouse.click_state, 0..) |state, i| {
if (state != .press) continue;
const button: input.MouseButton = @enumFromInt(i);
cimgui.c.ImGui_SameLine();
cimgui.c.ImGui_Text("%s", (switch (button) {
.unknown => "?",
.left => "L",
.middle => "M",
.right => "R",
.four => "{4}",
.five => "{5}",
.six => "{6}",
.seven => "{7}",
.eight => "{8}",
.nine => "{9}",
.ten => "{10}",
.eleven => "{11}",
}).ptr);
}
}
}
{
const left_click_point: terminal.point.Coordinate = pt: {
const p = mouse.left_click_pin orelse break :pt .{};
const pt = t.screens.active.pages.pointFromPin(
.active,
p.*,
) orelse break :pt .{};
break :pt pt.coord();
};
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Click Grid");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"row=%d, col=%d",
left_click_point.y,
left_click_point.x,
);
}
}
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Click Point");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"(%dpx, %dpx)",
@as(u32, @intFromFloat(mouse.left_click_xpos)),
@as(u32, @intFromFloat(mouse.left_click_ypos)),
);
}
}
}
}
};

331
src/inspector/widgets/surface.zig
View File

@@ -4,22 +4,27 @@ const assert = @import("../../quirks.zig").inlineAssert;
const Allocator = std.mem.Allocator;
const cimgui = @import("dcimgui");
const widgets = @import("../widgets.zig");
const input = @import("../../input.zig");
const renderer = @import("../../renderer.zig");
const terminal = @import("../../terminal/main.zig");
const Surface = @import("../../Surface.zig");
/// This is discovered via the hardcoded string in the ImGui demo window.
const window_imgui_demo = "Dear ImGui Demo";
const window_terminal = "Terminal";
const window_surface = "Surface";
pub const Inspector = struct {
/// Internal GUI state
surface_info: Info,
terminal_info: widgets.terminal.Info,
pub const empty: Inspector = .{
.surface_info = .empty,
.terminal_info = .empty,
};
pub fn draw(self: *Inspector, surface: *const Surface) void {
pub fn draw(self: *Inspector, surface: *const Surface, mouse: Mouse) void {
// Create our dockspace first. If we had to setup our dockspace,
// then it is a first render.
const dockspace_id = cimgui.c.ImGui_GetID("Main Dockspace");
@@ -48,6 +53,21 @@ pub const Inspector = struct {
defer cimgui.c.ImGui_End();
self.terminal_info.draw(open, t);
}
// Surface info window
{
const open = cimgui.c.ImGui_Begin(
window_surface,
null,
cimgui.c.ImGuiWindowFlags_NoFocusOnAppearing,
);
defer cimgui.c.ImGui_End();
self.surface_info.draw(
open,
surface,
mouse,
);
}
}
if (first_render) {
@@ -86,6 +106,7 @@ pub const Inspector = struct {
// layout.
const dock_id_main: cimgui.c.ImGuiID = dockspace_id;
cimgui.ImGui_DockBuilderDockWindow(window_terminal, dock_id_main);
cimgui.ImGui_DockBuilderDockWindow(window_surface, dock_id_main);
cimgui.ImGui_DockBuilderDockWindow(window_imgui_demo, dock_id_main);
cimgui.ImGui_DockBuilderFinish(dockspace_id);
}
@@ -100,3 +121,311 @@ pub const Inspector = struct {
return setup;
}
};
pub const Mouse = struct {
/// Last hovered x/y
last_xpos: f64 = 0,
last_ypos: f64 = 0,
// Last hovered screen point
last_point: ?terminal.Pin = null,
};
/// Surface information inspector widget.
pub const Info = struct {
pub const empty: Info = .{};
/// Draw the surface info window.
pub fn draw(
self: *Info,
open: bool,
surface: *const Surface,
mouse: Mouse,
) void {
_ = self;
if (!open) return;
if (cimgui.c.ImGui_CollapsingHeader(
"Help",
cimgui.c.ImGuiTreeNodeFlags_None,
)) {
cimgui.c.ImGui_TextWrapped(
"This window displays information about the surface (window). " ++
"A surface is the graphical area that displays the terminal " ++
"content. It includes dimensions, font sizing, and mouse state " ++
"information specific to this window instance.",
);
}
cimgui.c.ImGui_SeparatorText("Dimensions");
dimensionsTable(surface);
cimgui.c.ImGui_SeparatorText("Font");
fontTable(surface);
cimgui.c.ImGui_SeparatorText("Mouse");
mouseTable(surface, mouse);
}
};
fn dimensionsTable(surface: *const Surface) void {
_ = cimgui.c.ImGui_BeginTable(
"table_size",
2,
cimgui.c.ImGuiTableFlags_None,
);
defer cimgui.c.ImGui_EndTable();
// Screen Size
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Screen Size");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"%dpx x %dpx",
surface.size.screen.width,
surface.size.screen.height,
);
}
}
// Grid Size
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Grid Size");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
const grid_size = surface.size.grid();
cimgui.c.ImGui_Text(
"%dc x %dr",
grid_size.columns,
grid_size.rows,
);
}
}
// Cell Size
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Cell Size");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"%dpx x %dpx",
surface.size.cell.width,
surface.size.cell.height,
);
}
}
// Padding
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Window Padding");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"T=%d B=%d L=%d R=%d px",
surface.size.padding.top,
surface.size.padding.bottom,
surface.size.padding.left,
surface.size.padding.right,
);
}
}
}
fn fontTable(surface: *const Surface) void {
_ = cimgui.c.ImGui_BeginTable(
"table_font",
2,
cimgui.c.ImGuiTableFlags_None,
);
defer cimgui.c.ImGui_EndTable();
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Size (Points)");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"%.2f pt",
surface.font_size.points,
);
}
}
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Size (Pixels)");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"%.2f px",
surface.font_size.pixels(),
);
}
}
}
fn mouseTable(
surface: *const Surface,
mouse: Mouse,
) void {
_ = cimgui.c.ImGui_BeginTable(
"table_mouse",
2,
cimgui.c.ImGuiTableFlags_None,
);
defer cimgui.c.ImGui_EndTable();
const surface_mouse = &surface.mouse;
const t = surface.renderer_state.terminal;
{
const hover_point: terminal.point.Coordinate = pt: {
const p = mouse.last_point orelse break :pt .{};
const pt = t.screens.active.pages.pointFromPin(
.active,
p,
) orelse break :pt .{};
break :pt pt.coord();
};
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Hover Grid");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"row=%d, col=%d",
hover_point.y,
hover_point.x,
);
}
}
{
const coord: renderer.Coordinate.Terminal = (renderer.Coordinate{
.surface = .{
.x = mouse.last_xpos,
.y = mouse.last_ypos,
},
}).convert(.terminal, surface.size).terminal;
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Hover Point");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"(%dpx, %dpx)",
@as(i64, @intFromFloat(coord.x)),
@as(i64, @intFromFloat(coord.y)),
);
}
}
const any_click = for (surface_mouse.click_state) |state| {
if (state == .press) break true;
} else false;
click: {
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Click State");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
if (!any_click) {
cimgui.c.ImGui_Text("none");
break :click;
}
for (surface_mouse.click_state, 0..) |state, i| {
if (state != .press) continue;
const button: input.MouseButton = @enumFromInt(i);
cimgui.c.ImGui_SameLine();
cimgui.c.ImGui_Text("%s", (switch (button) {
.unknown => "?",
.left => "L",
.middle => "M",
.right => "R",
.four => "{4}",
.five => "{5}",
.six => "{6}",
.seven => "{7}",
.eight => "{8}",
.nine => "{9}",
.ten => "{10}",
.eleven => "{11}",
}).ptr);
}
}
}
{
const left_click_point: terminal.point.Coordinate = pt: {
const p = surface_mouse.left_click_pin orelse break :pt .{};
const pt = t.screens.active.pages.pointFromPin(
.active,
p.*,
) orelse break :pt .{};
break :pt pt.coord();
};
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Click Grid");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"row=%d, col=%d",
left_click_point.y,
left_click_point.x,
);
}
}
{
cimgui.c.ImGui_TableNextRow();
{
_ = cimgui.c.ImGui_TableSetColumnIndex(0);
cimgui.c.ImGui_Text("Click Point");
}
{
_ = cimgui.c.ImGui_TableSetColumnIndex(1);
cimgui.c.ImGui_Text(
"(%dpx, %dpx)",
@as(u32, @intFromFloat(surface_mouse.left_click_xpos)),
@as(u32, @intFromFloat(surface_mouse.left_click_ypos)),
);
}
}
}