yves-biener/zterm
1
0
Fork 0
Code Issues Pull Requests Actions Wiki Activity

mod: adapt implementation to zig version 0.15.2
Some checks failed
Zig Project Action / Lint, Spell-check and test zig project (push) Failing after 54s
Details

Browse Source
This commit is contained in:
Yves Biener
2026-01-17 12:05:20 +01:00
parent e1e8907848
commit 4874252e8c
19 changed files with 339 additions and 392 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
examples/continuous.zig
View File

@@ -133,10 +133,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

10
examples/demo.zig
View File

@@ -1,5 +1,5 @@
const QuitText = struct {
const text = "Press ctrl+c to quit. Press ctrl+n to launch helix.";
const text = "Press ctrl+c to quit. Press ctrl+n to launch `vim`.";
pub fn element(this: *@This()) App.Element {
return .{ .ptr = this, .vtable = &.{ .content = content } };
@@ -31,10 +31,8 @@ pub fn main() !void {
defer if (gpa.deinit() == .leak) log.err("memory leak", .{});
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();
@@ -152,8 +150,8 @@ pub fn main() !void {
try app.interrupt();
renderer.size = .{}; // reset size, such that next resize will cause a full re-draw!
defer app.start() catch @panic("could not start app event loop");
var child = std.process.Child.init(&.{"hx"}, allocator);
_ = child.spawnAndWait(threaded_io.io()) catch |err| app.postEvent(.{
var child = std.process.Child.init(&.{"vim"}, allocator);
_ = child.spawnAndWait() catch |err| app.postEvent(.{
.err = .{
.err = err,
.msg = "Spawning $EDITOR failed",

5
examples/elements/alignment.zig
View File

@@ -32,10 +32,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/elements/button.zig
View File

@@ -82,10 +82,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/elements/input.zig
View File

@@ -65,10 +65,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/elements/progress.zig
View File

@@ -32,10 +32,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/elements/radio-button.zig
View File

@@ -32,10 +32,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/elements/scrollable.zig
View File

@@ -65,10 +65,7 @@ pub fn main() !void {
}
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/elements/selection.zig
View File

@@ -32,10 +32,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/errors.zig
View File

@@ -97,10 +97,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/layouts/grid.zig
View File

@@ -35,10 +35,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/layouts/horizontal.zig
View File

@@ -35,10 +35,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/layouts/mixed.zig
View File

@@ -35,10 +35,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/layouts/vertical.zig
View File

@@ -35,10 +35,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/styles/palette.zig
View File

@@ -32,10 +32,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

5
examples/styles/text.zig
View File

@@ -178,10 +178,7 @@ pub fn main() !void {
const allocator = gpa.allocator();
var threaded_io: std.Io.Threaded = .init(allocator, .{});
defer threaded_io.deinit();
var app: App = .init(threaded_io.ioBasic(), .{});
var app: App = .init(.{}, .{});
var renderer = zterm.Renderer.Buffered.init(allocator);
defer renderer.deinit();

33
src/app.zig
View File

@@ -27,14 +27,15 @@ pub fn App(comptime M: type, comptime E: type) type {
io: std.Io,
model: Model,
queue: Queue,
future: ?std.Io.Future(@typeInfo(@typeInfo(@TypeOf(run)).@"fn".return_type.?).error_union.error_set!void) = null,
thread: ?Thread = null,
quit_event: Thread.ResetEvent,
termios: ?posix.termios = null,
winch_registered: bool = false,
// global variable for the registered handler for WINCH
var handler_ctx: *anyopaque = undefined;
/// registered WINCH handler to report resize events
fn handleWinch(_: std.os.linux.SIG) callconv(.c) void {
fn handleWinch(_: i32) callconv(.c) void {
const this: *@This() = @ptrCast(@alignCast(handler_ctx));
// NOTE this does not have to be done if in-band resize events are supported
// -> the signal might not work correctly when hosting the application over ssh!
@@ -46,11 +47,12 @@ pub fn App(comptime M: type, comptime E: type) type {
.io = io,
.model = model,
.queue = .{},
.quit_event = .{},
};
}
pub fn start(this: *@This()) !void {
if (this.future) |_| return;
if (this.thread) |_| return;
// post init event (as the very first element to be in the queue - event loop)
this.postEvent(.init);
@@ -66,7 +68,8 @@ pub fn App(comptime M: type, comptime E: type) type {
this.winch_registered = true;
}
this.future = this.io.async(run, .{this});
this.quit_event.reset();
this.thread = try Thread.spawn(.{}, @This().run, .{this});
var termios: posix.termios = undefined;
try terminal.enableRawMode(&termios);
@@ -79,12 +82,13 @@ pub fn App(comptime M: type, comptime E: type) type {
}
pub fn interrupt(this: *@This()) !void {
this.quit_event.set();
try terminal.disableMouseSupport();
try terminal.restoreScreen();
try terminal.exitAltScreen();
if (this.future) |*future| {
future.cancel(this.io) catch {};
this.future = null;
if (this.thread) |*thread| {
thread.join();
this.thread = null;
}
}
@@ -104,10 +108,7 @@ pub fn App(comptime M: type, comptime E: type) type {
/// Quit the application loop.
/// This will cancel the internal input thread and post a **.quit** `Event`.
pub fn quit(this: *@This()) void {
if (this.future) |*future| {
future.cancel(this.io) catch {};
this.future = null;
}
this.quit_event.set();
this.postEvent(.quit);
}
@@ -146,17 +147,14 @@ pub fn App(comptime M: type, comptime E: type) type {
};
}
while (true) {
this.io.checkCancel() catch break;
this.quit_event.timedWait(20 * std.time.ns_per_ms) catch {
var remaining_bytes: usize = 0;
// non-blocking read
const read_bytes = terminal.read(buf[remaining_bytes..]) catch |err| switch (err) {
error.WouldBlock => {
// wait a bit
this.io.sleep(.fromMilliseconds(20), .awake) catch |e| switch (e) {
error.Canceled => break,
else => return e,
};
std.Thread.sleep(20);
continue;
},
else => return err,
@@ -425,6 +423,9 @@ pub fn App(comptime M: type, comptime E: type) type {
};
this.postEvent(.{ .key = key });
}
continue;
};
break;
}
}

60
src/event.zig
View File

@@ -46,44 +46,21 @@ pub fn mergeTaggedUnions(comptime A: type, comptime B: type) type {
const b_fields = @typeInfo(B).@"union".fields;
const b_fields_tag = @typeInfo(B).@"union".tag_type.?;
const b_enum_fields = @typeInfo(b_fields_tag).@"enum".fields;
var field_names: [a_fields.len + b_fields.len][:0]const u8 = undefined;
var field_types: [a_fields.len + b_fields.len]type = undefined;
var field_attributes: [a_fields.len + b_fields.len]std.builtin.Type.UnionField.Attributes = undefined;
var enum_names: [a_fields.len + b_fields.len][:0]const u8 = undefined;
const UEnumSize = blk: {
const total_size = a_fields.len + b_fields.len;
break :blk switch (total_size) {
1...2 => u1,
3...4 => u2,
5...8 => u4,
9...16 => u4,
17...32 => u5,
33...64 => u6,
65...128 => u7,
129...256 => u8,
else => u16, // should suffice
};
};
var enum_values: [a_fields.len + b_fields.len]UEnumSize = undefined;
var fields: [a_fields.len + b_fields.len]std.builtin.Type.UnionField = undefined;
var enum_fields: [a_fields.len + b_fields.len]std.builtin.Type.EnumField = undefined;
var i: usize = 0;
for (a_fields, a_enum_fields) |field, enum_field| {
field_names[i] = field.name;
field_types[i] = field.type;
field_attributes[i] = .{ .@"align" = field.alignment };
fields[i] = field;
var enum_f = enum_field;
enum_f.value = i;
enum_names[i] = enum_f.name;
enum_values[i] = enum_f.value;
enum_fields[i] = enum_f;
i += 1;
}
for (b_fields, b_enum_fields) |field, enum_field| {
field_names[i] = field.name;
field_types[i] = field.type;
field_attributes[i] = .{ .@"align" = field.alignment };
fields[i] = field;
var enum_f = enum_field;
enum_f.value = i;
enum_names[i] = enum_f.name;
enum_values[i] = enum_f.value;
enum_fields[i] = enum_f;
i += 1;
}
@@ -94,22 +71,35 @@ pub fn mergeTaggedUnions(comptime A: type, comptime B: type) type {
// user provided one)
const a_enum_decls = @typeInfo(A).@"union".decls;
const b_enum_decls = @typeInfo(B).@"union".decls;
var decl_names: [a_enum_decls.len + b_enum_decls.len]std.builtin.Type.Declaration = undefined;
var decls: [a_enum_decls.len + b_enum_decls.len]std.builtin.Type.Declaration = undefined;
var j: usize = 0;
for (a_enum_decls) |decl| {
decl_names[j] = decl.name;
decls[j] = decl;
j += 1;
}
for (b_enum_decls) |decl| {
decl_names[j] = decl.name;
decls[j] = decl;
j += 1;
}
const EventType = @Int(.unsigned, @bitSizeOf(@TypeOf(i)) - @clz(i));
const EventType = @Type(.{ .int = .{
.signedness = .unsigned,
.bits = @bitSizeOf(@TypeOf(i)) - @clz(i),
} });
const Event = @Enum(EventType, .exhaustive, enum_names[0..], enum_values[0..]);
const Event = @Type(.{ .@"enum" = .{
.tag_type = EventType,
.fields = enum_fields[0..],
.decls = &.{},
.is_exhaustive = true,
} });
return @Union(.auto, Event, field_names[0..], field_types[0..], field_attributes[0..]);
return @Type(.{ .@"union" = .{
.layout = .auto,
.tag_type = Event,
.fields = fields[0..],
.decls = &.{},
} });
}
/// Determine whether the provided type `T` is a tagged union: `union(enum)`.

11
src/testing.zig
View File

@@ -211,13 +211,16 @@ pub fn expectEqualCells(origin: Point, size: Point, expected: []const Cell, actu
if (!differ) return;
// test failed
var stdout_buffer: [1024]u8 = undefined;
const io = debug.lockStderr(&stdout_buffer);
defer debug.unlockStderr();
var buf: [1024]u8 = undefined;
const error_writer = &io.file_writer.interface;
std.debug.lockStdErr();
defer std.debug.unlockStdErr();
var buffer = std.fs.File.stderr().writer(&buf);
var error_writer = &buffer.interface;
try error_writer.writeAll(writer.buffer[0..writer.end]);
try error_writer.flush();
return error.TestExpectEqualCells;
}