1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
|
//! Markdown rendering for the TUI.
//!
//! Parsing is delegated to MD4C (a small C CommonMark parser). This module is
//! only the terminal renderer: it turns MD4C's block/span/text callbacks into
//! ANSI-styled, width-bounded lines for panto components.
const std = @import("std");
const theme = @import("tui_theme.zig");
const c = @cImport({
@cInclude("md4c.h");
});
const Allocator = std.mem.Allocator;
/// Return the largest prefix that is safe to render while markdown is still
/// streaming. Avoid rendering an unterminated trailing line (which may still
/// become a heading/list/code fence/etc.) and avoid entering an unclosed fenced
/// code block.
pub fn streamingSafeCut(buffer: []const u8) []const u8 {
if (buffer.len == 0) return buffer[0..0];
const last_nl = std.mem.lastIndexOfScalar(u8, buffer, '\n') orelse return buffer[0..0];
var safe = buffer[0 .. last_nl + 1];
var in_fence = false;
var fence_char: u8 = 0;
var fence_len: usize = 0;
var line_start: usize = 0;
while (line_start < safe.len) {
var line_end = line_start;
while (line_end < safe.len and safe[line_end] != '\n') line_end += 1;
const line = std.mem.trimStart(u8, safe[line_start..line_end], " \t");
if (line.len >= 3 and (line[0] == '`' or line[0] == '~')) {
var n: usize = 0;
while (n < line.len and line[n] == line[0]) n += 1;
if (n >= 3) {
if (!in_fence) {
in_fence = true;
fence_char = line[0];
fence_len = n;
} else if (line[0] == fence_char and n >= fence_len) {
in_fence = false;
}
}
}
line_start = if (line_end < safe.len) line_end + 1 else safe.len;
}
if (!in_fence) return safe;
// If a fence is open, render only through the line before its opener.
var opener: usize = 0;
line_start = 0;
while (line_start < safe.len) {
var line_end = line_start;
while (line_end < safe.len and safe[line_end] != '\n') line_end += 1;
const line = std.mem.trimStart(u8, safe[line_start..line_end], " \t");
if (line.len >= 3 and line[0] == fence_char) {
var n: usize = 0;
while (n < line.len and line[n] == fence_char) n += 1;
if (n >= fence_len) opener = line_start;
}
line_start = if (line_end < safe.len) line_end + 1 else safe.len;
}
return safe[0..opener];
}
fn isAnsiAt(s: []const u8, i: usize) bool {
return i + 1 < s.len and s[i] == '\x1b' and s[i + 1] == '[';
}
fn skipAnsi(s: []const u8, start_i: usize) usize {
var i = start_i + 2;
while (i < s.len) : (i += 1) {
const ch = s[i];
if (ch >= '@' and ch <= '~') return i + 1;
}
return s.len;
}
fn visibleWidth(s: []const u8) usize {
var w: usize = 0;
var i: usize = 0;
while (i < s.len) {
if (isAnsiAt(s, i)) { i = skipAnsi(s, i); continue; }
const n = std.unicode.utf8ByteSequenceLength(s[i]) catch 1;
i += @min(n, s.len - i);
w += 1;
}
return w;
}
fn takeVisible(s: []const u8, max: usize) usize {
var w: usize = 0;
var i: usize = 0;
while (i < s.len) {
if (isAnsiAt(s, i)) { i = skipAnsi(s, i); continue; }
const n = std.unicode.utf8ByteSequenceLength(s[i]) catch 1;
const adv = @min(n, s.len - i);
if (w + 1 > max) break;
i += adv;
w += 1;
}
return i;
}
/// ANSI-aware greedy wrapping. The input may contain CSI styling escapes.
pub fn wrapStyled(buf: []const u8, width: usize, out: *std.ArrayList(u8), alloc: Allocator) !void {
const w = @max(width, 1);
var line_start: usize = 0;
while (line_start <= buf.len) {
const nl = std.mem.indexOfScalarPos(u8, buf, line_start, '\n') orelse buf.len;
var rest = buf[line_start..nl];
while (visibleWidth(rest) > w) {
var cut = takeVisible(rest, w);
if (cut < rest.len) {
if (std.mem.lastIndexOfScalar(u8, rest[0..cut], ' ')) |sp| {
if (sp > 0) cut = sp;
}
}
try out.appendSlice(alloc, rest[0..cut]);
try out.append(alloc, '\n');
rest = std.mem.trimStart(u8, rest[cut..], " ");
}
try out.appendSlice(alloc, rest);
if (nl == buf.len) break;
try out.append(alloc, '\n');
line_start = nl + 1;
}
}
pub const Renderer = struct {
alloc: Allocator,
width: usize,
out_lines: *std.ArrayList([]const u8),
buf: std.ArrayList(u8) = .empty,
in_code_block: bool = false,
list_depth: usize = 0,
heading_level: usize = 0,
err: ?anyerror = null,
pub fn render(self: *Renderer, src: []const u8) !void {
self.buf = .empty;
defer self.buf.deinit(self.alloc);
self.err = null;
var parser: c.MD_PARSER = std.mem.zeroes(c.MD_PARSER);
parser.abi_version = 0;
parser.flags = c.MD_FLAG_TABLES | c.MD_FLAG_STRIKETHROUGH | c.MD_FLAG_PERMISSIVEURLAUTOLINKS;
parser.enter_block = enterBlock;
parser.leave_block = leaveBlock;
parser.enter_span = enterSpan;
parser.leave_span = leaveSpan;
parser.text = textCb;
const rc = c.md_parse(src.ptr, @intCast(src.len), &parser, self);
if (self.err) |e| return e;
if (rc != 0) return error.MarkdownParseFailed;
try self.flushParagraph();
while (self.out_lines.items.len > 0 and self.out_lines.items[self.out_lines.items.len - 1].len == 0) {
const last = self.out_lines.pop().?;
self.alloc.free(last);
}
}
fn add(self: *Renderer, s: []const u8) !void { try self.buf.appendSlice(self.alloc, s); }
fn appendLine(self: *Renderer, s: []const u8) !void {
const line = try self.alloc.dupe(u8, s);
errdefer self.alloc.free(line);
try self.out_lines.append(self.alloc, line);
}
fn appendBlank(self: *Renderer) !void {
if (self.out_lines.items.len == 0) return;
if (self.out_lines.items[self.out_lines.items.len - 1].len == 0) return;
try self.appendLine("");
}
fn flushParagraph(self: *Renderer) !void {
const text = std.mem.trim(u8, self.buf.items, " \t\n");
if (text.len == 0) { self.buf.clearRetainingCapacity(); return; }
var wrapped: std.ArrayList(u8) = .empty;
defer wrapped.deinit(self.alloc);
try wrapStyled(text, self.width, &wrapped, self.alloc);
var it = std.mem.splitScalar(u8, wrapped.items, '\n');
while (it.next()) |line| try self.appendLine(line);
self.buf.clearRetainingCapacity();
}
fn flushCodeBlock(self: *Renderer) !void {
const code = theme.default.fg(.tool_header);
var it = std.mem.splitScalar(u8, self.buf.items, '\n');
while (it.next()) |line| {
if (line.len == 0) continue;
var tmp: std.ArrayList(u8) = .empty;
defer tmp.deinit(self.alloc);
try tmp.appendSlice(self.alloc, code.open());
try tmp.appendSlice(self.alloc, " ");
try tmp.appendSlice(self.alloc, line);
try tmp.appendSlice(self.alloc, code.close());
try self.appendLine(tmp.items);
}
self.buf.clearRetainingCapacity();
}
fn fail(self: *Renderer, e: anyerror) c_int { self.err = e; return 1; }
fn enterBlock(t: c.MD_BLOCKTYPE, detail: ?*anyopaque, userdata: ?*anyopaque) callconv(.c) c_int {
const self: *Renderer = @ptrCast(@alignCast(userdata.?));
switch (t) {
c.MD_BLOCK_H => {
self.flushParagraph() catch |e| return self.fail(e);
const d: *c.MD_BLOCK_H_DETAIL = @ptrCast(@alignCast(detail.?));
self.heading_level = @intCast(d.level);
self.add(theme.default.fg(.welcome).open()) catch |e| return self.fail(e);
var i: usize = 0; while (i < self.heading_level) : (i += 1) self.add("#") catch |e| return self.fail(e);
self.add(" ") catch |e| return self.fail(e);
},
c.MD_BLOCK_P => {},
c.MD_BLOCK_CODE => { self.in_code_block = true; self.buf.clearRetainingCapacity(); },
c.MD_BLOCK_UL, c.MD_BLOCK_OL => self.list_depth += 1,
c.MD_BLOCK_LI => {
self.flushParagraph() catch |e| return self.fail(e);
self.add("• ") catch |e| return self.fail(e);
},
c.MD_BLOCK_HR => self.appendLine("────────") catch |e| return self.fail(e),
else => {},
}
return 0;
}
fn leaveBlock(t: c.MD_BLOCKTYPE, detail: ?*anyopaque, userdata: ?*anyopaque) callconv(.c) c_int {
_ = detail;
const self: *Renderer = @ptrCast(@alignCast(userdata.?));
switch (t) {
c.MD_BLOCK_H => {
self.add(theme.default.fg(.welcome).close()) catch |e| return self.fail(e);
self.flushParagraph() catch |e| return self.fail(e);
self.appendBlank() catch |e| return self.fail(e);
self.heading_level = 0;
},
c.MD_BLOCK_P, c.MD_BLOCK_LI => {
self.flushParagraph() catch |e| return self.fail(e);
},
c.MD_BLOCK_CODE => {
self.flushCodeBlock() catch |e| return self.fail(e);
self.appendBlank() catch |e| return self.fail(e);
self.in_code_block = false;
},
c.MD_BLOCK_UL, c.MD_BLOCK_OL => {
if (self.list_depth > 0) self.list_depth -= 1;
},
else => {},
}
return 0;
}
fn enterSpan(t: c.MD_SPANTYPE, detail: ?*anyopaque, userdata: ?*anyopaque) callconv(.c) c_int {
_ = detail;
const self: *Renderer = @ptrCast(@alignCast(userdata.?));
const s = switch (t) {
c.MD_SPAN_STRONG => "\x1b[1m",
c.MD_SPAN_EM => "\x1b[3m",
c.MD_SPAN_CODE => theme.default.fg(.tool_header).open(),
c.MD_SPAN_A => "\x1b[4m",
c.MD_SPAN_DEL => "\x1b[9m",
else => "",
};
self.add(s) catch |e| return self.fail(e);
return 0;
}
fn leaveSpan(t: c.MD_SPANTYPE, detail: ?*anyopaque, userdata: ?*anyopaque) callconv(.c) c_int {
_ = t; _ = detail;
const self: *Renderer = @ptrCast(@alignCast(userdata.?));
self.add(theme.reset) catch |e| return self.fail(e);
return 0;
}
fn textCb(t: c.MD_TEXTTYPE, p: [*c]const u8, size: c.MD_SIZE, userdata: ?*anyopaque) callconv(.c) c_int {
const self: *Renderer = @ptrCast(@alignCast(userdata.?));
const s = p[0..@intCast(size)];
switch (t) {
c.MD_TEXT_BR, c.MD_TEXT_SOFTBR => self.add(" ") catch |e| return self.fail(e),
c.MD_TEXT_NULLCHAR => self.add("�") catch |e| return self.fail(e),
c.MD_TEXT_ENTITY => self.add(decodeEntity(s)) catch |e| return self.fail(e),
else => self.add(s) catch |e| return self.fail(e),
}
return 0;
}
};
fn decodeEntity(s: []const u8) []const u8 {
if (std.mem.eql(u8, s, "&")) return "&";
if (std.mem.eql(u8, s, "<")) return "<";
if (std.mem.eql(u8, s, ">")) return ">";
if (std.mem.eql(u8, s, """)) return "\"";
if (std.mem.eql(u8, s, "'")) return "'";
return s;
}
const testing = std.testing;
test "streamingSafeCut waits for newline" {
try testing.expectEqualStrings("", streamingSafeCut("hello"));
try testing.expectEqualStrings("foo\n", streamingSafeCut("foo\nbar"));
}
test "wrapStyled wraps plain text" {
var out: std.ArrayList(u8) = .empty;
defer out.deinit(testing.allocator);
try wrapStyled("the quick brown fox", 10, &out, testing.allocator);
try testing.expectEqualStrings("the quick\nbrown fox", out.items);
}
test "Renderer uses MD4C for common markdown" {
var out: std.ArrayList([]const u8) = .empty;
defer {
for (out.items) |l| testing.allocator.free(l);
out.deinit(testing.allocator);
}
var r: Renderer = .{ .alloc = testing.allocator, .width = 80, .out_lines = &out };
try r.render("# Heading\n\ncode `x` and **bold** and *italic* and [a](u).\n\n```zig\nfn main() {}\n```\n");
try testing.expect(out.items.len > 3);
try testing.expect(std.mem.indexOf(u8, out.items[0], "Heading") != null);
var found_code = false;
for (out.items) |l| {
if (std.mem.indexOf(u8, l, "fn main") != null) found_code = true;
}
try testing.expect(found_code);
}
|