summaryrefslogtreecommitdiff
path: root/src/config.zig
diff options
context:
space:
mode:
Diffstat (limited to 'src/config.zig')
-rw-r--r--src/config.zig1732
1 files changed, 1421 insertions, 311 deletions
diff --git a/src/config.zig b/src/config.zig
index da23f51f..988f634d 100644
--- a/src/config.zig
+++ b/src/config.zig
@@ -1,6 +1,7 @@
const std = @import("std");
const builtin = @import("builtin");
const layout = @import("layout.zig");
+const animation = @import("animation.zig");
const limits = @import("memory.zig").limits;
const pardes = @import("pardes.zig");
const builtins = @import("builtins.zig");
@@ -16,18 +17,43 @@ pub const Chord = struct {
shift: bool = false,
};
-// Leader paths apply in body normal mode, not tags or raw terminals.
+// Leader paths apply wherever normal mode reads keys: a body's, a tag's
+// (column and workspace tags too) and a PDF's, never a raw terminal's
+// (normal.zig takes `.leader` for every target).
pub const leader: []const Chord = &.{.{ .cp = ' ' }};
pub const leader_help: u8 = '?';
const undecided: []const u8 = "<undecided>";
+/// Leader paths that run a builtin WITH an argument (the pick prototype's):
+/// the query pane's sources that have no word of their own, `Search` and
+/// line 1. `SPC s` is the session group (Dump, Restore, Attach), so the
+/// declarations are `SPC s s`, a key from helix's.
+pub const leader_args = [_]struct { path: []const u8, cmd: Builtin, arg: []const u8 }{
+ .{ .path = "bb", .cmd = .Search, .arg = "Panes" },
+ .{ .path = "ss", .cmd = .Search, .arg = "Symbols" },
+ .{ .path = "/", .cmd = .Search, .arg = "All" },
+};
+
+comptime {
+ @setEvalBranchQuota(20_000);
+ // A path here is a leaf: no builtin's path is it or runs past it, and
+ // none of it is a builtin's whole path.
+ for (leader_args) |la| for (std.enums.values(Builtin)) |b| if (leader_path.get(b)) |path| {
+ if (std.mem.startsWith(u8, path, la.path) or std.mem.startsWith(u8, la.path, path))
+ @compileError("leader_args path collides with " ++ @tagName(b) ++ ": " ++ la.path);
+ };
+}
+
// null means word/chord-only. Every enabled builtin must explicitly choose a path.
pub const leader_path = paths: {
+ @setEvalBranchQuota(10_000); // a check per builtin, and they grow
var table = std.EnumArray(Builtin, ?[]const u8).initDefault(@as(?[]const u8, undecided), .{
.Help = &[_]u8{leader_help},
.Hover = "lk",
+ .Def = null, // gd
+ .Refs = null, // gr
.Rename = "lr",
.CodeAction = "la",
.SelectRefs = "lh",
@@ -37,16 +63,36 @@ pub const leader_path = paths: {
.WsDiagnostics = "lD",
.Lspinfo = "li",
.Lspwhy = "lw",
+ .Callstack = "lb",
.Callers = "lc",
.Callees = "lC",
.Supertypes = "lt",
.Subtypes = "lT",
+ .LookNext = "jn",
+ .LookPrev = "jp",
.Del = "d",
+ .DelAbove = null,
+ .DelBelow = null,
.Filter = null,
+ .Diff = null,
.Mode = null,
.Togglettymode = null,
.Collapse = null,
+ .Unattach = null,
+ .Undo = null,
+ .Edit = null,
+ .Redo = null,
+ .Repl = null,
.Kill = null,
+ .Exit = "q",
+ .Get = null,
+ .Putall = null,
+ .Incl = null,
+ .Tab = null,
+ .CallstackDepth = null,
+ .CallstackLayout = null,
+ .CallstackCorners = null,
+ .Zerox = null,
.ClipYank = "y",
.ClipYankMain = "Y",
.ClipPaste = "p",
@@ -56,8 +102,10 @@ pub const leader_path = paths: {
.New = "fn",
.Tty = "nt",
.Find = "ff",
+ .Recent = "fr",
.Grep = "fg",
.Config = "fc",
+ .DumpConfig = null,
.LocationsConfig = null,
.Tutor = "ht",
.Changelog = "hc",
@@ -65,17 +113,32 @@ pub const leader_path = paths: {
.Newcol = "cn",
.Delcol = "cd",
.Joincol = "cj",
+ .Placement = "cp",
+ .SearchPlace = null,
+ .SearchPane = null,
+ .SearchRows = null,
+ .Search = null,
+ .Panes = null,
+ .More = null,
+ .BootShell = null,
+ .LookWord = null,
+ .DirLook = null,
+ .DiffLook = null,
+ .Pager = null,
+ .PagerColor = null,
+ .TermImages = null,
+ .JumpScope = null,
.Debug = "td",
.Msg = null,
.Colors = "tc",
.FocusTint = null,
- .ColumnTags = null,
.SyntaxBold = null,
+ .Verbose = null,
.TreeContextTagStyle = null,
.Wrap = "tw",
.Tagbottom = "tb",
.NextColor = "tn",
- .ThemeSel = "tt",
+ .Themes = "tt",
.Theme = null,
.Shell = null,
.Petscii = "tp",
@@ -83,10 +146,11 @@ pub const leader_path = paths: {
.Ascii = "ta",
.Dump = "sd",
.Restore = "sr",
- .Left = "wh",
- .Down = "wj",
- .Up = "wk",
- .Right = "wl",
+ .Left = null,
+ .Down = null,
+ .Up = null,
+ .Right = null,
+ .Window = "w",
.Back = "jo",
.Forward = "ji",
.Last = "jj",
@@ -96,13 +160,32 @@ pub const leader_path = paths: {
.Exec = null,
});
if (builtins.capabilities.font_picker) {
- table.set(.FontSel, "tf");
+ table.set(.Fonts, "tf");
table.set(.Font, null);
table.set(.TaglineSize, null);
}
if (pardes.platform == .gui) table.set(.Pet, null);
+ table.set(.MessageAnimation, null);
+ table.set(.MessageLinger, null);
+ table.set(.MessageFall, null);
+ table.set(.MessageDissolve, null);
+ table.set(.DumpDir, null);
if (builtins.capabilities.window_opacity) table.set(.WindowOpacity, null);
if (builtins.capabilities.window_blur) table.set(.WindowBlur, null);
+ if (builtins.capabilities.ligatures) table.set(.Ligatures, null);
+ if (builtins.capabilities.lift) table.set(.CursorBlink, null);
+ if (builtins.capabilities.lift) table.set(.SelectionGlow, null);
+ if (builtins.capabilities.lift) table.set(.HoverGlow, null);
+ if (builtins.capabilities.lift) table.set(.Occlusion, null);
+ if (builtins.capabilities.lift) table.set(.Parallax, null);
+ table.set(.JumpTrail, null);
+ table.set(.ChipShadow, null);
+ table.set(.ThumbFlash, null);
+ table.set(.ProgramEsc, null);
+ if (builtins.capabilities.lift) table.set(.Lift, null);
+ table.set(.Motion, null);
+ table.set(.InactiveDim, null);
+ if (builtins.capabilities.lift) table.set(.GripWidth, null);
if (builtins.capabilities.panel_transitions) {
table.set(.PanelSlide, "as");
table.set(.PanelZoom, "az");
@@ -118,8 +201,11 @@ pub const leader_path = paths: {
}
if (builtins.capabilities.scene_shaders) {
table.set(.Crt, "tr");
- table.set(.Ripple, "tR");
- table.set(.Glitch, "tg");
+ table.set(.Bloom, null);
+ table.set(.Vignette, null);
+ table.set(.Grain, null);
+ table.set(.Shader, null);
+ table.set(.ShaderAnimation, null);
}
if (builtins.EffectCode.enabled) table.set(.EffectCode, null);
if (builtins.TreeContext.enabled) table.set(.TreeContext, null);
@@ -151,9 +237,10 @@ pub const leader_path = paths: {
break :paths table;
};
-test "Space-k is unbound while Kill and other k chords remain available" {
+test "Space-k is unbound while Exit, Kill and other k chords remain available" {
try std.testing.expect(leader_path.get(.Kill) == null);
- try std.testing.expectEqualStrings("wk", leader_path.get(.Up).?);
+ try std.testing.expectEqualStrings("q", leader_path.get(.Exit).?);
+ try std.testing.expectEqualStrings("w", leader_path.get(.Window).?);
try std.testing.expectEqualStrings("lk", leader_path.get(.Hover).?);
try std.testing.expectEqualStrings("d", leader_path.get(.Del).?);
for (pardes.builtin_rows) |row| if (row.cmd == .Kill) {
@@ -164,17 +251,35 @@ test "Space-k is unbound while Kill and other k chords remain available" {
const p = try pardes.Pardes.init(std.testing.allocator, .{ .tty_only = true });
defer p.deinit();
const pane = try p.setTestFile("first\nsecond\n");
- pane.cur_row = 1;
+ pane.body.cur_row = 1;
while (p.nextEffect()) |_| {}
p.update(.{ .key = .{ .cp = ' ' } });
try std.testing.expect(p.leader_on);
p.update(.{ .key = .{ .cp = 'k' } });
try std.testing.expect(!p.leader_on and !p.quit);
- try std.testing.expectEqual(@as(i32, 1), pane.cur_row);
+ try std.testing.expectEqual(@as(i32, 1), pane.body.cur_row);
while (p.nextEffect()) |effect| try std.testing.expect(effect != .quit);
p.update(.{ .key = .{ .cp = 'k' } });
- try std.testing.expectEqual(@as(i32, 0), pane.cur_row);
+ try std.testing.expectEqual(@as(i32, 0), pane.body.cur_row);
+ // Kill stops commands and never quits; Exit quits.
try std.testing.expect(p.executeBuiltinLine(p.active, "Kill"));
+ try std.testing.expect(!p.quit);
+ try std.testing.expect(p.executeBuiltinLine(p.active, "Exit"));
+ try std.testing.expect(p.quit);
+}
+
+test "SPC q runs Exit: refused once over unsaved text, as the tag word is, then it quits" {
+ const p = try pardes.Pardes.init(std.testing.allocator, .{ .tty_only = true });
+ defer p.deinit();
+ const pane = try p.setTestFile("text\n");
+ pane.file.?.saved_revision = pane.file.?.revision -% 1; // modified
+ pane.file.?.saved_hash = 0; // edited: what it had is not what it has
+ while (p.nextEffect()) |_| {}
+ p.update(.{ .key = .{ .cp = ' ' } });
+ p.update(.{ .key = .{ .cp = 'q' } });
+ try std.testing.expect(!p.quit);
+ p.update(.{ .key = .{ .cp = ' ' } });
+ p.update(.{ .key = .{ .cp = 'q' } });
try std.testing.expect(p.quit);
}
@@ -187,7 +292,8 @@ pub const select_button: Mouse.Button = .left;
pub const look_cmd: Builtin = .Look;
pub const exec_cmd: Builtin = .Exec;
-// Ctrl-w remains available when a terminal owns printable keys.
+// Ctrl-w: window mode (layout.windowKey), as SPC w; on a header it
+// prefixes h/j/k/l, a move between the headers.
pub const window_prefix: []const Chord = &.{.{ .cp = 'w', .ctrl = true }};
pub const window_keys = [_]struct { letter: Chord, arrow: Chord, cmd: Builtin }{
@@ -197,6 +303,11 @@ pub const window_keys = [_]struct { letter: Chord, arrow: Chord, cmd: Builtin }{
.{ .letter = .{ .cp = 'l' }, .arrow = .{ .cp = Key.right }, .cmd = .Right },
};
+// In window mode `d` is Del on the outlined pane, its k/j question and all,
+// the outline going with the rows; `c` is Collapse. Neither is a label.
+pub const window_delete: []const Chord = &.{.{ .cp = 'd' }};
+pub const window_collapse: []const Chord = &.{.{ .cp = 'c' }};
+
pub const new_shell_below: []const Chord = &.{.{ .cp = 'n', .alt = true }};
pub const pane_to_new_column: []const Chord = &.{.{ .cp = 'c', .alt = true }};
@@ -206,18 +317,13 @@ pub const jump_keys = [_]struct { chord: Chord, cmd: Builtin }{
.{ .chord = .{ .cp = 'i', .ctrl = true }, .cmd = .Forward },
};
-pub const topbar_down: []const Chord = &.{ .{ .cp = 'J' }, .{ .cp = Key.down } };
-pub const topbar_up: []const Chord = &.{ .{ .cp = 'K' }, .{ .cp = Key.up } };
-pub const topbar_left: []const Chord = &.{.{ .cp = 'h' }};
-pub const topbar_right: []const Chord = &.{.{ .cp = 'l' }};
-
-pub const leave_pane: []const Chord = &.{.{ .cp = Key.escape, .shift = true }};
+/// Shift-Esc: the Esc nothing swallows. In every mode and pane it does what
+/// Esc does from normal mode, back to the previous pane (Last); in a raw
+/// terminal plain Esc does it and Shift-Esc is the program's Esc, unless
+/// ProgramEsc is on. Ctrl-b alone toggles raw.
+pub const back_out: []const Chord = &.{.{ .cp = Key.escape, .shift = true }};
pub const tty_toggle_default: u21 = 'b';
-pub const tty_toggle_alt: []const Chord = &.{.{ .cp = Key.escape, .shift = true }};
-
-// OSC 133 prompt cells are hidden in normal mode; input columns stay intact.
-pub const tty_blank: enum { prompt, prompt_and_input } = .prompt;
// Projected colors below this contrast use the theme's more legible anchor.
pub const tty_filter_min_contrast: f64 = 1.5;
@@ -233,12 +339,25 @@ pub const child_term = "xterm-256color";
pub const child_colorterm = "truecolor";
pub const child_term_program = "pardes";
-pub const topbar_str = "Newcol Joincol Find Grep Help Changelog Tutor Dump NextColor Debug Kill";
+pub const topbar_str = "Newcol Joincol Find Grep Help Changelog Tutor Dump Themes Config Debug Exit";
-pub const pane_builtins_str = "Tty Del Collapse";
-pub const pdf_pane_builtins_str = "Tty Del PdfSections PdfTint Collapse";
-pub const file_pane_builtins_str = "Save Tty Del Collapse";
-pub const terminal_pane_builtins_str = "Tty Save Del Mode Filter Collapse";
+pub const pane_builtins_str = "Tty Collapse Del";
+pub const pdf_pane_builtins_str = "Tty PdfSections PdfTint PdfFit Collapse Del";
+pub const file_pane_builtins_str = "Save Tty Collapse Del";
+/// After a file's, on one a language server speaks for.
+pub const lsp_pane_builtins_str = "Def Refs";
+/// A diff's (a .diff, a .patch, a +Pager holding one): Diff.
+pub const diff_pane_builtins_str = "Save Tty Diff Collapse Del";
+/// A +Pager's (`pardes -`): Filter, as a terminal's.
+pub const pager_pane_builtins_str = "Save Tty Filter Collapse Del";
+/// A +Pager holding a diff (`git show`): Diff too.
+pub const pager_diff_pane_builtins_str = "Save Tty Filter Diff Collapse Del";
+/// A +Diff's: Diff again, the diff it stacks as text.
+pub const diff_view_builtins_str = "Save Tty Diff Collapse Del";
+pub const terminal_pane_builtins_str = "Tty Save Mode Filter Collapse Del";
+pub const command_pane_builtins_str = "Kill Save Collapse Del";
+/// A directory pane's (Dir.zig): Get reads it again, as acme's does.
+pub const dir_pane_builtins_str = "Get Tty Collapse Del";
// Each mode badge is one codepoint.
pub const tag_normal = " ";
@@ -246,28 +365,53 @@ pub const tag_insert = "^";
pub const tag_tty = "$";
pub const tag_image = "img";
-pub const tag_yank: []const Chord = &.{.{ .cp = 'y' }};
-
pub const command_line: []const Chord = &.{.{ .cp = ':' }};
pub const search: []const Chord = &.{.{ .cp = '/' }};
pub const search_next: []const Chord = &.{.{ .cp = 'n' }};
pub const search_prev: []const Chord = &.{.{ .cp = 'N' }};
+/// Typing on a query pane's line 1 (Query.zig): the next and the previous
+/// hit current, the text following (helix's prompt walks its history with
+/// these; a query has none). Tab stays the exec chord.
+pub const query_next: []const Chord = &.{ .{ .cp = 'n', .ctrl = true }, .{ .cp = Key.down } };
+pub const query_prev: []const Chord = &.{ .{ .cp = 'p', .ctrl = true }, .{ .cp = Key.up } };
+pub const search_selection: []const Chord = &.{.{ .cp = '*', .alt = true }};
+pub const search_selection_word: []const Chord = &.{.{ .cp = '*' }};
pub const pipe_selection: []const Chord = &.{.{ .cp = '|' }};
pub const pipe_selection_to: []const Chord = &.{.{ .cp = '|', .alt = true }};
pub const insert_output: []const Chord = &.{.{ .cp = '!' }};
pub const append_output: []const Chord = &.{.{ .cp = '!', .alt = true }};
+pub const keep_pipe: []const Chord = &.{.{ .cp = '$' }};
+pub const macro_record: []const Chord = &.{.{ .cp = 'Q' }};
+pub const macro_replay: []const Chord = &.{.{ .cp = 'q' }};
+pub const repeat_insert: []const Chord = &.{.{ .cp = '.' }};
// Armed inputs are parsed from their distinct, nonempty tag markers.
pub const pipe_marker_to = " |-";
pub const pipe_marker_insert = " !";
pub const pipe_marker_append = " !+";
+pub const pipe_marker_keep = " $";
pub const search_submit: []const Chord = &.{.{ .cp = Key.enter }};
+// Del from the keyboard on a pane with open panes both above and below it
+// asks which of them takes its rows. One key answers; any other keeps the pane.
+pub const del_question = "Del: give space to k above j below";
+// The question waits this long before it shows: SPC d j typed at speed
+// never sees it, and a hand that pauses after SPC d (it pressed Del and
+// nothing closed) gets it as a hint. Typed in one go the answer lands
+// 100-250 ms after the d; a hesitation is longer than that.
+pub const del_question_delay_ns: u64 = 400 * std.time.ns_per_ms;
+pub const del_above: []const Chord = &.{ .{ .cp = 'k' }, .{ .cp = Key.up } };
+pub const del_below: []const Chord = &.{ .{ .cp = 'j' }, .{ .cp = Key.down } };
+
pub const wheel_rows: i32 = 1;
pub const wheel_cols: i32 = 4;
pub const look_preview_delay_frames: ?u16 = 2;
+/// The longest any message timing (MessageLinger, MessageFall,
+/// MessageDissolve) may be set to, in milliseconds.
+pub const message_ms_max: u16 = 60_000;
+
// Tag fonts keep body-cell geometry; valid sizes are 1...100 percent.
pub const gui_tagline_font_percent: u8 = 82;
comptime {
@@ -281,9 +425,6 @@ pub const gui_topbar_pane_border_px: u8 = 1;
// null follows the theme's scrollbar track.
pub const gui_topbar_pane_border_rgb: ?[3]u8 = null;
-// Transparency requires the SDL readback/blit path, even with an opaque theme.
-pub const gui_transparent: bool = false;
-
// A vertical wheel tick suppresses this many subsequent horizontal ticks.
pub const wheel_guard_ticks: u8 = 3;
@@ -311,11 +452,28 @@ test "wheel drift guard" {
try std.testing.expect(wheelTick(&g, false));
}
-pub const default_shell = "fish";
+/// The shell when no `Shell` is set: the user's login shell ($SHELL), as a
+/// terminal would start, else /bin/sh. An explicit `Shell` overrides it.
+pub fn defaultShell() []const u8 {
+ if (comptime pardes.hosted) if (std.c.getenv("SHELL")) |s| {
+ const shell = std.mem.span(s);
+ // One that is not there, or not executable, is no shell: /bin/sh.
+ if (shell.len > 0 and std.c.access(s, std.c.X_OK) == 0) return shell;
+ };
+ return "/bin/sh";
+}
// Minimum file gutter width, including the space after the line number.
pub const PREFIX_W: u16 = 5;
+/// acme's Incl's C defaults: where a look at `stdio.h` finds it.
+pub const default_incl = [_][]const u8{ "/usr/include", "/usr/local/include" };
+
pub const tab_width: u16 = 4;
+/// The width a tab is drawn and counted at now: `Tab N` (Runtime.tab) sets
+/// it, a new session starts it at tab_width. ponytail: one for the process,
+/// as the session's setting is one; per pane would mean handing a pane to
+/// every width function (File.graphemeDisplayWidth and its ~130 callers).
+pub var tab_now: u16 = tab_width;
comptime {
if (tab_width == 0) @compileError("config.tab_width must be greater than zero");
}
@@ -383,23 +541,27 @@ pub const comment_tokens: []const struct { exts: []const []const u8, token: []co
};
pub const search_marker = " /";
-pub const find_marker = " Find /";
-pub const grep_marker = " Grep /";
pub const rename_marker = " Rename /";
pub const symbol_marker = " WsSymbols /";
pub const save_marker = " Save ";
pub const select_marker = " Select /";
pub const split_marker = " Split /";
+pub const keep_marker = " Keep /";
+pub const remove_marker = " Remove /";
pub const pipe_marker = " |";
pub const search_buffer = "+Search";
pub const help_buffer = "+Help";
-pub const config_buffer = "+Config";
+pub const dump_config_buffer = "+DumpConfig";
pub const effect_code_buffer = "+EffectCode";
pub const jumps_buffer = "+Jumps";
+pub const recent_buffer = "+Recent";
+pub const preview_buffer = "+Preview";
+pub const unsaved_buffer = "+Unsaved";
pub const themes_buffer = "+Themes";
pub const fonts_buffer = "+Fonts";
pub const pdf_sections_buffer = "+PdfSections";
+pub const diff_buffer = "+Diff";
pub const pdf_links_buffer = "+Links";
pub const hover_buffer = "+Hover";
pub const lsp_buffer = "+Lsp";
@@ -414,6 +576,7 @@ pub const errors_buffer = "+Errors";
// Modal bindings below are checked against Helix by hxdiff and hxparity.
pub const goto_prefix = 'g';
pub const view_prefix = 'z';
+pub const view_prefix_sticky = 'Z';
pub const match_prefix = 'm';
pub const replace_prefix = 'r';
pub const next_prefix = ']';
@@ -435,12 +598,10 @@ pub const next_long_word_start: []const Chord = &.{.{ .cp = 'W' }};
pub const prev_long_word_start: []const Chord = &.{.{ .cp = 'B' }};
pub const next_long_word_end: []const Chord = &.{.{ .cp = 'E' }};
pub const line_start: []const Chord = &.{ .{ .cp = '0' }, .{ .cp = Key.home } };
-pub const line_end: []const Chord = &.{ .{ .cp = '$' }, .{ .cp = Key.end } };
+pub const line_end: []const Chord = &.{.{ .cp = Key.end }};
pub const line_first_nonws: []const Chord = &.{.{ .cp = '^' }};
// Bare G does nothing; ge reaches the last line.
pub const goto_line: []const Chord = &.{.{ .cp = 'G' }};
-pub const line_move_left: []const Chord = move_left;
-pub const line_move_right: []const Chord = move_right;
pub const half_page_down: []const Chord = &.{.{ .cp = 'd', .ctrl = true }};
pub const half_page_up: []const Chord = &.{.{ .cp = 'u', .ctrl = true }};
@@ -449,6 +610,7 @@ pub const page_up: []const Chord = &.{ .{ .cp = 'b', .ctrl = true }, .{ .cp = Ke
pub const view_top: []const Chord = &.{.{ .cp = 't' }};
pub const view_center: []const Chord = &.{ .{ .cp = 'z' }, .{ .cp = 'c' } };
pub const view_bottom: []const Chord = &.{.{ .cp = 'b' }};
+pub const view_middle: []const Chord = &.{.{ .cp = 'm' }};
pub const view_scroll_down: []const Chord = &.{ .{ .cp = 'j' }, .{ .cp = Key.down } };
pub const view_scroll_up: []const Chord = &.{ .{ .cp = 'k' }, .{ .cp = Key.up } };
@@ -461,13 +623,19 @@ pub const goto_line_down: []const Chord = &.{.{ .cp = 'j' }};
pub const goto_line_up: []const Chord = &.{.{ .cp = 'k' }};
pub const goto_column: []const Chord = &.{.{ .cp = '|' }};
pub const goto_view_top: []const Chord = &.{.{ .cp = 't' }};
-pub const goto_view_center: []const Chord = &.{.{ .cp = 'c' }};
+// gc opens Callstack; it no longer moves the cursor to the viewport center.
+pub const goto_view_center: []const Chord = &.{};
pub const goto_view_bottom: []const Chord = &.{.{ .cp = 'b' }};
+pub const goto_last_modification: []const Chord = &.{.{ .cp = '.' }};
+pub const goto_word: []const Chord = &.{.{ .cp = 'w' }};
+/// the jump labels' letters, helix's jump_label_alphabet
+pub const jump_label_alphabet = "abcdefghijklmnopqrstuvwxyz";
pub const goto_definition: []const Chord = &.{.{ .cp = 'd' }};
pub const goto_declaration: []const Chord = &.{.{ .cp = 'D' }};
pub const goto_type_definition: []const Chord = &.{.{ .cp = 'y' }};
pub const goto_implementation: []const Chord = &.{.{ .cp = 'i' }};
pub const goto_references: []const Chord = &.{.{ .cp = 'r' }};
+pub const goto_callstack: []const Chord = &.{.{ .cp = 'c' }};
pub const match_bracket: []const Chord = &.{.{ .cp = 'm' }};
pub const match_inside = 'i';
@@ -475,11 +643,19 @@ pub const match_around = 'a';
pub const surround_add = 's';
pub const surround_replace = 'r';
pub const surround_delete = 'd';
+pub const register_prefix = '"';
pub const goto_paragraph: []const Chord = &.{.{ .cp = 'p' }};
pub const add_newline: []const Chord = &.{.{ .cp = ' ' }};
pub const goto_diagnostic: []const Chord = &.{.{ .cp = 'd' }};
pub const goto_diagnostic_end: []const Chord = &.{.{ .cp = 'D' }};
+pub const goto_function: []const Chord = &.{.{ .cp = 'f' }};
+pub const goto_class: []const Chord = &.{.{ .cp = 't' }};
+pub const goto_parameter: []const Chord = &.{.{ .cp = 'a' }};
+pub const goto_comment: []const Chord = &.{.{ .cp = 'c' }};
+pub const goto_test: []const Chord = &.{.{ .cp = 'T' }};
+pub const goto_entry: []const Chord = &.{.{ .cp = 'e' }};
+pub const goto_xml_element: []const Chord = &.{.{ .cp = 'x' }};
pub const insert: []const Chord = &.{.{ .cp = 'i' }};
pub const append: []const Chord = &.{.{ .cp = 'a' }};
@@ -509,6 +685,19 @@ pub const trim_sels: []const Chord = &.{.{ .cp = '_' }};
pub const select_regex: []const Chord = &.{.{ .cp = 's' }};
pub const split_regex: []const Chord = &.{.{ .cp = 'S' }};
+pub const keep_regex: []const Chord = &.{.{ .cp = 'K' }};
+pub const remove_regex: []const Chord = &.{.{ .cp = 'K', .alt = true }};
+pub const ensure_forward: []const Chord = &.{.{ .cp = ':', .alt = true }};
+// helix's tree-sitter selection; Alt-n stays the new terminal, so the next
+// sibling is Alt-right alone
+pub const expand_node: []const Chord = &.{ .{ .cp = 'o', .alt = true }, .{ .cp = Key.up, .alt = true } };
+pub const shrink_node: []const Chord = &.{ .{ .cp = 'i', .alt = true }, .{ .cp = Key.down, .alt = true } };
+pub const prev_sibling: []const Chord = &.{ .{ .cp = 'p', .alt = true }, .{ .cp = Key.left, .alt = true } };
+pub const next_sibling: []const Chord = &.{.{ .cp = Key.right, .alt = true }};
+pub const all_siblings: []const Chord = &.{.{ .cp = 'a', .alt = true }};
+pub const all_children: []const Chord = &.{.{ .cp = 'I', .alt = true }};
+pub const parent_node_end: []const Chord = &.{.{ .cp = 'e', .alt = true }};
+pub const parent_node_start: []const Chord = &.{.{ .cp = 'b', .alt = true }};
pub const delete: []const Chord = &.{.{ .cp = 'd' }};
pub const delete_noyank: []const Chord = &.{.{ .cp = 'd', .alt = true }};
@@ -521,13 +710,19 @@ pub const switch_case: []const Chord = &.{.{ .cp = '~' }};
pub const to_lowercase: []const Chord = &.{.{ .cp = '`' }};
pub const to_uppercase: []const Chord = &.{.{ .cp = '`', .alt = true }};
pub const join_lines: []const Chord = &.{.{ .cp = 'J' }};
+pub const join_select_space: []const Chord = &.{.{ .cp = 'J', .alt = true }};
+pub const rotate_contents_fwd: []const Chord = &.{.{ .cp = ')', .alt = true }};
+pub const rotate_contents_back: []const Chord = &.{.{ .cp = '(', .alt = true }};
+pub const align_selections: []const Chord = &.{.{ .cp = '&' }};
pub const indent: []const Chord = &.{.{ .cp = '>' }};
pub const unindent: []const Chord = &.{.{ .cp = '<' }};
pub const format: []const Chord = &.{.{ .cp = '=' }};
pub const increment: []const Chord = &.{.{ .cp = 'a', .ctrl = true }};
pub const decrement: []const Chord = &.{.{ .cp = 'x', .ctrl = true }};
-pub const undo: []const Chord = &.{.{ .cp = 'u' }};
-pub const redo: []const Chord = &.{.{ .cp = 'U' }};
+// pardes's history is linear, so helix's earlier/later (Alt-u, Alt-U) are
+// undo and redo themselves
+pub const undo: []const Chord = &.{ .{ .cp = 'u' }, .{ .cp = 'u', .alt = true } };
+pub const redo: []const Chord = &.{ .{ .cp = 'U' }, .{ .cp = 'U', .alt = true } };
pub const comment_toggle: []const Chord = &.{.{ .cp = 'c', .ctrl = true }};
// Body-normal Esc runs Last; other modes cancel input or leave insert mode.
@@ -536,6 +731,8 @@ pub const escape: []const Chord = &.{.{ .cp = Key.escape }};
pub const insert_backspace_alias: []const Chord = &.{.{ .cp = 'h', .ctrl = true }};
pub const insert_enter_alias: []const Chord = &.{.{ .cp = 'j', .ctrl = true }};
pub const insert_delete_alias: []const Chord = &.{.{ .cp = 'd', .ctrl = true }};
+pub const insert_register: []const Chord = &.{.{ .cp = 'r', .ctrl = true }};
+pub const insert_checkpoint: []const Chord = &.{.{ .cp = 's', .ctrl = true }};
pub const delete_word_backward: []const Chord = &.{ .{ .cp = 'w', .ctrl = true }, .{ .cp = Key.backspace, .alt = true } };
pub const delete_word_forward: []const Chord = &.{ .{ .cp = 'd', .alt = true }, .{ .cp = Key.delete, .alt = true } };
pub const kill_to_line_start: []const Chord = &.{.{ .cp = 'u', .ctrl = true }};
@@ -553,8 +750,73 @@ pub const Runtime = struct {
/// menu bar) turn it off and carry its commands there instead; the core
/// keeps the row as the acme tradition everywhere else.
workspace_tag: bool = true,
- column_tags: bool = true,
syntax_bold: bool = false,
+ /// A font's programming ligatures (`->`, `!=`) draw across their cells.
+ /// Only a shell that shapes text has the setting (`Capabilities.ligatures`).
+ ligatures: bool = true,
+ /// How the focused pane and the notices stand off the page (G1,
+ /// docs/render-pipeline.md §9.1), or off. Opt-in until the focus lift's
+ /// default is decided. Only a pixel shell draws it (`Capabilities.lift`).
+ lift: LiftStyle = .off,
+ /// Blends the unfocused panes' text toward each cell's own ground,
+ /// percent (0 off): the focused pane wins by comparison, its tag tint
+ /// untouched. Kept above min(each cell's contrast, 4.5).
+ inactive_dim: u8 = 0,
+ /// The grip's button and the scrollbar under it, one width, as a percent
+ /// of the theme's `rail_px` (acme's 12px Scrollwid at a 17px tagline):
+ /// a pixel shell's (docs/typ/themes.typ).
+ grip_width: u16 = 150,
+ /// How the fx track's animations move (animation.Motion): off for
+ /// reduced motion.
+ /// Smooth by default, tuned so arrivals land inside §8.1's 220 ms; the
+ /// slower flavours are a choice.
+ motion: animation.Motion.Flavour = .smooth,
+
+ /// Builtins announce themselves on the message row.
+ verbose: bool = true,
+ /// A message falls into its row and dissolves out of it.
+ message_animation: bool = true,
+ /// The cursor blinks, a pixel shell's (docs/render-pipeline.md §5.4):
+ /// solid while typing and for half a second after, eased at each edge,
+ /// solid again after ten idle seconds.
+ cursor_blink: bool = true,
+ /// G9: a soft halo round the selection in the body, fading in over
+ /// 100 ms, a pixel shell's (docs/effects.md).
+ selection_glow: bool = false,
+ /// G11: a soft glow under the word a look-hover would open, fading in
+ /// over 80 ms, a pixel shell's.
+ hover_glow: bool = false,
+ /// G12: pane bodies darken faintly toward their edges (ambient
+ /// occlusion, at most 2%), a pixel shell's.
+ occlusion: bool = false,
+ /// G13: a theme's page pattern under the bodies (lapis's dots) moves
+ /// with the text at a quarter of its speed, a pixel shell's.
+ parallax: bool = false,
+ /// G14: text that changes glows for a moment in the theme's accent and
+ /// fades, a pixel shell's.
+ /// T2: in a terminal, a jump of the cursor leaves a short trail that
+ /// fades in 120 ms (a truecolor terminal's; a pixel shell glides).
+ jump_trail: bool = false,
+ /// T1: in a terminal, a notice chip casts a cell's shadow right and
+ /// down (truecolor terminals).
+ chip_shadow: bool = false,
+ /// T7: in a terminal, a pane's scroll thumb brightens as it scrolls and
+ /// fades back (truecolor terminals).
+ thumb_flash: bool = false,
+ /// In a raw terminal, Esc goes to the program and Shift-Esc backs out
+ /// (off, the default: Esc backs out and Shift-Esc is the program's).
+ program_esc: bool = false,
+ /// How long a message stays after the key or click that dismisses it.
+ message_linger_ms: u16 = 800,
+ /// How long its fall into the row takes, easing out (§8.1: arriving,
+ /// 150 to 220 ms).
+ message_fall_ms: u16 = 180,
+ /// How long its dissolve takes, easing in: leaving is quicker than
+ /// arriving (§8.1: 100 to 160 ms).
+ message_dissolve_ms: u16 = 150,
+ /// Where Dump writes and a relative Restore looks; empty is the default
+ /// ($XDG_DATA_HOME/pardes, else ~/.local/share/pardes).
+ dump_dir: Text(limits.host_path_cap) = .{},
window_opacity: u8 = 100,
window_blur: u8 = 0,
window_opacity_pending: bool = true,
@@ -578,10 +840,164 @@ pub const Runtime = struct {
tagline_percent: u8 = 100,
} = .{},
- panel_transition: layout.Transition = .off,
- scene_effects: layout.SceneEffect = .{},
+ panel_transition: animation.Transition = .off,
+ /// The post chain (docs/render-pipeline.md §6), in the order it runs.
+ post: Post = .{},
+ /// When the chain redraws on its own, past the frames it post-processes:
+ /// never, while the window has the focus, or always (ghostty's
+ /// custom-shader-animation).
+ shader_animation: ShaderAnimation = .on,
+ /// Where a new pane goes (exec.placeNew): `acme`, acme's makenewwindow,
+ /// or `pardes`, the rules pardes had before it.
+ placement: Placement = .acme,
+ /// A document dragged into the left column where a lone shell nobody
+ /// has typed into stands: `keep` leaves the shell, `replace` closes it
+ /// (exec.evictLonePristineTty).
+ boot_shell: BootShell = .keep,
+ /// A plain word looked at in a pane: `search`, acme's look3, selects its
+ /// next place in that pane, wrapping; `list`, what pardes did before,
+ /// lists every place in a +Search pane (look.zig, lookWord).
+ look_word: LookWord = .search,
+ /// A directory looked at: `pane`, acme's, a pane listing it (Dir.zig);
+ /// `terminal`, what pardes did before, `ls` in a terminal there.
+ dir_look: DirLook = .pane,
+ /// A .diff or .patch looked at (a look, `pardes FILE`, `--wait`):
+ /// `hunks`, a +Diff stacking its hunks (hunks.zig); `text`, the file
+ /// itself, as pardes showed it before. Diff goes from one to the other.
+ diff_look: DiffLook = .hunks,
+ /// What a terminal's shell pages through (host_io.ChildEnv): `pardes`,
+ /// PAGER and GIT_PAGER set to `pardes -`, a +Pager pane, where the
+ /// user's environment set neither; `off`, the environment as it is.
+ pager: Pager = .pardes,
+ /// A +Pager keeps its program's colours (SGR, as spans over the text,
+ /// pager.zig), or is plain; for the next text paged.
+ pager_color: bool = true,
+ /// How a new terminal pane draws the kitty graphics its program sends
+ /// (yazi's previews): `real`, as pixels where the shell can, or
+ /// `petscii`, as glyph art. The Petscii builtin flips one pane.
+ term_images: TermImages = .real,
+ /// What Back and Forward keep to (Pardes.jumpBy): `file`, the places in
+ /// the focused pane's file first, other files only once those run out
+ /// that way; `all`, every place in the order it was jumped to.
+ jump_scope: JumpScope = .file,
+ /// acme's Tab: a tab's width in cells, in every pane (config.tab_now
+ /// is what the drawing and the column arithmetic read).
+ tab: u16 = tab_width,
+ callstack_layout: CallstackLayout = .stacked,
+ callstack_corners: CallstackCorners = .rounded,
+ callstack_depth: u8 = @import("lsp/lsp.zig").callstack_default_depth,
+ /// Where a query pane goes (Query.zig): `attached`, under the pane that
+ /// asked, out of its rows alone; `column`, in the finder column.
+ search_place: SearchPlace = .attached,
+ /// A search from a pane that has a query pane: `reuse` it (its frozen
+ /// rows back on Esc), or open a `new` one, the last left where it is.
+ search_pane: SearchPane = .reuse,
+ /// The body rows a query pane is born with under its line 1 (and its
+ /// +Preview with): it never resizes itself after.
+ search_rows: u16 = 8,
- pub fn toggleTransition(state: *Runtime, effect: layout.Transition) void {
+ pub const ShaderAnimation = enum { off, on, always };
+ pub const Placement = enum { acme, pardes };
+ pub const BootShell = enum { keep, replace };
+ pub const LookWord = enum { search, list };
+ pub const DirLook = enum { pane, terminal };
+ pub const DiffLook = enum { hunks, text };
+ pub const Pager = enum { pardes, off };
+ pub const TermImages = enum { real, petscii };
+ pub const JumpScope = enum { file, all };
+ pub const CallstackLayout = enum { @"inline", stacked };
+ pub const CallstackCorners = @import("lsp/lsp.zig").CallstackCorners;
+ pub const SearchPlace = enum { attached, column };
+ pub const SearchPane = enum { reuse, new };
+ /// A setting that is one of a few words, each an enum field of Runtime.
+ pub const Choice = enum { placement, boot_shell, look_word, dir_look, diff_look, pager, term_images, jump_scope, callstack_layout, callstack_corners, search_place, search_pane };
+
+ /// shadow: a soft drop shadow. rim: a light hairline along the top of
+ /// the focused pane's tag rows. auto: a shadow on a light page; on a
+ /// dark one, where a shadow has nothing to darken, the other panes
+ /// recede instead (InactiveDim, at `auto_dim` unless it is set).
+ pub const LiftStyle = enum(u8) { off, shadow, rim, auto };
+ /// What `Lift auto` dims the unfocused panes by on a dark page when
+ /// InactiveDim is 0: enough to read at a glance (the user's own init
+ /// sets 35), not so much that they stop being worth reading.
+ pub const auto_dim: u8 = 30;
+
+ /// Each pass the bundled Crt or a Shadertoy file.
+ pub const Post = struct {
+ pub const max = 8;
+ pub const Entry = struct {
+ scene: ?Scene = null,
+ path: Text(limits.host_path_cap) = .{},
+ /// A bundled pass's strength, 1 to `max_level`; 0 for a file.
+ level: u8 = 0,
+ };
+ pub const max_level = 3;
+ /// What `on` and a bare word turn a bundled pass on at.
+ pub const default_level = 2;
+ entries: [max]Entry = @splat(.{}),
+ len: u8 = 0,
+ /// Bumped on every change: a shell compiles the chain again when it
+ /// moves.
+ generation: u32 = 0,
+
+ pub fn list(post: *const Post) []const Entry {
+ return post.entries[0..post.len];
+ }
+
+ pub fn has(post: *const Post, scene: Scene) bool {
+ return post.level(scene) != 0;
+ }
+
+ /// A bundled pass's level; 0 when it is not in the chain.
+ pub fn level(post: *const Post, scene: Scene) u8 {
+ for (post.list()) |entry| if (entry.scene == scene) return entry.level;
+ return 0;
+ }
+
+ /// Sets a bundled pass's level: 0 takes it out, anything else puts it
+ /// in at the end or changes it where it is.
+ pub fn setLevel(post: *Post, scene: Scene, to: u8) bool {
+ std.debug.assert(to <= max_level);
+ if (to == 0) return post.set(scene, "", false);
+ for (post.entries[0..post.len]) |*entry| if (entry.scene == scene) {
+ if (entry.level != to) post.generation +%= 1;
+ entry.level = to;
+ return true;
+ };
+ if (!post.set(scene, "", true)) return false;
+ post.entries[post.len - 1].level = to;
+ return true;
+ }
+
+ /// Puts the pass in the chain, at its end, or takes it out; `want`
+ /// null flips it. False when the chain is full or the path too long.
+ pub fn set(post: *Post, scene: ?Scene, path: []const u8, want: ?bool) bool {
+ const at: ?usize = for (post.list(), 0..) |entry, i| {
+ if (entry.scene == scene and std.mem.eql(u8, entry.path.get(), path)) break i;
+ } else null;
+ const on = want orelse (at == null);
+ if (on == (at != null)) return true;
+ post.generation +%= 1;
+ if (at) |i| {
+ std.mem.copyForwards(Entry, post.entries[i .. post.len - 1], post.entries[i + 1 .. post.len]);
+ post.len -= 1;
+ return true;
+ }
+ if (post.len == max) return false;
+ post.entries[post.len] = .{ .scene = scene };
+ if (!post.entries[post.len].path.set(path)) return false;
+ post.len += 1;
+ return true;
+ }
+
+ pub fn clear(post: *Post) void {
+ if (post.len == 0) return;
+ post.len = 0;
+ post.generation +%= 1;
+ }
+ };
+
+ pub fn toggleTransition(state: *Runtime, effect: animation.Transition) void {
std.debug.assert(effect != .off);
state.panel_transition = if (state.panel_transition == effect) .off else effect;
}
@@ -648,12 +1064,21 @@ pub const Runtime = struct {
tagline_font_size: bool,
window_opacity: bool = false,
window_blur: bool = false,
+ /// The shell shapes text, so it can draw ligatures and stop drawing them.
+ ligatures: bool = false,
+ /// The shell draws soft shadows under what stands off the page.
+ lift: bool = false,
};
pub const Capability = std.meta.FieldEnum(Capabilities);
- pub const Toggle = enum { colors, wrap, tree_context_tag_style, tag_bottom, debug, focus_tint, column_tags, syntax_bold };
- pub const Scene = std.meta.FieldEnum(layout.SceneEffect);
+ /// The message timings a setting word sets, each in milliseconds.
+ pub const MessageTime = enum { linger, fall, dissolve };
+
+ pub const Toggle = enum { colors, wrap, tree_context_tag_style, tag_bottom, debug, focus_tint, syntax_bold, pager_color, verbose, message_animation, ligatures, cursor_blink, selection_glow, hover_glow, occlusion, parallax, jump_trail, chip_shadow, thumb_flash, program_esc };
+ /// A bundled post pass, a Shadertoy file in shaders/post/: the CRT, and
+ /// G4's bloom, vignette and grain (docs/effects.md).
+ pub const Scene = enum { crt, bloom, vignette, grain };
pub const Action = union(enum) {
toggle: Toggle,
@@ -663,22 +1088,34 @@ pub const Runtime = struct {
tagline_size,
window_opacity,
window_blur,
- transition: layout.Transition,
+ message_ms: MessageTime,
+ dump_dir,
+ /// A lift style, `on` (auto) or `off`; bare flips auto and off.
+ lift,
+ /// A motion flavour.
+ motion,
+ /// A percentage, 0 through 100.
+ inactive_dim,
+ grip_width,
+ tab,
+ callstack_depth,
+ search_rows,
+ transition: animation.Transition,
scene: Scene,
+ /// A Shadertoy file into the post chain or out of it; `off` empties
+ /// it of files.
+ shader,
+ shader_animation,
+ choice: Choice,
};
pub const Setting = struct {
word: []const u8,
action: Action,
+ /// What it does, one sentence: /commands lists it after the word.
+ doc: []const u8,
availability: ?Capability = null,
- pub fn takesArg(setting: Setting) bool {
- return switch (setting.action) {
- .shell, .theme, .font, .tagline_size, .window_opacity, .window_blur => true,
- else => false,
- };
- }
-
pub fn enabled(setting: Setting, capabilities: Capabilities) bool {
const capability = setting.availability orelse return true;
return switch (capability) {
@@ -687,36 +1124,74 @@ pub const Runtime = struct {
}
};
- // The builtin registry and Config report share this command table.
+ // The builtin registry and DumpConfig report share this command table.
pub const settings = [_]Setting{
- .{ .word = "Colors", .action = .{ .toggle = .colors } },
- .{ .word = "Wrap", .action = .{ .toggle = .wrap } },
- .{ .word = "TreeContextTagStyle", .action = .{ .toggle = .tree_context_tag_style } },
- .{ .word = "Tagbottom", .action = .{ .toggle = .tag_bottom } },
- .{ .word = "Debug", .action = .{ .toggle = .debug } },
- .{ .word = "FocusTint", .action = .{ .toggle = .focus_tint } },
- .{ .word = "ColumnTags", .action = .{ .toggle = .column_tags } },
- .{ .word = "SyntaxBold", .action = .{ .toggle = .syntax_bold } },
- .{ .word = "Theme", .action = .theme },
- .{ .word = "Shell", .action = .shell },
- .{ .word = "Font", .action = .font, .availability = .font_picker },
- .{ .word = "TaglineSize", .action = .tagline_size, .availability = .font_picker },
- .{ .word = "WindowOpacity", .action = .window_opacity, .availability = .window_opacity },
- .{ .word = "WindowBlur", .action = .window_blur, .availability = .window_blur },
- .{ .word = "PanelSlide", .action = .{ .transition = .slide }, .availability = .panel_transitions },
- .{ .word = "PanelZoom", .action = .{ .transition = .zoom }, .availability = .panel_transitions },
- .{ .word = "PanelDissolve", .action = .{ .transition = .dissolve }, .availability = .panel_transitions },
- .{ .word = "PanelAscii", .action = .{ .transition = .ascii }, .availability = .panel_transitions },
- .{ .word = "PanelVertical", .action = .{ .transition = .vertical }, .availability = .panel_transitions },
- .{ .word = "PanelEdges", .action = .{ .transition = .edges }, .availability = .panel_transitions },
- .{ .word = "PanelFall", .action = .{ .transition = .fall }, .availability = .panel_transitions },
- .{ .word = "PanelWave", .action = .{ .transition = .wave }, .availability = .panel_transitions },
- .{ .word = "PanelCurtain", .action = .{ .transition = .curtain }, .availability = .panel_transitions },
- .{ .word = "PanelScramble", .action = .{ .transition = .scramble }, .availability = .panel_transitions },
- .{ .word = "PanelType", .action = .{ .transition = .typewriter }, .availability = .panel_transitions },
- .{ .word = "Crt", .action = .{ .scene = .crt }, .availability = .scene_shaders },
- .{ .word = "Ripple", .action = .{ .scene = .ripple }, .availability = .scene_shaders },
- .{ .word = "Glitch", .action = .{ .scene = .glitch }, .availability = .scene_shaders },
+ .{ .word = "Colors", .action = .{ .toggle = .colors }, .doc = "Syntax colours in text panes, on or off." },
+ .{ .word = "Wrap", .action = .{ .toggle = .wrap }, .doc = "Long lines wrap onto the next row, on or off." },
+ .{ .word = "TreeContextTagStyle", .action = .{ .toggle = .tree_context_tag_style }, .doc = "A pane's TreeContext rows draw in the tag's style, on or off." },
+ .{ .word = "Tagbottom", .action = .{ .toggle = .tag_bottom }, .doc = "Each pane's tag goes at its foot rather than its head, on or off." },
+ .{ .word = "Debug", .action = .{ .toggle = .debug }, .doc = "A small box of frame statistics at the top right, on or off." },
+ .{ .word = "FocusTint", .action = .{ .toggle = .focus_tint }, .doc = "The focused pane's and column's tags are tinted, on or off." },
+ .{ .word = "SyntaxBold", .action = .{ .toggle = .syntax_bold }, .doc = "Keywords and the like are drawn bold, on or off." },
+ .{ .word = "Verbose", .action = .{ .toggle = .verbose }, .doc = "A builtin says its own name on the message row as it runs, on or off." },
+ .{ .word = "MessageAnimation", .action = .{ .toggle = .message_animation }, .doc = "A message falls into its row and dissolves out of it, on or off." },
+ .{ .word = "Ligatures", .action = .{ .toggle = .ligatures }, .availability = .ligatures, .doc = "A font's programming ligatures draw across their cells, on or off." },
+ .{ .word = "CursorBlink", .action = .{ .toggle = .cursor_blink }, .availability = .lift, .doc = "The cursor blinks, solid while typing, on or off." },
+ .{ .word = "SelectionGlow", .action = .{ .toggle = .selection_glow }, .availability = .lift, .doc = "A soft halo of the selection's colour round it in the body, on or off." },
+ .{ .word = "HoverGlow", .action = .{ .toggle = .hover_glow }, .availability = .lift, .doc = "A soft underline of light under the word a look-hover would open, on or off." },
+ .{ .word = "Occlusion", .action = .{ .toggle = .occlusion }, .availability = .lift, .doc = "Pane bodies darken faintly toward their edges, on or off." },
+ .{ .word = "Parallax", .action = .{ .toggle = .parallax }, .availability = .lift, .doc = "A theme's page pattern moves with the text at a quarter of its speed, on or off." },
+ .{ .word = "JumpTrail", .action = .{ .toggle = .jump_trail }, .doc = "In a terminal, a jump of the cursor leaves a short trail that fades, on or off." },
+ .{ .word = "ChipShadow", .action = .{ .toggle = .chip_shadow }, .doc = "In a terminal, a notice chip casts a cell's shadow right and down, on or off." },
+ .{ .word = "ThumbFlash", .action = .{ .toggle = .thumb_flash }, .doc = "In a terminal, a pane's scroll thumb brightens as it scrolls and fades back, on or off." },
+ .{ .word = "ProgramEsc", .action = .{ .toggle = .program_esc }, .doc = "In a raw terminal, Esc goes to the program and Shift-Esc backs out, on; off (the default) swaps them." },
+ .{ .word = "Lift", .action = .lift, .availability = .lift, .doc = "How the focused pane stands off the page: off, shadow, rim or auto." },
+ .{ .word = "Motion", .action = .motion, .doc = "How animations move: off, crisp, smooth, bouncy or playful." },
+ .{ .word = "InactiveDim", .action = .inactive_dim, .doc = "Fade the unfocused panes' text by a percentage, 0 through 100, 0 off." },
+ .{ .word = "GripWidth", .action = .grip_width, .availability = .lift, .doc = "The grip and scrollbar width, as a percent of the theme's rail." },
+ .{ .word = "MessageLinger", .action = .{ .message_ms = .linger }, .doc = "How long, in milliseconds, a message stays after what dismisses it." },
+ .{ .word = "MessageFall", .action = .{ .message_ms = .fall }, .doc = "How long, in milliseconds, a message takes to fall into its row." },
+ .{ .word = "MessageDissolve", .action = .{ .message_ms = .dissolve }, .doc = "How long, in milliseconds, a message takes to dissolve." },
+ .{ .word = "DumpDir", .action = .dump_dir, .doc = "The directory Dump writes to and a relative Restore reads from; bare, the default." },
+ .{ .word = "Theme", .action = .theme, .doc = "Switch to the named theme." },
+ .{ .word = "Shell", .action = .shell, .doc = "The shell new terminals run; bare, $SHELL if it is executable, else /bin/sh." },
+ .{ .word = "Font", .action = .font, .availability = .font_picker, .doc = "The body font, by name or path, and its size." },
+ .{ .word = "TaglineSize", .action = .tagline_size, .availability = .font_picker, .doc = "Scale the tag font, a percentage." },
+ .{ .word = "WindowOpacity", .action = .window_opacity, .availability = .window_opacity, .doc = "The window's opacity, a percentage." },
+ .{ .word = "WindowBlur", .action = .window_blur, .availability = .window_blur, .doc = "The blur behind a translucent window, a radius." },
+ .{ .word = "PanelSlide", .action = .{ .transition = .slide }, .availability = .panel_transitions, .doc = "Panes slide in and out as they open and close, on or off." },
+ .{ .word = "PanelZoom", .action = .{ .transition = .zoom }, .availability = .panel_transitions, .doc = "Panes zoom in and out as they open and close, on or off." },
+ .{ .word = "PanelDissolve", .action = .{ .transition = .dissolve }, .availability = .panel_transitions, .doc = "Panes dissolve in and out as they open and close, on or off." },
+ .{ .word = "PanelAscii", .action = .{ .transition = .ascii }, .availability = .panel_transitions, .doc = "Panes open and close through a scatter of ASCII, on or off." },
+ .{ .word = "PanelVertical", .action = .{ .transition = .vertical }, .availability = .panel_transitions, .doc = "Panes open and close with a vertical wipe, on or off." },
+ .{ .word = "PanelEdges", .action = .{ .transition = .edges }, .availability = .panel_transitions, .doc = "Panes open and close from their edges, on or off." },
+ .{ .word = "PanelFall", .action = .{ .transition = .fall }, .availability = .panel_transitions, .doc = "Panes fall into place as they open, on or off." },
+ .{ .word = "PanelWave", .action = .{ .transition = .wave }, .availability = .panel_transitions, .doc = "Panes open and close in a wave, on or off." },
+ .{ .word = "PanelCurtain", .action = .{ .transition = .curtain }, .availability = .panel_transitions, .doc = "Panes open and close like a curtain, on or off." },
+ .{ .word = "PanelScramble", .action = .{ .transition = .scramble }, .availability = .panel_transitions, .doc = "Panes open and close through scrambled text, on or off." },
+ .{ .word = "PanelType", .action = .{ .transition = .typewriter }, .availability = .panel_transitions, .doc = "Panes type themselves in as they open, on or off." },
+ .{ .word = "Crt", .action = .{ .scene = .crt }, .availability = .scene_shaders, .doc = "The bundled CRT post pass over the window, on or off." },
+ .{ .word = "Bloom", .action = .{ .scene = .bloom }, .availability = .scene_shaders, .doc = "The brightest ink glows a little: a level, 0 (off) through 3." },
+ .{ .word = "Vignette", .action = .{ .scene = .vignette }, .availability = .scene_shaders, .doc = "The window's corners fall into shade: a level, 0 (off) through 3." },
+ .{ .word = "Grain", .action = .{ .scene = .grain }, .availability = .scene_shaders, .doc = "The page takes a fine, still grain, like paper: a level, 0 (off) through 3." },
+ .{ .word = "Shader", .action = .shader, .availability = .scene_shaders, .doc = "A Shadertoy file into the post chain, or out of it, compiled again when saved; off empties the chain." },
+ .{ .word = "ShaderAnimation", .action = .shader_animation, .availability = .scene_shaders, .doc = "When the post chain animates on its own: off, on (while focused) or always." },
+ .{ .word = "Placement", .action = .{ .choice = .placement }, .doc = "Where a new pane goes: acme, as makenewwindow does, or pardes, the older rules." },
+ .{ .word = "BootShell", .action = .{ .choice = .boot_shell }, .doc = "A document dropped where a lone untouched shell stands: keep the shell, or replace it." },
+ .{ .word = "LookWord", .action = .{ .choice = .look_word }, .doc = "A plain word looked at: search selects its next place in the pane, list lists every place in a +Search." },
+ .{ .word = "DiffLook", .action = .{ .choice = .diff_look }, .doc = "A .diff or .patch looked at: hunks, a +Diff stacking its hunks, or text, the file itself; Diff goes from one to the other." },
+ .{ .word = "DirLook", .action = .{ .choice = .dir_look }, .doc = "A directory looked at: pane, a pane listing it as acme's directory window, or terminal, ls in a terminal there." },
+ .{ .word = "Pager", .action = .{ .choice = .pager }, .doc = "What a terminal's commands page through: pardes, a +Pager pane (pardes -), or off, the environment's own; for terminals started after it." },
+ .{ .word = "PagerColor", .action = .{ .toggle = .pager_color }, .doc = "A +Pager keeps its program's colours, on or off; for the next text paged." },
+ .{ .word = "TermImages", .action = .{ .choice = .term_images }, .doc = "How a new terminal draws its program's kitty graphics: real, as pixels where it can, or petscii, as glyph art." },
+ .{ .word = "JumpScope", .action = .{ .choice = .jump_scope }, .doc = "What Back and Forward keep to: file, the focused pane's file until it runs out that way, or all, every place in order." },
+ .{ .word = "CallstackLayout", .action = .{ .choice = .callstack_layout }, .doc = "Callstack snippets below their locations (stacked, the default) or beside them (inline); bare, it switches layouts. Applies to the next Callstack query." },
+ .{ .word = "CallstackCorners", .action = .{ .choice = .callstack_corners }, .doc = "Callstack tree corners: rounded (the default) or square; bare, it switches styles. Applies to the next Callstack query." },
+ .{ .word = "CallstackDepth", .action = .callstack_depth, .doc = "Caller levels collected by Callstack, 1 through 64; default 8. Bare, it says the current limit." },
+ .{ .word = "Tab", .action = .tab, .doc = "A tab's width in cells, 1 through 16, in every pane; bare, it says the width." },
+ .{ .word = "SearchPlace", .action = .{ .choice = .search_place }, .doc = "Where a query pane goes: attached, under the pane that asked, out of its rows alone, or column, in the finder column." },
+ .{ .word = "SearchPane", .action = .{ .choice = .search_pane }, .doc = "A search from a pane that has a query pane: reuse it, or open a new one and leave the last where it is." },
+ .{ .word = "SearchRows", .action = .search_rows, .doc = "The rows a query pane is born with under its line 1, 1 through 100; default 8. It never resizes itself." },
};
pub fn find(name: []const u8) ?Setting {
@@ -750,8 +1225,20 @@ pub const Runtime = struct {
@compileError("window blur must use the window-blur capability"),
.transition => if (setting.availability != .panel_transitions)
@compileError("panel effects must use the panel-transition capability"),
- .scene => if (setting.availability != .scene_shaders)
+ .scene, .shader, .shader_animation => if (setting.availability != .scene_shaders)
@compileError("scene effects must use the scene-shader capability"),
+ // A toggle is plain state any shell can hold, except one for
+ // what only some shells draw: that one exists where they do.
+ .lift, .grip_width => if (setting.availability != .lift)
+ @compileError("Lift and GripWidth must use the lift capability (a pixel shell's)"),
+ .toggle => |field| if (field == .ligatures) {
+ if (setting.availability != .ligatures)
+ @compileError("the ligatures toggle must use the ligatures capability");
+ } else if (field == .cursor_blink or field == .selection_glow or field == .hover_glow or field == .occlusion or field == .parallax) {
+ if (setting.availability != .lift)
+ @compileError("CursorBlink, SelectionGlow, HoverGlow, Occlusion and Parallax must use the lift capability (a pixel shell's)");
+ } else if (setting.availability != null)
+ @compileError("unconditional toggles cannot carry a backend capability"),
else => if (setting.availability != null)
@compileError("unconditional settings cannot carry a backend capability"),
}
@@ -761,7 +1248,7 @@ pub const Runtime = struct {
if (actionCount(.shell) != 1 or actionCount(.theme) != 1 or actionCount(.font) != 1 or
actionCount(.tagline_size) != 1 or actionCount(.window_opacity) != 1 or actionCount(.window_blur) != 1)
@compileError("Shell, Theme, Font, TaglineSize, WindowOpacity, and WindowBlur actions must each occur exactly once");
- for (std.enums.values(layout.Transition)) |effect| {
+ for (std.enums.values(animation.Transition)) |effect| {
const expected: comptime_int = @intFromBool(effect != .off);
if (actionCount(.{ .transition = effect }) != expected)
@compileError("non-off panel transition must occur exactly once: " ++ @tagName(effect));
@@ -769,72 +1256,213 @@ pub const Runtime = struct {
for (std.enums.values(Scene)) |effect| {
if (actionCount(.{ .scene = effect }) != 1)
@compileError("scene effect must occur exactly once: " ++ @tagName(effect));
- if (@FieldType(layout.SceneEffect, @tagName(effect)) != bool)
- @compileError("scene effect fields must be booleans: " ++ @tagName(effect));
}
+ if (actionCount(.shader) != 1 or actionCount(.shader_animation) != 1)
+ @compileError("Shader and ShaderAnimation must each occur exactly once");
}
pub fn apply(state: *Runtime, setting: Setting, argument: ?[]const u8) bool {
switch (setting.action) {
- .toggle => |field| switch (field) {
- .colors => state.colors = !state.colors,
- .wrap => state.wrap = !state.wrap,
- .tree_context_tag_style => state.tree_context_tag_style = !state.tree_context_tag_style,
- .tag_bottom => state.tag_bottom = !state.tag_bottom,
- .debug => state.debug = !state.debug,
- .focus_tint => state.focus_tint = !state.focus_tint,
- .column_tags => state.column_tags = !state.column_tags,
- .syntax_bold => state.syntax_bold = !state.syntax_bold,
+ // Every toggle names a bool field of its own, so one line covers
+ // all of them and a new toggle needs no arm here. Bare, a toggle
+ // flips -- that is what a tagline word is for. With `on` or `off`
+ // it SETS, so the report `writeReport` prints (`Verbose on`) can
+ // be fed straight back as configuration and mean what it says.
+ .toggle => |field| {
+ const want = switchedTo(argument) catch return false;
+ switch (field) {
+ inline else => |f| @field(state, @tagName(f)) = want orelse !@field(state, @tagName(f)),
+ }
},
.shell => {
- const value = std.mem.trim(u8, argument orelse return false, " \t\r\n");
- if (value.len == 0 or !state.shell.requested.set(value)) return false;
+ // Bare, the default again ($SHELL, else /bin/sh).
+ const value = std.mem.trim(u8, argument orelse "", " \t\r\n");
+ if (!state.shell.requested.set(value)) return false;
state.shell.pending = true;
},
- .tagline_size => {
- const text = std.mem.trim(u8, argument orelse return false, " \t\r\n");
- const percent = std.fmt.parseInt(u16, text, 10) catch return false;
- if (percent < tagline_percent_min or percent > tagline_percent_max) return false;
- state.font.tagline_percent = @intCast(percent);
- },
+ .tagline_size => state.font.tagline_percent = @intCast(number(u16, argument, " \t\r\n", tagline_percent_min, tagline_percent_max) orelse return false),
.window_opacity => {
- const text = std.mem.trim(u8, argument orelse return false, " \t\r\n");
- for (text) |byte| if (!std.ascii.isDigit(byte)) return false;
- const percent = std.fmt.parseInt(u8, text, 10) catch return false;
- if (percent > 100) return false;
- state.window_opacity = percent;
+ state.window_opacity = number(u8, argument, " \t\r\n", 0, 100) orelse return false;
state.window_opacity_pending = true;
},
- .window_blur => {
- const text = std.mem.trim(u8, argument orelse return false, " \t\r\n");
- for (text) |byte| if (!std.ascii.isDigit(byte)) return false;
- const percent = std.fmt.parseInt(u8, text, 10) catch return false;
- if (percent > 100) return false;
- state.window_blur = percent;
+ .window_blur => state.window_blur = number(u8, argument, " \t\r\n", 0, 100) orelse return false,
+ // Bare, it returns to the default directory. Else an absolute or
+ // `~` path, to a directory there or to be made, that may be
+ // written: a Dump there could never be, refused now.
+ .dump_dir => {
+ const text = std.mem.trim(u8, argument orelse "", " \t\r\n");
+ if (text.len > 0) {
+ if (text[0] != '/' and text[0] != '~') return false;
+ var home_buf: [4096]u8 = undefined;
+ if (pardes.filesystem.deniedAbove(pardes.filesystem.expandHome(text, &home_buf))) return false;
+ }
+ if (!state.dump_dir.set(text)) return false;
+ },
+ .message_ms => |which| {
+ const ms = number(u16, argument, " \t\r\n", 0, message_ms_max) orelse return false;
+ switch (which) {
+ inline else => |w| @field(state, "message_" ++ @tagName(w) ++ "_ms") = ms,
+ }
+ },
+ // Panel effects are one choice, so `on` picks this one and `off`
+ // turns it off only if it is the one on.
+ .transition => |effect| {
+ const want = switchedTo(argument) catch return false;
+ if (want == null) {
+ state.toggleTransition(effect);
+ } else if (want.?) {
+ state.panel_transition = effect;
+ } else if (state.panel_transition == effect) {
+ state.panel_transition = .off;
+ }
+ },
+ .scene => |effect| {
+ // A level, 0 (off) to 3; `on` is the default level, `off` 0,
+ // and bare flips between the two.
+ const text = std.mem.trim(u8, argument orelse "", " \t\r\n");
+ const to: u8 = if (text.len == 0)
+ (if (state.post.has(effect)) 0 else Post.default_level)
+ else if (std.mem.eql(u8, text, "on"))
+ Post.default_level
+ else if (std.mem.eql(u8, text, "off"))
+ 0
+ else
+ std.fmt.parseInt(u8, text, 10) catch return false;
+ if (to > Post.max_level) return false;
+ return state.post.setLevel(effect, to);
+ },
+ .shader => {
+ const path = std.mem.trim(u8, argument orelse return false, " \t\r\n");
+ if (path.len == 0) return false;
+ if (std.mem.eql(u8, path, "off")) {
+ var i: usize = 0;
+ while (i < state.post.len) {
+ const entry = state.post.entries[i];
+ if (entry.scene == null) _ = state.post.set(null, entry.path.get(), false) else i += 1;
+ }
+ return true;
+ }
+ return state.post.set(null, path, null);
},
- .transition => |effect| state.toggleTransition(effect),
- .scene => |effect| switch (effect) {
+ .shader_animation => state.shader_animation = stepped(ShaderAnimation, state.shader_animation, argument) orelse return false,
+ // Bare, it steps to the next word, as a tag word should.
+ .choice => |which| switch (which) {
inline else => |field| {
- const value = &@field(state.scene_effects, @tagName(field));
- value.* = !value.*;
+ const now = &@field(state, @tagName(field));
+ now.* = stepped(@TypeOf(now.*), now.*, argument) orelse return false;
},
},
+ .lift => {
+ const text = std.mem.trim(u8, argument orelse "", " \t\r\n");
+ state.lift = if (text.len == 0)
+ (if (state.lift == .off) .auto else .off)
+ else if (std.mem.eql(u8, text, "on"))
+ .auto
+ else
+ std.meta.stringToEnum(LiftStyle, text) orelse return false;
+ },
+ .motion => state.motion = stepped(animation.Motion.Flavour, state.motion, argument) orelse return false,
+ .inactive_dim => state.inactive_dim = number(u8, argument, " \t\r\n%", 0, 100) orelse return false,
+ .grip_width => state.grip_width = number(u16, argument, " \t\r\n%", 50, 300) orelse return false,
+ .callstack_depth => state.callstack_depth = number(u8, argument, " \t\r\n", 1, @import("lsp/lsp.zig").callstack_max_depth) orelse return false,
+ .tab => state.tab = number(u16, argument, " \t\r\n", 1, 16) orelse return false,
+ .search_rows => state.search_rows = number(u16, argument, " \t\r\n", 1, 100) orelse return false,
.theme, .font => return false,
}
return true;
}
+ /// The values a setting that chooses among words takes, for a refusal to
+ /// name; null for one that takes a number, a path or a name. Bare, each
+ /// of these flips (a two-valued one) or steps to its next value.
+ pub fn choices(action: Action) ?[]const u8 {
+ const words = struct {
+ fn of(comptime T: type) []const u8 {
+ comptime var out: []const u8 = "";
+ inline for (std.meta.fieldNames(T), 0..) |name, i| out = out ++ (if (i > 0) ", " else "") ++ name;
+ return out;
+ }
+ };
+ return switch (action) {
+ .toggle, .transition => "on, off",
+ .choice => |which| switch (which) {
+ inline else => |field| comptime words.of(@FieldType(Runtime, @tagName(field))),
+ },
+ .lift => "on, " ++ comptime words.of(LiftStyle),
+ .motion => comptime words.of(animation.Motion.Flavour),
+ .scene => std.fmt.comptimePrint("on, off, 0-{d}", .{Post.max_level}),
+ .shader_animation => comptime words.of(ShaderAnimation),
+ else => null,
+ };
+ }
+
+ /// What a setting takes, for a refusal of a bad value to name: its
+ /// words (`choices`), else its range or the kind of thing it takes.
+ pub fn takes(action: Action) ?[]const u8 {
+ return choices(action) orelse switch (action) {
+ .inactive_dim, .window_opacity, .window_blur => "0-100 (a percentage)",
+ .grip_width => "50-300 (a percentage)",
+ .tab => "1-16 (cells)",
+ .callstack_depth => "1-64 (levels)",
+ .search_rows => "1-100 (rows)",
+ .tagline_size => std.fmt.comptimePrint("{d}-{d} (a percentage)", .{ tagline_percent_min, tagline_percent_max }),
+ .message_ms => std.fmt.comptimePrint("0-{d} (milliseconds)", .{message_ms_max}),
+ .shell => "a path of at most 255 bytes; bare, $SHELL, else /bin/sh",
+ .dump_dir => std.fmt.comptimePrint("an absolute or ~ path of at most {d} bytes, to a directory that may be written; bare, the default", .{limits.host_path_cap}),
+ .shader => "a Shadertoy file's path, or off",
+ .font => "a name or path, :8 to :72 after it (Mono:14)",
+ else => null,
+ };
+ }
+
+ /// The value a choice word names, or bare, the one after `now`; null for
+ /// a word it does not take.
+ fn stepped(comptime T: type, now: T, argument: ?[]const u8) ?T {
+ const text = std.mem.trim(u8, argument orelse "", " \t\r\n");
+ if (text.len > 0) return std.meta.stringToEnum(T, text);
+ const all = std.enums.values(T);
+ const at = std.mem.indexOfScalar(T, all, now) orelse 0;
+ return all[(at + 1) % all.len];
+ }
+
+ /// A setting's number: digits only (parseInt alone takes a sign and `_`),
+ /// trimmed of `trim`, within lo..hi.
+ fn number(comptime T: type, argument: ?[]const u8, trim: []const u8, lo: T, hi: T) ?T {
+ const text = std.mem.trim(u8, argument orelse return null, trim);
+ if (text.len == 0) return null;
+ for (text) |byte| if (!std.ascii.isDigit(byte)) return null;
+ const n = std.fmt.parseInt(T, text, 10) catch return null;
+ return if (n < lo or n > hi) null else n;
+ }
+
+ /// What `on`, `off` or nothing after a switch word asks for: null flips
+ /// it, as a bare tagline word does.
+ fn switchedTo(argument: ?[]const u8) error{NotOnOrOff}!?bool {
+ const text = std.mem.trim(u8, argument orelse "", " \t\r\n");
+ if (text.len == 0) return null;
+ if (std.mem.eql(u8, text, "on")) return true;
+ if (std.mem.eql(u8, text, "off")) return false;
+ return error.NotOnOrOff;
+ }
+
// Slices are borrowed for one writeReport call.
pub const ReportContext = struct {
startup_config_path: ?[]const u8,
platform: []const u8,
theme_name: []const u8,
+ /// The ThemeFile in effect, said as `ThemeFile <path>` in place
+ /// of the theme's name.
+ theme_file: ?[]const u8 = null,
compiled_default_shell: []const u8,
- gui_shader_source_mode: ?[]const u8 = null,
hover_delay_frames: ?u16,
+ /// Where dumps go when `DumpDir` is unset; empty without a host
+ /// filesystem.
+ default_dump_dir: []const u8 = "",
native_images: bool,
capabilities: Capabilities,
state: *const Runtime,
+ /// The `LocationsConfig` argument in effect, as it would be typed.
+ locations: []const u8 = "",
};
fn onOff(value: bool) []const u8 {
@@ -845,147 +1473,156 @@ pub const Runtime = struct {
return if (text.len == 0) "(none)" else text;
}
- fn transitionSettingName(transition: layout.Transition) []const u8 {
- if (transition == .off) return "off";
- return findAction(.{ .transition = transition }).?.word;
- }
-
+ /// Each setting line reads as the command that would set it: the word,
+ /// then the value you would type after it (a `# Word unsupported`
+ /// comment where this shell has no such setting). No colons, no units: `WindowOpacity 70`
+ /// is both what DumpConfig prints and what you write back. What is in
+ /// effect but set by no word follows, after a blank line.
pub fn writeReport(out: *std.Io.Writer, context: ReportContext) !void {
const state = context.state;
- var wrote_transition = false;
- for (settings) |setting| switch (setting.action) {
+ // TaglineSize is said wherever the shell sizes its tag, by its word
+ // or only at build time.
+ for (settings) |setting| if (!(if (setting.action == .tagline_size) context.capabilities.tagline_font_size else setting.enabled(context.capabilities)))
+ try out.print("# {s} unsupported\n", .{setting.word})
+ else switch (setting.action) {
.toggle => |field| {
const value = switch (field) {
- .colors => state.colors,
- .wrap => state.wrap,
- .tree_context_tag_style => state.tree_context_tag_style,
- .tag_bottom => state.tag_bottom,
- .debug => state.debug,
- .focus_tint => state.focus_tint,
- .column_tags => state.column_tags,
- .syntax_bold => state.syntax_bold,
+ inline else => |f| @field(state, @tagName(f)),
};
- try out.print("{s}: {s}\n", .{ setting.word, onOff(value) });
- },
- .theme => try out.print("{s}: {s}\n", .{ setting.word, context.theme_name }),
- .window_opacity => {
- if (setting.enabled(context.capabilities))
- try out.print("{s}: {d}%{s}\n", .{
- setting.word,
- state.window_opacity,
- if (state.window_opacity_pending) " (pending)" else "",
- })
- else
- try out.print("{s}: unsupported\n", .{setting.word});
+ try out.print("{s} {s}\n", .{ setting.word, onOff(value) });
},
- .window_blur => {
- if (setting.enabled(context.capabilities))
- try out.print("{s}: {d}%\n", .{ setting.word, state.window_blur })
- else
- try out.print("{s}: unsupported\n", .{setting.word});
+ .theme => if (context.theme_file) |path|
+ try out.print("ThemeFile {s}\n", .{path})
+ else
+ try out.print("{s} {s}\n", .{ setting.word, context.theme_name }),
+ .window_opacity => try out.print("{s} {d}\n", .{ setting.word, state.window_opacity }),
+ .window_blur => try out.print("{s} {d}\n", .{ setting.word, state.window_blur }),
+ .dump_dir => {
+ const dir = if (state.dump_dir.len > 0) state.dump_dir.get() else context.default_dump_dir;
+ if (dir.len > 0) try out.print("{s} {s}\n", .{ setting.word, dir }) else try out.print("# {s} (none)\n", .{setting.word});
},
+ .message_ms => |which| try out.print("{s} {d}\n", .{ setting.word, switch (which) {
+ inline else => |w| @field(state, "message_" ++ @tagName(w) ++ "_ms"),
+ } }),
.shell => {
const chosen = state.shell.requested.get();
- try out.print(
- "{s} requested (new panes): {s}{s}\n" ++
- "{s} effective (last spawn): {s}\n" ++
- "{s} pending: {s}\n",
- .{
- setting.word,
- if (chosen.len == 0) context.compiled_default_shell else chosen,
- if (chosen.len == 0) " (default)" else "",
- setting.word,
- shown(state.shell.effective.get()),
- setting.word,
- onOff(state.shell.pending),
- },
- );
- },
- .font => if (!setting.enabled(context.capabilities))
- try out.print("{s}: unsupported\n", .{setting.word})
- else {
- if (state.font.requested_size_hundredths == 0)
- try out.print("{s} requested size: unchanged\n", .{setting.word})
- else
- try out.print("{s} requested size: {d}.{d:0>2}\n", .{ setting.word, state.font.requested_size_hundredths / 100, state.font.requested_size_hundredths % 100 });
- try out.print(
- "{s} requested: {s}\n" ++
- "{s} requested path: {s}\n" ++
- "{s} effective: {s}\n" ++
- "{s} pending: {s}\n" ++
- "{s} effective size: {d}.{d:0>2} {s}\n",
- .{
- setting.word,
- shown(state.font.requested_name.get()),
- setting.word,
- shown(state.font.requested_path.get()),
- setting.word,
- shown(state.font.effective_name.get()),
- setting.word,
- onOff(state.font.pending),
- setting.word,
- state.font.effective_size_hundredths / 100,
- state.font.effective_size_hundredths % 100,
- @tagName(state.font.effective_size_unit),
- },
- );
- },
- .tagline_size => if (!context.capabilities.tagline_font_size)
- try out.print("{s}: unsupported\n", .{setting.word})
- else if (!setting.enabled(context.capabilities))
- try out.print("{s}: {d}% (build-time only)\n", .{ setting.word, state.font.tagline_percent })
- else
- try out.print("{s}: {d}%\n", .{ setting.word, state.font.tagline_percent }),
- .transition => {
- if (wrote_transition) continue;
- wrote_transition = true;
- if (!setting.enabled(context.capabilities))
- try out.writeAll("Panel transition: unsupported\n")
- else
- try out.print("Panel transition: {s}\n", .{transitionSettingName(state.panel_transition)});
+ try out.print("{s} {s}\n", .{ setting.word, if (chosen.len == 0) context.compiled_default_shell else chosen });
},
- .scene => |effect| {
- if (!setting.enabled(context.capabilities)) {
- try out.print("{s}: unsupported\n", .{setting.word});
+ .font => {
+ // As `Font` takes it, `name:size`: the one asked for, else
+ // the one in use.
+ const f = &state.font;
+ const name = if (f.requested_path.get().len > 0) f.requested_path.get() else if (f.requested_name.get().len > 0) f.requested_name.get() else f.effective_name.get();
+ // None known yet (no font loaded): a comment, as `Font`
+ // alone is no line a ctl takes.
+ if (name.len == 0) {
+ try out.print("# {s} (none yet)\n", .{setting.word});
continue;
}
- const enabled = switch (effect) {
- inline else => |field| @field(state.scene_effects, @tagName(field)),
+ try out.print("{s} {s}", .{ setting.word, name });
+ if (f.requested_size_hundredths != 0) try out.print(":{d}.{d:0>2}", .{ f.requested_size_hundredths / 100, f.requested_size_hundredths % 100 });
+ try out.writeByte('\n');
+ },
+ .tagline_size => try out.print("{s} {d}\n", .{ setting.word, state.font.tagline_percent }),
+ // Each a switch of its own, the one in use on.
+ .transition => |transition| try out.print("{s} {s}\n", .{ setting.word, onOff(state.panel_transition == transition) }),
+ .scene => |effect| {
+ const level = state.post.level(effect);
+ if (level == 0) try out.print("{s} off\n", .{setting.word}) else try out.print("{s} {d}\n", .{ setting.word, level });
+ },
+ .shader => {
+ var files: usize = 0;
+ for (state.post.list()) |entry| if (entry.scene == null) {
+ try out.print("{s} {s}\n", .{ setting.word, entry.path.get() });
+ files += 1;
};
- try out.print("{s}: {s}\n", .{ setting.word, onOff(enabled) });
+ if (files == 0) try out.print("{s} off\n", .{setting.word});
+ },
+ .shader_animation => try out.print("{s} {s}\n", .{ setting.word, @tagName(state.shader_animation) }),
+ .choice => |which| switch (which) {
+ inline else => |field| try out.print("{s} {s}\n", .{ setting.word, @tagName(@field(state, @tagName(field))) }),
},
+ .lift => try out.print("{s} {s}\n", .{ setting.word, @tagName(state.lift) }),
+ .motion => try out.print("{s} {s}\n", .{ setting.word, @tagName(state.motion) }),
+ .inactive_dim => try out.print("{s} {d}\n", .{ setting.word, state.inactive_dim }),
+ .callstack_depth => try out.print("{s} {d}\n", .{ setting.word, state.callstack_depth }),
+ .tab => try out.print("{s} {d}\n", .{ setting.word, state.tab }),
+ .search_rows => try out.print("{s} {d}\n", .{ setting.word, state.search_rows }),
+ .grip_width => try out.print("{s} {d}\n", .{ setting.word, state.grip_width }),
};
+ if (context.locations.len > 0) try out.print("LocationsConfig {s}\n", .{context.locations});
+ // In effect, and set by no word: each a `#` line, which runs as
+ // nothing (exec.executeFrom), so the report can be written back.
+ try out.writeByte('\n');
+ try out.print("# Last shell spawned: {s}\n", .{shown(state.shell.effective.get())});
+ try out.print("# Shell change pending: {s}\n", .{onOff(state.shell.pending)});
+ if (find("Font").?.enabled(context.capabilities)) {
+ const f = &state.font;
+ try out.print("# Font in use: {s} {d}.{d:0>2} {s}\n", .{ shown(f.effective_name.get()), f.effective_size_hundredths / 100, f.effective_size_hundredths % 100, @tagName(f.effective_size_unit) });
+ try out.print("# Font change pending: {s}\n", .{onOff(f.pending)});
+ }
+ if (find("WindowOpacity").?.enabled(context.capabilities))
+ try out.print("# Window opacity change pending: {s}\n", .{onOff(state.window_opacity_pending)});
+ if (context.capabilities.tagline_font_size and !find("TaglineSize").?.enabled(context.capabilities))
+ try out.writeAll("# Tagline size: build-time only\n");
if (context.startup_config_path) |path|
- try out.print("Startup config: {s}\n", .{path})
+ try out.print("# Startup config: {s}\n", .{path})
else
- try out.writeAll("Startup config: no per-user config path\n");
+ try out.writeAll("# Startup config: no per-user config path\n");
try out.print(
- "Platform: {s}\n" ++
- "Compiled default shell: {s}\n",
+ "# Platform: {s}\n" ++
+ "# Default shell ($SHELL, else /bin/sh): {s}\n",
.{ context.platform, context.compiled_default_shell },
);
- if (context.gui_shader_source_mode) |mode|
- try out.print("GUI shader source: {s}\n", .{mode});
if (context.hover_delay_frames) |frames|
- try out.print("Look hover delay: {d} frames\n", .{frames})
+ try out.print("# Look hover delay: {d} frames\n", .{frames})
else
- try out.writeAll("Look hover delay: off\n");
- try out.print("Native images: {s}\n", .{onOff(context.native_images)});
+ try out.writeAll("# Look hover delay: off\n");
+ try out.print("# Native images: {s}\n", .{onOff(context.native_images)});
if (std.mem.eql(u8, context.platform, "gui"))
- try out.print("Pet: {s}\n", .{@tagName(state.pet)});
+ try out.print("# Pet: {s}\n", .{@tagName(state.pet)});
}
- test "setting names are unique and argument metadata follows actions" {
- for (settings, 0..) |setting, i| {
- try std.testing.expect(setting.word.len > 0);
- for (settings[i + 1 ..]) |later|
- try std.testing.expect(!std.mem.eql(u8, setting.word, later.word));
- try std.testing.expectEqual(switch (setting.action) {
- .shell, .theme, .font, .tagline_size, .window_opacity, .window_blur => true,
- else => false,
- }, setting.takesArg());
- }
+ test "panel and scene effects flip bare and are set by on and off" {
+ var state: Runtime = .{};
+ const slide = findAction(.{ .transition = .slide }).?;
+ const zoom = findAction(.{ .transition = .zoom }).?;
+ try std.testing.expect(apply(&state, slide, "on"));
+ try std.testing.expectEqual(animation.Transition.slide, state.panel_transition);
+ try std.testing.expect(apply(&state, zoom, "off"));
+ try std.testing.expectEqual(animation.Transition.slide, state.panel_transition);
+ try std.testing.expect(apply(&state, slide, "on"));
+ try std.testing.expectEqual(animation.Transition.slide, state.panel_transition);
+ try std.testing.expect(apply(&state, slide, null));
+ try std.testing.expectEqual(animation.Transition.off, state.panel_transition);
+ try std.testing.expect(!apply(&state, slide, "yes"));
+ const scene = findAction(.{ .scene = std.enums.values(Scene)[0] }).?;
+ try std.testing.expect(apply(&state, scene, "on"));
+ try std.testing.expect(apply(&state, scene, "on"));
+ try std.testing.expect(state.post.has(std.enums.values(Scene)[0]));
+ }
+
+ test "a toggle flips when bare and sets when told on or off" {
+ var state: Runtime = .{};
+ const verbose = find("Verbose").?;
+ try std.testing.expect(state.verbose);
+ // Bare, it flips: that is what a tagline word does.
+ try std.testing.expect(apply(&state, verbose, null));
+ try std.testing.expect(!state.verbose);
+ // Told, it SETS -- twice over, so the second call proves it is not
+ // flipping past the value it was given.
+ try std.testing.expect(apply(&state, verbose, "on"));
+ try std.testing.expect(state.verbose);
+ try std.testing.expect(apply(&state, verbose, " on\n"));
+ try std.testing.expect(state.verbose);
+ try std.testing.expect(apply(&state, verbose, "off"));
+ try std.testing.expect(!state.verbose);
+ try std.testing.expect(apply(&state, verbose, "off"));
+ try std.testing.expect(!state.verbose);
+ // And anything else is refused rather than silently flipping.
+ try std.testing.expect(!apply(&state, verbose, "maybe"));
+ try std.testing.expect(!state.verbose);
}
test "simple setting application mutates only its plain field" {
@@ -996,11 +1633,71 @@ pub const Runtime = struct {
try std.testing.expectEqualStrings("fish", state.shell.requested.get());
try std.testing.expect(state.shell.pending);
try std.testing.expect(apply(&state, find("PanelAscii").?, null));
- try std.testing.expectEqual(layout.Transition.ascii, state.panel_transition);
+ try std.testing.expectEqual(animation.Transition.ascii, state.panel_transition);
try std.testing.expect(apply(&state, find("PanelAscii").?, null));
- try std.testing.expectEqual(layout.Transition.off, state.panel_transition);
+ try std.testing.expectEqual(animation.Transition.off, state.panel_transition);
try std.testing.expect(apply(&state, find("Crt").?, null));
- try std.testing.expect(state.scene_effects.crt);
+ try std.testing.expect(state.post.has(.crt));
+ }
+
+ test "the post chain runs in the order its passes were put in, and Shader off empties it of files" {
+ var state: Runtime = .{};
+ try std.testing.expect(apply(&state, find("Shader").?, " ~/a.glsl\n"));
+ try std.testing.expect(apply(&state, find("Crt").?, "on"));
+ try std.testing.expect(apply(&state, find("Shader").?, "/b.glsl"));
+ const chain = state.post.list();
+ try std.testing.expectEqual(@as(usize, 3), chain.len);
+ try std.testing.expectEqualStrings("~/a.glsl", chain[0].path.get());
+ try std.testing.expectEqual(Scene.crt, chain[1].scene.?);
+ try std.testing.expectEqualStrings("/b.glsl", chain[2].path.get());
+ const moved = state.post.generation;
+ // A file named again leaves; the others keep their order.
+ try std.testing.expect(apply(&state, find("Shader").?, "~/a.glsl"));
+ try std.testing.expect(state.post.generation != moved);
+ try std.testing.expectEqual(Scene.crt, state.post.list()[0].scene.?);
+ try std.testing.expect(apply(&state, find("Shader").?, "off"));
+ try std.testing.expectEqual(@as(usize, 1), state.post.len);
+ try std.testing.expect(!apply(&state, find("Shader").?, null));
+ try std.testing.expect(apply(&state, find("ShaderAnimation").?, "always"));
+ try std.testing.expectEqual(ShaderAnimation.always, state.shader_animation);
+ try std.testing.expect(!apply(&state, find("ShaderAnimation").?, "sometimes"));
+ }
+
+ test "a bundled pass takes a level: on is the default, 0 and off take it out, and the old words still flip" {
+ var state: Runtime = .{};
+ const crt = find("Crt").?;
+ try std.testing.expect(apply(&state, crt, "on"));
+ try std.testing.expectEqual(@as(u8, Post.default_level), state.post.level(.crt));
+ try std.testing.expect(apply(&state, find("Shader").?, "/after.glsl"));
+ const moved = state.post.generation;
+ try std.testing.expect(apply(&state, crt, "3"));
+ try std.testing.expectEqual(@as(u8, 3), state.post.level(.crt));
+ // A new level keeps its place in the chain.
+ try std.testing.expectEqual(Scene.crt, state.post.list()[0].scene.?);
+ try std.testing.expect(state.post.generation != moved);
+ try std.testing.expect(!apply(&state, crt, "4"));
+ try std.testing.expect(!apply(&state, crt, "loud"));
+ try std.testing.expect(apply(&state, crt, "0"));
+ try std.testing.expect(!state.post.has(.crt));
+ try std.testing.expect(apply(&state, crt, null));
+ try std.testing.expectEqual(@as(u8, Post.default_level), state.post.level(.crt));
+ try std.testing.expect(apply(&state, crt, "off"));
+ try std.testing.expectEqual(@as(u8, 0), state.post.level(.crt));
+ }
+
+ test "Lift takes a style, on is auto, and bare flips it off and back to auto" {
+ var state: Runtime = .{};
+ const lift = find("Lift").?;
+ try std.testing.expect(apply(&state, lift, null));
+ try std.testing.expectEqual(LiftStyle.auto, state.lift);
+ try std.testing.expect(apply(&state, lift, "rim"));
+ try std.testing.expectEqual(LiftStyle.rim, state.lift);
+ try std.testing.expect(apply(&state, lift, null));
+ try std.testing.expectEqual(LiftStyle.off, state.lift);
+ try std.testing.expect(apply(&state, lift, "on"));
+ try std.testing.expectEqual(LiftStyle.auto, state.lift);
+ try std.testing.expect(!apply(&state, lift, "sparkle"));
+ try std.testing.expectEqual(LiftStyle.auto, state.lift);
}
test "tagline size validates before mutating live state" {
@@ -1024,7 +1721,6 @@ pub const Runtime = struct {
var state: Runtime = .{};
try std.testing.expectEqual(@as(u8, 100), state.window_opacity);
try std.testing.expect(state.window_opacity_pending);
- try std.testing.expect(setting.takesArg());
try std.testing.expectEqual(Capability.window_opacity, setting.availability.?);
for ([_][]const u8{ "0", " 85\n", "100" }, [_]u8{ 0, 85, 100 }) |argument, expected| {
@@ -1086,15 +1782,15 @@ pub const Runtime = struct {
try std.testing.expect(FontSpec.parse(bad) == null);
}
- test "Config report observes every simple setting and all live context" {
+ test "DumpConfig report observes every simple setting and all live context" {
var state: Runtime = .{};
- var storage: [4096]u8 = undefined;
+ // Every setting, every context line: the report outgrows 4K.
+ var storage: [8192]u8 = undefined;
const context: ReportContext = .{
.startup_config_path = "/tmp/pardes/init",
.platform = "gui",
.theme_name = "acme",
.compiled_default_shell = "/bin/sh",
- .gui_shader_source_mode = "live GLSL compiled during this build",
.hover_delay_frames = 18,
.native_images = true,
.capabilities = .{
@@ -1104,6 +1800,8 @@ pub const Runtime = struct {
.tagline_font_size = true,
.window_opacity = true,
.window_blur = true,
+ .ligatures = true,
+ .lift = true,
},
.state = &state,
};
@@ -1118,6 +1816,31 @@ pub const Runtime = struct {
.tagline_size => "73",
.window_opacity => "85",
.window_blur => "40",
+ .message_ms => "1500",
+ .dump_dir => "~/dumps",
+ .shader => "~/crt.glsl",
+ .shader_animation => "always",
+ .choice => |which| switch (which) {
+ .placement => "pardes",
+ .boot_shell => "replace",
+ .look_word => "list",
+ .dir_look => "terminal",
+ .diff_look => "text",
+ .pager => "off",
+ .term_images => "petscii",
+ .jump_scope => "all",
+ .callstack_layout => "inline",
+ .callstack_corners => "square",
+ .search_place => "column",
+ .search_pane => "new",
+ },
+ .lift => "rim",
+ .motion => "playful",
+ .inactive_dim => "35",
+ .grip_width => "200",
+ .callstack_depth => "16",
+ .tab => "8",
+ .search_rows => "12",
else => null,
};
try std.testing.expect(apply(&state, setting, argument));
@@ -1127,38 +1850,80 @@ pub const Runtime = struct {
const report = storage[0..out.end];
const expected = switch (setting.action) {
.toggle => |field| switch (field) {
- .colors => "Colors: off\n",
- .wrap => "Wrap: off\n",
- .tree_context_tag_style => "TreeContextTagStyle: off\n",
- .tag_bottom => "Tagbottom: on\n",
- .debug => "Debug: on\n",
- .focus_tint => "FocusTint: off\n",
- .column_tags => "ColumnTags: off\n",
- .syntax_bold => "SyntaxBold: on\n",
+ .colors => "Colors off\n",
+ .wrap => "Wrap off\n",
+ .tree_context_tag_style => "TreeContextTagStyle off\n",
+ .tag_bottom => "Tagbottom on\n",
+ .debug => "Debug on\n",
+ .focus_tint => "FocusTint off\n",
+ .syntax_bold => "SyntaxBold on\n",
+ .pager_color => "PagerColor off\n",
+ .verbose => "Verbose off\n",
+ .message_animation => "MessageAnimation off\n",
+ .ligatures => "Ligatures off\n",
+ .cursor_blink => "CursorBlink off\n",
+ .selection_glow => "SelectionGlow on\n",
+ .hover_glow => "HoverGlow on\n",
+ .occlusion => "Occlusion on\n",
+ .parallax => "Parallax on\n",
+ .jump_trail => "JumpTrail on\n",
+ .chip_shadow => "ChipShadow on\n",
+ .thumb_flash => "ThumbFlash on\n",
+ .program_esc => "ProgramEsc on\n",
+ },
+ .shell => "Shell fish\n",
+ .tagline_size => "TaglineSize 73\n",
+ .window_opacity => "WindowOpacity 85\n",
+ .window_blur => "WindowBlur 40\n",
+ .dump_dir => "DumpDir ~/dumps\n",
+ .message_ms => |which| switch (which) {
+ .linger => "MessageLinger 1500\n",
+ .fall => "MessageFall 1500\n",
+ .dissolve => "MessageDissolve 1500\n",
},
- .shell => "Shell requested (new panes): fish\n",
- .tagline_size => "TaglineSize: 73%\n",
- .window_opacity => "WindowOpacity: 85% (pending)\n",
- .window_blur => "WindowBlur: 40%\n",
.transition => |transition| switch (transition) {
.off => unreachable,
- .slide => "Panel transition: PanelSlide\n",
- .zoom => "Panel transition: PanelZoom\n",
- .dissolve => "Panel transition: PanelDissolve\n",
- .ascii => "Panel transition: PanelAscii\n",
- .vertical => "Panel transition: PanelVertical\n",
- .edges => "Panel transition: PanelEdges\n",
- .fall => "Panel transition: PanelFall\n",
- .wave => "Panel transition: PanelWave\n",
- .curtain => "Panel transition: PanelCurtain\n",
- .scramble => "Panel transition: PanelScramble\n",
- .typewriter => "Panel transition: PanelType\n",
+ .slide => "PanelSlide on\n",
+ .zoom => "PanelZoom on\n",
+ .dissolve => "PanelDissolve on\n",
+ .ascii => "PanelAscii on\n",
+ .vertical => "PanelVertical on\n",
+ .edges => "PanelEdges on\n",
+ .fall => "PanelFall on\n",
+ .wave => "PanelWave on\n",
+ .curtain => "PanelCurtain on\n",
+ .scramble => "PanelScramble on\n",
+ .typewriter => "PanelType on\n",
},
.scene => |effect| switch (effect) {
- .crt => "Crt: on\n",
- .ripple => "Ripple: on\n",
- .glitch => "Glitch: on\n",
+ .crt => "Crt 2\n",
+ .bloom => "Bloom 2\n",
+ .vignette => "Vignette 2\n",
+ .grain => "Grain 2\n",
},
+ .shader => "Shader ~/crt.glsl\n",
+ .shader_animation => "ShaderAnimation always\n",
+ .choice => |which| switch (which) {
+ .placement => "Placement pardes\n",
+ .boot_shell => "BootShell replace\n",
+ .look_word => "LookWord list\n",
+ .dir_look => "DirLook terminal\n",
+ .diff_look => "DiffLook text\n",
+ .pager => "Pager off\n",
+ .term_images => "TermImages petscii\n",
+ .jump_scope => "JumpScope all\n",
+ .callstack_layout => "CallstackLayout inline\n",
+ .callstack_corners => "CallstackCorners square\n",
+ .search_place => "SearchPlace column\n",
+ .search_pane => "SearchPane new\n",
+ },
+ .lift => "Lift rim\n",
+ .motion => "Motion playful\n",
+ .inactive_dim => "InactiveDim 35\n",
+ .grip_width => "GripWidth 200\n",
+ .callstack_depth => "CallstackDepth 16\n",
+ .tab => "Tab 8\n",
+ .search_rows => "SearchRows 12\n",
.theme, .font => unreachable,
};
try std.testing.expect(std.mem.indexOf(u8, report, expected) != null);
@@ -1178,28 +1943,24 @@ pub const Runtime = struct {
try writeReport(&out, context);
const report = storage[0..out.end];
for ([_][]const u8{
- "Theme: acme\n",
- "WindowOpacity: 85%\n",
- "Font requested size: 18.50\n",
- "Font requested: Wanted Mono\n",
- "Font requested path: /fonts/wanted.ttf\n",
- "Font effective: Effective Mono\n",
- "Font pending: on\n",
- "Font effective size: 13.75 points\n",
- "TaglineSize: 82%\n",
- "Startup config: /tmp/pardes/init\n",
- "Platform: gui\n",
- "Compiled default shell: /bin/sh\n",
- "GUI shader source: live GLSL compiled during this build\n",
- "Look hover delay: 18 frames\n",
- "Native images: on\n",
+ "Theme acme\n",
+ "WindowOpacity 85\n",
+ "Font /fonts/wanted.ttf:18.50\n",
+ "# Font in use: Effective Mono 13.75 points\n",
+ "# Font change pending: on\n",
+ "# Window opacity change pending: off\n",
+ "TaglineSize 82\n",
+ "# Startup config: /tmp/pardes/init\n",
+ "# Platform: gui\n",
+ "# Default shell ($SHELL, else /bin/sh): /bin/sh\n",
+ "# Look hover delay: 18 frames\n",
+ "# Native images: on\n",
}) |expected| try std.testing.expect(std.mem.indexOf(u8, report, expected) != null);
var defaults: Runtime = .{};
var defaults_context = context;
defaults_context.startup_config_path = null;
defaults_context.platform = "tty";
- defaults_context.gui_shader_source_mode = null;
defaults_context.hover_delay_frames = null;
defaults_context.native_images = false;
defaults_context.capabilities = .{
@@ -1212,25 +1973,35 @@ pub const Runtime = struct {
out = .fixed(&storage);
try writeReport(&out, defaults_context);
const defaults_report = storage[0..out.end];
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "WindowOpacity: unsupported\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "WindowOpacity unsupported\n") != null);
try std.testing.expect(!find("WindowOpacity").?.enabled(defaults_context.capabilities));
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "WindowBlur: unsupported\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "WindowBlur unsupported\n") != null);
try std.testing.expect(!find("WindowBlur").?.enabled(defaults_context.capabilities));
try std.testing.expect(find("WindowOpacity").?.enabled(context.capabilities));
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Shell requested (new panes): /bin/sh (default)\n") != null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Shell effective (last spawn): (none)\n") != null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Shell pending: on\n") != null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Startup config: no per-user config path\n") != null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "GUI shader source:") == null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Font: unsupported\n") != null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Font requested:") == null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Panel transition: off\n") != null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Crt: unsupported\n") != null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Ripple: unsupported\n") != null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Glitch: unsupported\n") != null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "TaglineSize: unsupported\n") != null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Look hover delay: off\n") != null);
- try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Native images: off\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Shell /bin/sh\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "# Last shell spawned: (none)\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "# Shell change pending: on\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "# Startup config: no per-user config path\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Font unsupported\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Font in use") == null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "PanelSlide off\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "Crt unsupported\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "TaglineSize unsupported\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "# Look hover delay: off\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "# Native images: off\n") != null);
+ // A setting this shell does not have reads so, as a comment.
+ try std.testing.expect(std.mem.indexOf(u8, defaults_report, "# Ligatures unsupported\n") != null);
+ // Every line before the blank one is a ctl word and its value, or a
+ // comment naming one.
+ const words = defaults_report[0..std.mem.indexOf(u8, defaults_report, "\n\n").?];
+ var lines = std.mem.splitScalar(u8, words, '\n');
+ while (lines.next()) |line| {
+ const word = if (std.mem.startsWith(u8, line, "# ")) line[2..] else line;
+ try std.testing.expect(find(word[0..std.mem.indexOfScalar(u8, word, ' ').?]) != null);
+ }
+ // ...and every one after it a `#` line, which runs as nothing.
+ var info = std.mem.splitScalar(u8, std.mem.trimEnd(u8, defaults_report[words.len + 2 ..], "\n"), '\n');
+ while (info.next()) |line| try std.testing.expect(std.mem.startsWith(u8, line, "# "));
defaults_context.platform = "web";
defaults_context.capabilities.panel_transitions = false;
@@ -1238,8 +2009,9 @@ pub const Runtime = struct {
out = .fixed(&storage);
try writeReport(&out, defaults_context);
const web_report = storage[0..out.end];
- try std.testing.expect(std.mem.indexOf(u8, web_report, "Panel transition: unsupported\n") != null);
- try std.testing.expect(std.mem.indexOf(u8, web_report, "TaglineSize: 100% (build-time only)\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, web_report, "PanelSlide unsupported\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, web_report, "TaglineSize 100\n") != null);
+ try std.testing.expect(std.mem.indexOf(u8, web_report, "# Tagline size: build-time only\n") != null);
}
};
@@ -1395,10 +2167,12 @@ pub const User = struct {
defer gpa.free(one_path);
const bytes = try std.Io.Dir.cwd().readFileAlloc(io, one_path, gpa, .limited(4096));
defer gpa.free(bytes);
- const source = try gpa.dupeZ(u8, bytes);
+ const source = try gpa.dupeSentinel(u8, bytes, 0);
defer gpa.free(source);
- const parsed = try std.zon.parse.fromSliceAlloc(Sample, gpa, source, null, .{});
- defer std.zon.parse.free(gpa, parsed);
+ var arena: std.heap.ArenaAllocator = .init(gpa);
+ defer arena.deinit();
+ var diagnostics: std.zon.parse.Diagnostics = undefined;
+ const parsed = try std.zon.parse.fromSlice(Sample, .{ .gpa = gpa, .arena = arena.allocator(), .source = source, .diagnostics = &diagnostics });
try std.testing.expectEqualStrings("one", parsed.name);
try std.testing.expectEqual([3]u8{ 1, 2, 3 }, parsed.rgb);
}
@@ -1408,3 +2182,339 @@ test {
_ = Runtime;
_ = User;
}
+
+/// The docs in docs/typ name words, keys and tags; each must still be here.
+const doc_typ = struct {
+ /// The leading string arguments of every `name("...", "...")` call in a
+ /// source: one for word, key and tag, each of them for keys.
+ fn calls(gpa: std.mem.Allocator, source: []const u8, comptime name: []const u8, out: *std.ArrayList([]const u8)) !void {
+ var at: usize = 0;
+ while (std.mem.indexOfPos(u8, source, at, name ++ "(\"")) |i| {
+ at = i + name.len + 2;
+ if (i > 0 and (std.ascii.isAlphanumeric(source[i - 1]) or source[i - 1] == '-')) continue;
+ while (true) {
+ const end = std.mem.indexOfScalarPos(u8, source, at, '"') orelse return error.Unterminated;
+ try out.append(gpa, source[at..end]);
+ at = end + 1;
+ while (at < source.len and (source[at] == ',' or source[at] == ' ')) at += 1;
+ if (at >= source.len or source[at] != '"') break;
+ at += 1;
+ }
+ }
+ }
+
+ /// The other build's builtins (docs/typ/builtins-*.json), so the docs
+ /// may name a window-only word in a terminal build's test, and back.
+ var other_build: []const u8 = "";
+
+ fn word(w: []const u8) bool {
+ const name = w[0 .. std.mem.indexOfScalar(u8, w, '+') orelse w.len];
+ if (std.meta.stringToEnum(Builtin, name) != null) return true;
+ var buf: [96]u8 = undefined;
+ const needle = std.fmt.bufPrint(&buf, "{{\"name\": \"{s}\",", .{name}) catch return false;
+ return std.mem.indexOf(u8, other_build, needle) != null;
+ }
+
+ fn chord(tok: []const u8) ?Chord {
+ var c: Chord = .{ .cp = 0 };
+ var rest = tok;
+ while (rest.len > 2) {
+ if (std.mem.startsWith(u8, rest, "Ctrl-")) c.ctrl = true else if (std.mem.startsWith(u8, rest, "Alt-")) c.alt = true else if (std.mem.startsWith(u8, rest, "Shift-")) c.shift = true else break;
+ rest = rest[std.mem.indexOfScalar(u8, rest, '-').? + 1 ..];
+ }
+ const named = [_]struct { []const u8, u21 }{ .{ "Esc", Key.escape }, .{ "Enter", Key.enter }, .{ "Tab", Key.tab }, .{ "SPC", ' ' } };
+ for (named) |n| if (std.mem.eql(u8, rest, n[0])) {
+ c.cp = n[1];
+ return c;
+ };
+ if (rest.len != 1) return null;
+ c.cp = rest[0];
+ return c;
+ }
+
+ fn same(a: Chord, b: Chord) bool {
+ return a.cp == b.cp and a.ctrl == b.ctrl and a.alt == b.alt and a.shift == b.shift;
+ }
+
+ fn hasChordField(T: type) bool {
+ if (@typeInfo(T) != .array or @typeInfo(@typeInfo(T).array.child) != .@"struct") return false;
+ for (@typeInfo(@typeInfo(T).array.child).@"struct".field_types) |F| if (F == Chord) return true;
+ return false;
+ }
+
+ /// Bound somewhere in this file: a binding, a prefix or a key list.
+ fn bound(c: Chord) bool {
+ const config = @import("config.zig");
+ inline for (@typeInfo(config).@"struct".decl_names) |d| {
+ const v = @field(config, d);
+ const T = @TypeOf(v);
+ if (T == []const Chord) {
+ for (v) |b| if (same(b, c)) return true;
+ } else if (T == comptime_int or T == u21 or T == u8) {
+ // a prefix or a bare key; only the tty toggle carries Ctrl
+ const plain = !c.alt and !c.shift and (!c.ctrl or comptime std.mem.indexOf(u8, d, "toggle") != null);
+ if (plain and v >= 0x20 and v < 0x7f and v == c.cp) return true;
+ } else if (comptime hasChordField(T)) {
+ const info = @typeInfo(@TypeOf(v[0])).@"struct";
+ for (v) |e| inline for (info.field_names, info.field_types) |name, F|
+ if (F == Chord and same(@field(e, name), c)) return true;
+ }
+ }
+ return false;
+ }
+
+ fn key(k: []const u8) bool {
+ var toks = std.mem.tokenizeScalar(u8, k, ' ');
+ const first = toks.next() orelse return false;
+ if (std.mem.eql(u8, first, "SPC")) {
+ var path: [8]u8 = undefined;
+ var n: usize = 0;
+ while (toks.next()) |t| : (n += 1) {
+ if (t.len != 1 or n == path.len) return false;
+ path[n] = t[0];
+ }
+ if (n == 0) return leader.len == 1 and leader[0].cp == ' ';
+ for (std.enums.values(Builtin)) |b| if (leader_path.get(b)) |p|
+ if (std.mem.eql(u8, p, path[0..n])) return true;
+ for (leader_args) |la| if (std.mem.eql(u8, la.path, path[0..n])) return true;
+ return false;
+ }
+ toks.reset();
+ while (toks.next()) |t| if (!bound(chord(t) orelse return false)) return false;
+ return true;
+ }
+
+ fn tag(t: []const u8) bool {
+ var norm: [256]u8 = undefined;
+ var w: std.Io.Writer = .fixed(&norm);
+ var words = std.mem.tokenizeScalar(u8, t, ' ');
+ while (words.next()) |x| {
+ if (w.end > 0) w.writeByte(' ') catch return false;
+ w.writeAll(x[0 .. std.mem.indexOfScalar(u8, x, '+') orelse x.len]) catch return false;
+ }
+ const tags = [_][]const u8{ topbar_str, @import("tagline.zig").column_tag_default, pane_builtins_str, pdf_pane_builtins_str, file_pane_builtins_str, diff_pane_builtins_str, pager_pane_builtins_str, pager_diff_pane_builtins_str, diff_view_builtins_str, terminal_pane_builtins_str, command_pane_builtins_str, dir_pane_builtins_str };
+ for (tags) |d| if (std.mem.eql(u8, d, w.buffered())) return true;
+ return false;
+ }
+};
+
+test "docs/typ names only words, keys and default tags that exist" {
+ var arena: std.heap.ArenaAllocator = .init(std.testing.allocator);
+ defer arena.deinit();
+ const gpa = arena.allocator();
+ const io = std.testing.io;
+ var dir = try std.Io.Dir.cwd().openDir(io, @import("doc_typ").dir, .{ .iterate = true });
+ defer dir.close(io);
+ var found: [3]std.ArrayList([]const u8) = @splat(.empty);
+ for ([_][]const u8{ "builtins-tty.json", "builtins-gui.json" }) |f| {
+ const text = dir.readFileAlloc(io, f, gpa, .limited(1 << 20)) catch continue;
+ doc_typ.other_build = try std.mem.concat(gpa, u8, &.{ doc_typ.other_build, text });
+ }
+ var it = dir.iterate();
+ while (try it.next(io)) |entry| if (entry.kind == .file and std.mem.endsWith(u8, entry.name, ".typ")) {
+ const source = try dir.readFileAlloc(io, entry.name, gpa, .limited(1 << 20));
+ inline for (.{ "word", "key", "tag" }, &found) |name, *list| try doc_typ.calls(gpa, source, name, list);
+ try doc_typ.calls(gpa, source, "keys", &found[1]); // alternatives, each a key
+ };
+ inline for (.{ "word", "key", "tag" }, found) |name, list| {
+ try std.testing.expect(list.items.len >= 5);
+ for (list.items) |arg| if (!@field(doc_typ, name)(arg)) {
+ std.debug.print("docs/typ: {s}(\"{s}\") is not in pardes\n", .{ name, arg });
+ return error.DocDrift;
+ };
+ }
+}
+
+/// The tutor's own spellings, which the docs/typ test cannot read: a
+/// builtin in backticks (`Save`, `Kill make`), a tag on a line of its own
+/// after "| ", a leader path after SPC (`SPC f s`), a chord as Ctrl-, Alt-
+/// or Shift- and one key.
+const doc_tutor = struct {
+ /// Read before the bindings in this file: a raw terminal's paste
+ /// (Pardes.handleKey).
+ const elsewhere = [_]Chord{ .{ .cp = 'V', .ctrl = true }, .{ .cp = 'V', .ctrl = true, .shift = true } };
+
+ /// The first word in each pair of backticks that looks like a builtin:
+ /// a capital, then letters and digits with a lower-case one among them.
+ fn words(gpa: std.mem.Allocator, text: []const u8, out: *std.ArrayList([]const u8)) !void {
+ var it = std.mem.splitScalar(u8, text, '`');
+ _ = it.next(); // before the first backtick
+ while (it.next()) |inside| {
+ _ = it.next() orelse break; // what follows the closing one
+ const first = inside[0 .. std.mem.indexOfAny(u8, inside, " +") orelse inside.len];
+ if (first.len < 2 or !std.ascii.isUpper(first[0])) continue;
+ var lower = false;
+ for (first) |c| {
+ if (!std.ascii.isAlphanumeric(c)) break;
+ lower = lower or std.ascii.isLower(c);
+ } else if (lower) try out.append(gpa, first);
+ }
+ }
+
+ /// The keys pressed after each SPC, up to the first that is no single
+ /// key: a path, or the start of one.
+ fn paths(gpa: std.mem.Allocator, text: []const u8, out: *std.ArrayList([]const u8)) !void {
+ var toks = std.mem.tokenizeAny(u8, text, " \n");
+ while (toks.next()) |t| {
+ if (!std.mem.eql(u8, t, "SPC")) continue;
+ var keys: std.ArrayList(u8) = .empty;
+ while (toks.peek()) |k| {
+ // `o,` and `j)` end a path written in a sentence
+ const ends = k.len == 2 and std.mem.indexOfScalar(u8, ",.;:)", k[1]) != null;
+ if ((k.len != 1 and !ends) or k[0] == '/') break;
+ try keys.append(gpa, k[0]);
+ _ = toks.next();
+ if (ends) break;
+ }
+ if (keys.items.len > 0) try out.append(gpa, keys.items);
+ }
+ }
+
+ fn path(keys: []const u8) bool {
+ for (std.enums.values(Builtin)) |b| if (leader_path.get(b)) |p|
+ if (std.mem.startsWith(u8, p, keys)) return true;
+ for (leader_args) |la| if (std.mem.startsWith(u8, la.path, keys)) return true;
+ return false;
+ }
+
+ /// Every Ctrl-, Alt- or Shift- chord: its modifiers, then one key.
+ fn chords(gpa: std.mem.Allocator, text: []const u8, out: *std.ArrayList(Chord)) !void {
+ const named = [_]struct { []const u8, u21 }{ .{ "Esc", Key.escape }, .{ "Enter", Key.enter }, .{ "Tab", Key.tab } };
+ var i: usize = 0;
+ while (i < text.len) : (i += 1) {
+ if (i > 0 and std.ascii.isAlphanumeric(text[i - 1])) continue;
+ var c: Chord = .{ .cp = 0 };
+ var at = i;
+ while (true) {
+ const rest = text[at..];
+ if (std.mem.startsWith(u8, rest, "Ctrl-")) c.ctrl = true else if (std.mem.startsWith(u8, rest, "Alt-")) c.alt = true else if (std.mem.startsWith(u8, rest, "Shift-")) c.shift = true else break;
+ at += std.mem.indexOfScalar(u8, rest, '-').? + 1;
+ }
+ if (at == i or at >= text.len) continue;
+ c.cp = text[at];
+ for (named) |n| if (std.mem.startsWith(u8, text[at..], n[0])) {
+ c.cp = n[1];
+ };
+ try out.append(gpa, c);
+ i = at;
+ }
+ }
+};
+
+test "the tutor names only words, keys, paths and default tags that exist" {
+ var arena: std.heap.ArenaAllocator = .init(std.testing.allocator);
+ defer arena.deinit();
+ const gpa = arena.allocator();
+ const tutor = @embedFile("tutor.txt");
+
+ var found: std.ArrayList([]const u8) = .empty;
+ try doc_tutor.words(gpa, tutor, &found);
+ try std.testing.expect(found.items.len >= 20);
+ for (found.items) |w| if (!doc_typ.word(w)) {
+ std.debug.print("tutor.txt: `{s}` is no builtin\n", .{w});
+ return error.DocDrift;
+ };
+
+ var tags: usize = 0;
+ var lines = std.mem.splitScalar(u8, tutor, '\n');
+ while (lines.next()) |line| if (std.mem.startsWith(u8, line, "| ")) {
+ tags += 1;
+ if (!doc_typ.tag(line[2..])) {
+ std.debug.print("tutor.txt: \"{s}\" is no default tag\n", .{line});
+ return error.DocDrift;
+ }
+ };
+ try std.testing.expect(tags >= 5);
+
+ found.clearRetainingCapacity();
+ try doc_tutor.paths(gpa, tutor, &found);
+ try std.testing.expect(found.items.len >= 10);
+ for (found.items) |p| if (!doc_tutor.path(p)) {
+ std.debug.print("tutor.txt: SPC {s} leads nowhere\n", .{p});
+ return error.DocDrift;
+ };
+
+ var chords: std.ArrayList(Chord) = .empty;
+ try doc_tutor.chords(gpa, tutor, &chords);
+ try std.testing.expect(chords.items.len >= 10);
+ for (chords.items) |c| {
+ const elsewhere = for (doc_tutor.elsewhere) |e| {
+ if (doc_typ.same(e, c)) break true;
+ } else false;
+ if (!elsewhere and !doc_typ.bound(c)) {
+ std.debug.print("tutor.txt: a chord on {u} (ctrl {} alt {} shift {}) is bound nowhere\n", .{ c.cp, c.ctrl, c.alt, c.shift });
+ return error.DocDrift;
+ }
+ }
+}
+
+test "reference.typ's #fstree is the tree the session serves, file for file" {
+ const tree = @import("ninep/tree.zig");
+ var arena: std.heap.ArenaAllocator = .init(std.testing.allocator);
+ defer arena.deinit();
+ const gpa = arena.allocator();
+ const io = std.testing.io;
+ var dir = try std.Io.Dir.cwd().openDir(io, @import("doc_typ").dir, .{});
+ defer dir.close(io);
+ const source = try dir.readFileAlloc(io, "reference.typ", gpa, .limited(1 << 20));
+ const open = "#fstree(```";
+ const start = (std.mem.indexOf(u8, source, open) orelse return error.NoFsTree) + open.len;
+ const end = std.mem.indexOfPos(u8, source, start, "```)") orelse return error.NoFsTree;
+
+ // what the reference draws: a path per line, from its indent
+ var drawn: std.StringArrayHashMapUnmanaged(void) = .empty;
+ var stack: [8][]const u8 = undefined;
+ var lines = std.mem.tokenizeScalar(u8, source[start..end], '\n');
+ while (lines.next()) |line| {
+ const body = std.mem.trimStart(u8, line, " ");
+ if (body.len == 0) continue;
+ const depth = (line.len - body.len) / 2;
+ const name = body[0 .. std.mem.indexOfScalar(u8, body, ' ') orelse body.len];
+ stack[depth] = name;
+ var path: std.ArrayList(u8) = .empty;
+ for (stack[0 .. depth + 1]) |part| try path.appendSlice(gpa, part);
+ try drawn.put(gpa, path.items, {});
+ }
+
+ // what the session serves: tree.zig's files, and fs.zig's os/ and src/
+ var served: std.StringArrayHashMapUnmanaged(void) = .empty;
+ for (std.enums.values(tree.TopFile)) |f| switch (f) {
+ .root => {},
+ .new => try served.put(gpa, "pane/new", {}),
+ else => try served.put(gpa, if (f.dir()) try std.fmt.allocPrint(gpa, "{s}/", .{f.fileName()}) else f.fileName(), {}),
+ };
+ try served.put(gpa, "os/", {});
+ try served.put(gpa, "src/", {});
+ try served.put(gpa, "pane/<n>/", {});
+ for (std.enums.values(tree.PaneFile)) |f| if (f != .dir) {
+ const under = if (f.inPty() and f != .pty) "pane/<n>/pty/" else "pane/<n>/";
+ try served.put(gpa, try std.fmt.allocPrint(gpa, "{s}{s}{s}", .{ under, f.fileName(), if (f.isDir()) "/" else "" }), {});
+ };
+ try served.put(gpa, "col/<n>/", {});
+ for (std.enums.values(tree.ColFile)) |f| if (f != .dir)
+ try served.put(gpa, try std.fmt.allocPrint(gpa, "col/<n>/{s}", .{f.fileName()}), {});
+
+ var drift = false;
+ for (served.keys()) |k| if (!drawn.contains(k)) {
+ std.debug.print("reference.typ's tree lacks {s}\n", .{k});
+ drift = true;
+ };
+ for (drawn.keys()) |k| if (!served.contains(k)) {
+ std.debug.print("reference.typ's tree has {s}, which the session does not serve\n", .{k});
+ drift = true;
+ };
+ if (drift) return error.FsTreeDrift;
+}
+
+test "CallstackDepth is bounded and keeps the last valid runtime limit" {
+ var state: Runtime = .{};
+ try std.testing.expectEqual(@as(u8, 8), state.callstack_depth);
+ for ([_][]const u8{ "1", "8", "16", "64" }) |value| {
+ try std.testing.expect(Runtime.apply(&state, Runtime.find("CallstackDepth").?, value));
+ try std.testing.expectEqual(try std.fmt.parseInt(u8, value, 10), state.callstack_depth);
+ }
+ for ([_][]const u8{ "0", "65", "256", "-1", "+8", "1_6", "eight", "" }) |value| {
+ try std.testing.expect(!Runtime.apply(&state, Runtime.find("CallstackDepth").?, value));
+ try std.testing.expectEqual(@as(u8, 64), state.callstack_depth);
+ }
+}