this repo has no description
widgets: add TextView widget
The TextView widget provides a simple way to show text content in
a scrollable window.
This implementation does not offer automatic line wrapping for now.
Text content is backed by the Buffer struct. The buffer can be styled
for visually appealing and colorful content, for example to provide
a syntax highlighting.
The buffer provides a writer() interface which allows providing content
from a stream, such as logging.
authored by
Jari Vetoniemi
and committed by
Tim Culverhouse
84b4821d
b215aec7
+187
+1
src/widgets.zig
+1
src/widgets.zig
+186
src/widgets/TextView.zig
+186
src/widgets/TextView.zig
···
1
+
const std = @import("std");
2
+
const vaxis = @import("../main.zig");
3
+
const grapheme = @import("grapheme");
4
+
const DisplayWidth = @import("DisplayWidth");
5
+
const ScrollView = vaxis.widgets.ScrollView;
6
+
7
+
pub const BufferWriter = struct {
8
+
pub const Error = error{OutOfMemory};
9
+
pub const Writer = std.io.GenericWriter(@This(), Error, write);
10
+
11
+
allocator: std.mem.Allocator,
12
+
buffer: *Buffer,
13
+
gd: *const grapheme.GraphemeData,
14
+
wd: *const DisplayWidth.DisplayWidthData,
15
+
16
+
pub fn write(self: @This(), bytes: []const u8) Error!usize {
17
+
try self.buffer.append(self.allocator, .{
18
+
.bytes = bytes,
19
+
.gd = self.gd,
20
+
.wd = self.wd,
21
+
});
22
+
return bytes.len;
23
+
}
24
+
25
+
pub fn writer(self: @This()) Writer {
26
+
return .{ .context = self };
27
+
}
28
+
};
29
+
30
+
pub const Buffer = struct {
31
+
const StyleList = std.ArrayListUnmanaged(vaxis.Style);
32
+
const StyleMap = std.HashMapUnmanaged(usize, usize, std.hash_map.AutoContext(usize), std.hash_map.default_max_load_percentage);
33
+
34
+
pub const Content = struct {
35
+
bytes: []const u8,
36
+
gd: *const grapheme.GraphemeData,
37
+
wd: *const DisplayWidth.DisplayWidthData,
38
+
};
39
+
40
+
pub const Style = struct {
41
+
begin: usize,
42
+
end: usize,
43
+
style: vaxis.Style,
44
+
};
45
+
46
+
grapheme: std.MultiArrayList(grapheme.Grapheme) = .{},
47
+
content: std.ArrayListUnmanaged(u8) = .{},
48
+
style_list: StyleList = .{},
49
+
style_map: StyleMap = .{},
50
+
rows: usize = 0,
51
+
cols: usize = 0,
52
+
53
+
pub fn deinit(self: *@This(), allocator: std.mem.Allocator) void {
54
+
self.style_map.deinit(allocator);
55
+
self.style_list.deinit(allocator);
56
+
self.grapheme.deinit(allocator);
57
+
self.content.deinit(allocator);
58
+
self.* = undefined;
59
+
}
60
+
61
+
/// Clears all buffer data.
62
+
pub fn clear(self: *@This(), allocator: std.mem.Allocator) void {
63
+
self.deinit(allocator);
64
+
self.* = .{};
65
+
}
66
+
67
+
/// Replaces contents of the buffer, all previous buffer data is lost.
68
+
pub fn update(self: *@This(), allocator: std.mem.Allocator, content: Content) !void {
69
+
self.clear(allocator);
70
+
errdefer self.clear(allocator);
71
+
try self.append(allocator, content);
72
+
}
73
+
74
+
/// Appends content to the buffer.
75
+
pub fn append(self: *@This(), allocator: std.mem.Allocator, content: Content) !void {
76
+
var cols: usize = 0;
77
+
var iter = grapheme.Iterator.init(content.bytes, content.gd);
78
+
const dw: DisplayWidth = .{ .data = content.wd };
79
+
while (iter.next()) |g| {
80
+
try self.grapheme.append(allocator, .{
81
+
.len = g.len,
82
+
.offset = @as(u32, @intCast(self.content.items.len)) + g.offset,
83
+
});
84
+
const cluster = g.bytes(content.bytes);
85
+
if (std.mem.eql(u8, cluster, "\n")) {
86
+
self.cols = @max(self.cols, cols);
87
+
cols = 0;
88
+
continue;
89
+
}
90
+
cols +|= dw.strWidth(cluster);
91
+
}
92
+
try self.content.appendSlice(allocator, content.bytes);
93
+
self.cols = @max(self.cols, cols);
94
+
self.rows +|= std.mem.count(u8, content.bytes, "\n");
95
+
}
96
+
97
+
/// Clears all styling data.
98
+
pub fn clearStyle(self: *@This(), allocator: std.mem.Allocator) void {
99
+
self.style_list.deinit(allocator);
100
+
self.style_map.deinit(allocator);
101
+
}
102
+
103
+
/// Update style for range of the buffer contents.
104
+
pub fn updateStyle(self: *@This(), allocator: std.mem.Allocator, style: Style) !void {
105
+
const style_index = blk: {
106
+
for (self.style_list.items, 0..) |s, i| {
107
+
if (std.meta.eql(s, style.style)) {
108
+
break :blk i;
109
+
}
110
+
}
111
+
try self.style_list.append(allocator, style.style);
112
+
break :blk self.style_list.items.len - 1;
113
+
};
114
+
for (style.begin..style.end) |i| {
115
+
try self.style_map.put(allocator, i, style_index);
116
+
}
117
+
}
118
+
119
+
pub fn writer(
120
+
self: *@This(),
121
+
allocator: std.mem.Allocator,
122
+
gd: *const grapheme.GraphemeData,
123
+
wd: *const DisplayWidth.DisplayWidthData,
124
+
) BufferWriter.Writer {
125
+
return .{
126
+
.context = .{
127
+
.allocator = allocator,
128
+
.buffer = self,
129
+
.gd = gd,
130
+
.wd = wd,
131
+
},
132
+
};
133
+
}
134
+
};
135
+
136
+
scroll_view: ScrollView = .{},
137
+
138
+
pub fn input(self: *@This(), key: vaxis.Key) void {
139
+
self.scroll_view.input(key);
140
+
}
141
+
142
+
pub fn draw(self: *@This(), win: vaxis.Window, buffer: Buffer) void {
143
+
self.scroll_view.draw(win, .{ .cols = buffer.cols, .rows = buffer.rows });
144
+
const Pos = struct { x: usize = 0, y: usize = 0 };
145
+
var pos: Pos = .{};
146
+
var byte_index: usize = 0;
147
+
const bounds = self.scroll_view.bounds(win);
148
+
for (buffer.grapheme.items(.len), buffer.grapheme.items(.offset), 0..) |g_len, g_offset, index| {
149
+
if (bounds.above(pos.y)) {
150
+
break;
151
+
}
152
+
153
+
const cluster = buffer.content.items[g_offset..][0..g_len];
154
+
defer byte_index += cluster.len;
155
+
156
+
if (std.mem.eql(u8, cluster, "\n")) {
157
+
if (index == buffer.grapheme.len - 1) {
158
+
break;
159
+
}
160
+
pos.y +|= 1;
161
+
pos.x = 0;
162
+
continue;
163
+
} else if (bounds.below(pos.y)) {
164
+
continue;
165
+
}
166
+
167
+
const width = win.gwidth(cluster);
168
+
defer pos.x +|= width;
169
+
170
+
if (!bounds.colInside(pos.x)) {
171
+
continue;
172
+
}
173
+
174
+
const style: vaxis.Style = blk: {
175
+
if (buffer.style_map.get(byte_index)) |style_index| {
176
+
break :blk buffer.style_list.items[style_index];
177
+
}
178
+
break :blk .{};
179
+
};
180
+
181
+
self.scroll_view.writeCell(win, pos.x, pos.y, .{
182
+
.char = .{ .grapheme = cluster, .width = width },
183
+
.style = style,
184
+
});
185
+
}
186
+
}