tiny.smg.cli.output

1const std = @import("std");2const alloc = @import("alloc");3const pretty = @import("pretty");4const pretty_usage = @import("pretty_usage");56pub const stale_source_head_message = "Error: .smg/ changed while this command was running. No update was applied; retry the command.\n";78pub fn writeOut(data: []const u8) !u8 {9    var stdout_buffer: [4096]u8 = undefined;10    var stdout = std.Io.File.stdout().writer(std.Options.debug_io, &stdout_buffer);11    try pretty.write(&stdout.interface, .{ .text = data }, .{ .width = 88 });12    try stdout.interface.flush();13    return 0;14}1516pub fn writeOutFmt(allocator: std.mem.Allocator, comptime fmt: []const u8, args: anytype) !u8 {17    return try writeOut(try std.fmt.allocPrint(allocator, fmt, args));18}1920pub fn writeErr(data: []const u8) !void {21    var stderr_buffer: [4096]u8 = undefined;22    var stderr = std.Io.File.stderr().writer(std.Options.debug_io, &stderr_buffer);23    try pretty.write(&stderr.interface, .{ .text = data }, .{ .width = 88 });24    try stderr.interface.flush();25}2627pub fn writeErrFmt(allocator: std.mem.Allocator, comptime fmt: []const u8, args: anytype) !void {28    const text_value = try std.fmt.allocPrint(allocator, fmt, args);29    defer allocator.free(text_value);30    try writeErr(text_value);31}3233pub fn writeStaleSourceHead() !void {34    try writeErr(stale_source_head_message);35}3637pub fn writeByteLimitExceeded(38    allocator: std.mem.Allocator,39    limit_name: []const u8,40    value: usize,41    option: []const u8,42) !u8 {43    try writeErrFmt(44        allocator,45        "Error: {s} is {d} bytes. Raise it with {s} SIZE.\n",46        .{ limit_name, value, option },47    );48    return 2;49}5051pub fn writeWrappedError(allocator: std.mem.Allocator, message: []const u8) !void {52    const text_value = try std.fmt.allocPrint(allocator, "Error: {s}", .{message});53    defer allocator.free(text_value);54    var out: std.Io.Writer.Allocating = .init(allocator);55    defer out.deinit();56    var words = std.mem.tokenizeScalar(u8, text_value, ' ');57    var width: usize = 0;58    while (words.next()) |word| {59        if (width == 0) {60            try out.writer.writeAll(word);61            width = word.len;62        } else if (width + 1 + word.len > 80) {63            if (width < 80) try out.writer.writeByte(' ');64            try out.writer.writeByte('\n');65            try out.writer.writeAll(word);66            width = word.len;67        } else {68            try out.writer.writeByte(' ');69            try out.writer.writeAll(word);70            width += 1 + word.len;71        }72    }73    try out.writer.writeByte('\n');74    try writeErr(out.written());75}7677pub fn writeProcessError(err: anyerror) void {78    pretty_usage.Terminal.stderr(alloc.standaloneProcessAllocator(), .{}).writeErrorTextFmt("smg", "{s}", .{@errorName(err)}) catch {};79}8081pub fn writeNoSuchOption(allocator: std.mem.Allocator, command: []const u8, signature: []const u8, option: []const u8) !void {82    try writeClickUsageError(allocator, command, signature, try std.fmt.allocPrint(allocator, "No such option: {s}", .{option}));83}8485pub fn writeClickUsageError(allocator: std.mem.Allocator, command: []const u8, signature: []const u8, message: []const u8) !void {86    var out: std.Io.Writer.Allocating = .init(allocator);87    const usage_width = clickUsageLineWidth(command);88    try writePaddedAsciiLine(&out.writer, "", 80);89    try writePaddedAsciiLine(&out.writer, try std.fmt.allocPrint(allocator, " Usage: smg {s} {s}", .{ command, signature }), usage_width);90    try writePaddedAsciiLine(&out.writer, "", 80);91    try writePaddedAsciiLine(&out.writer, try std.fmt.allocPrint(allocator, " Try 'smg {s} --help' for help", .{command}), usage_width);92    try writeBoxTop(&out.writer, "Error", 80);93    try writeBoxLine(&out.writer, message, 80);94    try writeBoxBottom(&out.writer, 80);95    try writePaddedAsciiLine(&out.writer, "", 80);96    try writeErr(out.written());97}9899pub fn clickUsageLineWidth(command: []const u8) usize {100    return if (std.mem.eql(u8, command, "blame")) 70 else 80;101}102103pub fn writeRootUsageError(allocator: std.mem.Allocator, command_name: []const u8, message: []const u8) !void {104    var out: std.Io.Writer.Allocating = .init(allocator);105    try writePaddedAsciiLine(&out.writer, "", 80);106    try writePaddedAsciiLine(&out.writer, try std.fmt.allocPrint(allocator, " Usage: {s} [OPTIONS] COMMAND [ARGS]...", .{command_name}), 80);107    try writePaddedAsciiLine(&out.writer, "", 80);108    try writePaddedAsciiLine(&out.writer, try std.fmt.allocPrint(allocator, " Try '{s} --help' for help", .{command_name}), 80);109    try writeBoxTop(&out.writer, "Error", 80);110    try writeBoxLine(&out.writer, message, 80);111    try writeBoxBottom(&out.writer, 80);112    try writePaddedAsciiLine(&out.writer, "", 80);113    try writeErr(out.written());114}115116pub fn writeClickBoxError(allocator: std.mem.Allocator, message: []const u8) !void {117    var out: std.Io.Writer.Allocating = .init(allocator);118    try writeBoxTop(&out.writer, "Error", 80);119    try writeBoxLine(&out.writer, message, 80);120    try writeBoxBottom(&out.writer, 80);121    try writePaddedAsciiLine(&out.writer, "", 80);122    try writeErr(out.written());123}124125pub fn writeDocText(writer: *std.Io.Writer, value: []const u8) !void {126    try pretty.write(writer, .{ .text = value }, .{ .width = 88 });127}128129pub fn helpColorMode() pretty.ColorMode {130    return pretty_usage.terminalColorMode(std.Io.File.stdout());131}132133pub fn writeStyledText(writer: *std.Io.Writer, style: pretty.Style, value: []const u8, mode: pretty.ColorMode) !void {134    const text_doc = pretty.Doc{ .text = value };135    const styled_doc = pretty.Doc{ .styled = .{ .style = style, .doc = &text_doc } };136    try pretty.write(writer, styled_doc, .{ .width = 88, .color = mode });137}138139const box_rule_glyph = "\xE2\x94\x80";140const box_rule_capacity = 96;141142fn boxRule(buffer: *[box_rule_capacity * box_rule_glyph.len]u8, count: usize) []const u8 {143    std.debug.assert(count <= box_rule_capacity);144    for (0..count) |index| {145        @memcpy(buffer[index * box_rule_glyph.len ..][0..box_rule_glyph.len], box_rule_glyph);146    }147    return buffer[0 .. count * box_rule_glyph.len];148}149150pub fn writeStyledBoxTop(writer: *std.Io.Writer, title: []const u8, width: usize, mode: pretty.ColorMode) !void {151    var rule_buffer: [box_rule_capacity * box_rule_glyph.len]u8 = undefined;152    try writeStyledText(writer, .muted, "\xE2\x95\xAD\xE2\x94\x80 ", mode);153    try writeStyledText(writer, .title, title, mode);154    try writeStyledText(writer, .muted, " ", mode);155    try writeStyledText(writer, .muted, boxRule(&rule_buffer, width - title.len - 5), mode);156    try writeStyledText(writer, .muted, "\xE2\x95\xAE", mode);157    try writeDocHardline(writer);158}159160pub fn writeStyledBoxLineDisplay(writer: *std.Io.Writer, message: []const u8, width: usize, mode: pretty.ColorMode) !void {161    try writeStyledText(writer, .muted, "\xE2\x94\x82 ", mode);162    try writeBoxRowContent(writer, message, mode);163    try writeSpacesDoc(writer, width -| displayWidth(message) -| 3);164    try writeStyledText(writer, .muted, "\xE2\x94\x82", mode);165    try writeDocHardline(writer);166}167168fn writeBoxRowContent(writer: *std.Io.Writer, message: []const u8, mode: pretty.ColorMode) !void {169    const name_len = boxRowNameLength(message);170    if (name_len == 0) {171        try writeDocText(writer, message);172        return;173    }174    const style: pretty.Style = if (message[0] == '-') .type_name else .name;175    try writeStyledText(writer, style, message[0..name_len], mode);176    try writeDocText(writer, message[name_len..]);177}178179fn boxRowNameLength(message: []const u8) usize {180    if (message.len == 0 or message[0] == ' ') return 0;181    var index: usize = 0;182    while (index + 1 < message.len) : (index += 1) {183        if (message[index] == ' ' and message[index + 1] == ' ') return index;184    }185    return 0;186}187188pub fn writeStyledBoxBottom(writer: *std.Io.Writer, width: usize, mode: pretty.ColorMode) !void {189    var rule_buffer: [box_rule_capacity * box_rule_glyph.len]u8 = undefined;190    try writeStyledText(writer, .muted, "\xE2\x95\xB0", mode);191    try writeStyledText(writer, .muted, boxRule(&rule_buffer, width - 2), mode);192    try writeStyledText(writer, .muted, "\xE2\x95\xAF", mode);193    try writeDocHardline(writer);194}195196pub fn writeStyledUsageLine(writer: *std.Io.Writer, label: []const u8, rest: []const u8, width: usize, mode: pretty.ColorMode) !void {197    try writeDocText(writer, " ");198    try writeStyledText(writer, .keyword, label, mode);199    try writeStyledText(writer, .source, rest, mode);200    const used = 1 + displayWidth(label) + displayWidth(rest);201    try writeSpacesDoc(writer, width -| used);202    try writeDocHardline(writer);203}204205pub fn writeDocHardline(writer: *std.Io.Writer) !void {206    try pretty.write(writer, pretty.hardline, .{ .width = 88 });207}208209pub fn writeSpacesDoc(writer: *std.Io.Writer, count: usize) !void {210    var rest = count;211    var spaces: [128]u8 = undefined;212    @memset(&spaces, ' ');213    while (rest != 0) {214        const chunk = @min(rest, spaces.len);215        try writeDocText(writer, spaces[0..chunk]);216        rest -= chunk;217    }218}219220pub fn writeRepeatedDoc(writer: *std.Io.Writer, value: []const u8, count: usize) !void {221    for (0..count) |_| try writeDocText(writer, value);222}223224pub fn writePaddedAsciiLine(writer: *std.Io.Writer, value: []const u8, width: usize) !void {225    try writeDocText(writer, value);226    try writeSpacesDoc(writer, width -| value.len);227    try writeDocHardline(writer);228}229230pub fn writePaddedDisplayLine(writer: *std.Io.Writer, value: []const u8, width: usize) !void {231    try writeDocText(writer, value);232    try writeSpacesDoc(writer, width -| displayWidth(value));233    try writeDocHardline(writer);234}235236pub fn writeBoxTop(writer: *std.Io.Writer, title: []const u8, width: usize) !void {237    try writeDocText(writer, "\xE2\x95\xAD\xE2\x94\x80 ");238    try writeDocText(writer, title);239    try writeDocText(writer, " ");240    try writeRepeatedDoc(writer, "\xE2\x94\x80", width - title.len - 5);241    try writeDocText(writer, "\xE2\x95\xAE");242    try writeDocHardline(writer);243}244245pub fn writeBoxLine(writer: *std.Io.Writer, message: []const u8, width: usize) !void {246    try writeDocText(writer, "\xE2\x94\x82 ");247    try writeDocText(writer, message);248    try writeSpacesDoc(writer, width -| message.len -| 3);249    try writeDocText(writer, "\xE2\x94\x82");250    try writeDocHardline(writer);251}252253pub fn writeBoxLineDisplay(writer: *std.Io.Writer, message: []const u8, width: usize) !void {254    try writeDocText(writer, "\xE2\x94\x82 ");255    try writeDocText(writer, message);256    try writeSpacesDoc(writer, width -| displayWidth(message) -| 3);257    try writeDocText(writer, "\xE2\x94\x82");258    try writeDocHardline(writer);259}260261pub fn writeBoxBottom(writer: *std.Io.Writer, width: usize) !void {262    try writeDocText(writer, "\xE2\x95\xB0");263    try writeRepeatedDoc(writer, "\xE2\x94\x80", width - 2);264    try writeDocText(writer, "\xE2\x95\xAF");265    try writeDocHardline(writer);266}267268pub fn displayWidth(value: []const u8) usize {269    var width: usize = 0;270    var index: usize = 0;271    while (index < value.len) {272        const byte = value[index];273        if (byte < 0x80) {274            width += 1;275            index += 1;276            continue;277        }278        const sequence_len = std.unicode.utf8ByteSequenceLength(byte) catch 1;279        width += 1;280        index += @min(sequence_len, value.len - index);281    }282    return width;283}284285test "display width counts utf8 codepoints" {286    try std.testing.expectEqual(@as(usize, 5), displayWidth("abcde"));287    try std.testing.expectEqual(@as(usize, 5), displayWidth("a\xE2\x80\x94bcd"));288}289290test "usage error width preserves blame compatibility" {291    try std.testing.expectEqual(@as(usize, 70), clickUsageLineWidth("blame"));292    try std.testing.expectEqual(@as(usize, 80), clickUsageLineWidth("context"));293}

1pub const output = @import("output.zig");