Something went wrong. Try again.
A charm-like tui library
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179//! Animated spinner driven by a self-chaining tick Cmd. Pick from the//! presets (`Spinner.line`, `Spinner.dot`, etc.) or supply your own frames.//!//! Typical use: embed in a parent, return `spinner.start(gpa)` from the//! parent's init, forward updates that don't belong to you to//! `spinner.update`, and call `spinner.view(w)` from view.const std = @import("std");const tea = @import("blacktea");const matte = @import("matte");const util = @import("util.zig");
const t = std.testing;const Allocator = std.mem.Allocator;const Writer = std.Io.Writer;
const Spinner = @This();
const Frames = struct { slices: []const []const u8, fps_ns: u64,
pub const line: Frames = .{ .slices = &.{ "|", "/", "-", "\\" }, .fps_ns = std.time.ns_per_s / 10, };
pub const dot: Frames = .{ .slices = &.{ "⣾ ", "⣽ ", "⣻ ", "⢿ ", "⡿ ", "⣟ ", "⣯ ", "⣷ " }, .fps_ns = std.time.ns_per_s / 10, };
pub const mini_dot: Frames = .{ .slices = &.{ "⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏" }, .fps_ns = std.time.ns_per_s / 12, };
pub const jump: Frames = .{ .slices = &.{ "⢄", "⢂", "⢁", "⡁", "⡈", "⡐", "⡠" }, .fps_ns = std.time.ns_per_s / 10, };
pub const pulse: Frames = .{ .slices = &.{ "█", "▓", "▒", "░" }, .fps_ns = std.time.ns_per_s / 8, };
pub const points: Frames = .{ .slices = &.{ "∙∙∙", "●∙∙", "∙●∙", "∙∙●" }, .fps_ns = std.time.ns_per_s / 7, };
pub const globe: Frames = .{ .slices = &.{ "🌍", "🌎", "🌏" }, .fps_ns = std.time.ns_per_s / 4, };
pub const moon: Frames = .{ .slices = &.{ "🌑", "🌒", "🌓", "🌔", "🌕", "🌖", "🌗", "🌘" }, .fps_ns = std.time.ns_per_s / 8, };
pub const monkey: Frames = .{ .slices = &.{ "🙈", "🙉", "🙊" }, .fps_ns = std.time.ns_per_s / 3, };
pub const meter: Frames = .{ .slices = &.{ "▱▱▱", "▰▱▱", "▰▰▱", "▰▰▰", "▰▰▱", "▰▱▱", "▱▱▱" }, .fps_ns = std.time.ns_per_s / 7, };
pub const hamburger: Frames = .{ .slices = &.{ "☱", "☲", "☴", "☲" }, .fps_ns = std.time.ns_per_s / 3, };
pub const ellipsis: Frames = .{ .slices = &.{ " ", ". ", ".. ", "..." }, .fps_ns = std.time.ns_per_s / 3, };};
var tick_marker: u8 = 0;
fn tickTypeId() usize { return @intFromPtr(&tick_marker);}
frames: Frames = .line,style: matte.Style = .none,frame: usize = 0,running: bool = false,model: tea.Model = .{ .vtable = &.{ .init = vtableInit, .update = vtableUpdate, .view = vtableView, },},
fn vtableInit(m: *tea.Model) ?tea.Cmd { const self: *Spinner = @fieldParentPtr("model", m); return self.start(m.gpa);}
fn vtableUpdate(m: *tea.Model, msg: tea.Msg) ?tea.Cmd { const self: *Spinner = @fieldParentPtr("model", m); return self.update(m.gpa, msg);}
fn vtableView(m: *tea.Model, writer: *Writer) Writer.Error!tea.View { const self: *Spinner = @fieldParentPtr("model", m); try self.view(writer); return .{};}
/// Starts the spinner. No-op if already running.pub fn start(self: *Spinner, allocator: Allocator) ?tea.Cmd { if (self.running) return null; self.running = true; return self.scheduleTick(allocator);}
/// Stops the spinner. The next tick that arrives is ignored.pub fn stop(self: *Spinner) void { self.running = false;}
pub fn update(self: *Spinner, allocator: Allocator, msg: tea.Msg) ?tea.Cmd { switch (msg) { .custom => |c| { if (c.type_id != tickTypeId()) return null; if (!self.running) return null; self.frame = (self.frame + 1) % self.frames.slices.len; return self.scheduleTick(allocator); }, else => return null, }}
pub fn view(self: *const Spinner, writer: *Writer) Writer.Error!void { if (self.frames.slices.len == 0) return; const f = self.frames.slices[self.frame % self.frames.slices.len]; try util.writeInline(writer, self.style, f);}
fn scheduleTick(self: *Spinner, allocator: Allocator) ?tea.Cmd { return tea.Cmd.tick(allocator, self.frames.fps_ns, .{ .custom = .{ .type_id = tickTypeId() }, }) catch { self.running = false; return null; };}
test "start sets running" { var s: Spinner = .{}; const cmd = s.start(t.allocator); try t.expect(s.running); try t.expect(cmd != null); if (cmd) |c| if (c.free_ctx) |free| if (c.ctx) |ctx| free(t.allocator, ctx);}
test "stop clears running" { var s: Spinner = .{ .running = true }; s.stop(); try t.expect(!s.running);}
test "view writes current frame" { var buf: [16]u8 = undefined; var writer: Writer = .fixed(&buf); const s: Spinner = .{ .frames = .line }; try s.view(&writer); try t.expectEqualStrings("|", writer.buffered());}