字段
std.Io.Terminal.builtin
常量
std.Io.Terminal.Color
容器
字段
black
red
green
yellow
blue
magenta
cyan
white
bright_black
bright_red
bright_green
bright_yellow
bright_blue
bright_magenta
bright_cyan
bright_white
dim
bold
reset
std.Io.Terminal.File
别名
别名目标 std.Io.File
std.Io.Terminal.Io
别名
别名目标 std.Io
std.Io.Terminal.is_windows
常量
std.Io.Terminal.Mode
容器
字段
std.Io.Terminal.Mode.detect
函数
为给定文件检测合适的 TTY 配置选项,通常用于 stdout、stderr。
必要且可行时,尝试启用 ANSI 转义码支持。
NO_COLOR表示环境变量 "NO_COLOR" 是否 存在且非空。CLICOLOR_FORCE表示环境变量 "CLICOLOR_FORCE" 是否 存在且非空。
pub fn detect(io: Io, file: File, NO_COLOR: bool, CLICOLOR_FORCE: bool) Io.Cancelable!Mode
参数
错误
- Canceled
调用方请求停止异步操作。
std.Io.Terminal.Mode.WindowsApi
类型
std.Io.Terminal.setColor
函数
pub fn setColor(t: Terminal, color: Color) SetColorError!void
参数
错误
- Canceled Cancelable
调用方请求停止异步操作。
- Unexpected UnexpectedError
操作系统返回了未记录在文档中的错误码。
理论上不可能出现此错误,但处理 此错误优于触发未定义行为。
观察到此错误码时,通常意味着 Zig 标准 库需要小幅修补,将该错误码加入 相应函数的错误集合。
- WriteFailed Error
详细诊断信息见
Writer实现。
std.Io.Terminal.SetColorError
错误集合
错误
- Canceled Cancelable
调用方请求停止异步操作。
- Unexpected UnexpectedError
操作系统返回了未记录在文档中的错误码。
理论上不可能出现此错误,但处理 此错误优于触发未定义行为。
观察到此错误码时,通常意味着 Zig 标准 库需要小幅修补,将该错误码加入 相应函数的错误集合。
- WriteFailed Error
详细诊断信息见
Writer实现。
std.Io.Terminal.std
别名
别名目标 std
std.Io.Terminal.Terminal
别名
别名目标 std.Io.Terminal
源码
std/Io/Terminal.zig
/// 用于向可能支持终端转义码的流
/// 写入的抽象。
const Terminal = @This();
const builtin = @import("builtin");
const is_windows = builtin.os.tag == .windows;
const std = @import("std");
const Io = std.Io;
const File = std.Io.File;
writer: *Io.Writer,
mode: Mode,
pub const Color = enum {
black,
red,
green,
yellow,
blue,
magenta,
cyan,
white,
bright_black,
bright_red,
bright_green,
bright_yellow,
bright_blue,
bright_magenta,
bright_cyan,
bright_white,
dim,
bold,
reset,
};
pub const Mode = union(enum) {
no_color,
escape_codes,
windows_api: WindowsApi,
pub const WindowsApi = if (!is_windows) noreturn else struct {
io: Io,
file: File,
reset_attributes: u16,
};
/// 为给定文件检测合适的 TTY 配置选项,通常用于
/// stdout、stderr。
///
/// 必要且可行时,尝试启用 ANSI 转义码支持。
///
/// * `NO_COLOR` 表示环境变量 "NO_COLOR" 是否
/// 存在且非空。
/// * `CLICOLOR_FORCE` 表示环境变量 "CLICOLOR_FORCE" 是否
/// 存在且非空。
pub fn detect(io: Io, file: File, NO_COLOR: bool, CLICOLOR_FORCE: bool) Io.Cancelable!Mode {
const force_color: ?bool = if (NO_COLOR) false else if (CLICOLOR_FORCE) true else null;
if (force_color == false) return .no_color;
if (file.enableAnsiEscapeCodes(io)) |_| {
return .escape_codes;
} else |err| switch (err) {
error.Canceled => |e| return e,
error.NotTerminalDevice, error.Unexpected => {},
}
if (is_windows and try file.isTty(io)) {
var get_console_info = std.os.windows.CONSOLE.USER_IO.GET_SCREEN_BUFFER_INFO;
switch (try get_console_info.operate(io, file)) {
.SUCCESS => return .{ .windows_api = .{
.io = io,
.file = file,
.reset_attributes = get_console_info.Data.wAttributes,
} },
else => {},
}
}
return if (force_color == true) .escape_codes else .no_color;
}
};
pub const SetColorError = Io.Cancelable || Io.UnexpectedError || Io.Writer.Error;
pub fn setColor(t: Terminal, color: Color) SetColorError!void {
switch (t.mode) {
.no_color => return,
.escape_codes => {
const color_string = switch (color) {
.black => "\x1b[30m",
.red => "\x1b[31m",
.green => "\x1b[32m",
.yellow => "\x1b[33m",
.blue => "\x1b[34m",
.magenta => "\x1b[35m",
.cyan => "\x1b[36m",
.white => "\x1b[37m",
.bright_black => "\x1b[90m",
.bright_red => "\x1b[91m",
.bright_green => "\x1b[92m",
.bright_yellow => "\x1b[93m",
.bright_blue => "\x1b[94m",
.bright_magenta => "\x1b[95m",
.bright_cyan => "\x1b[96m",
.bright_white => "\x1b[97m",
.bold => "\x1b[1m",
.dim => "\x1b[2m",
.reset => "\x1b[0m",
};
try t.writer.writeAll(color_string);
},
.windows_api => |wa| {
const windows = std.os.windows;
const attributes: windows.WORD = switch (color) {
.black => 0,
.red => windows.FOREGROUND_RED,
.green => windows.FOREGROUND_GREEN,
.yellow => windows.FOREGROUND_RED | windows.FOREGROUND_GREEN,
.blue => windows.FOREGROUND_BLUE,
.magenta => windows.FOREGROUND_RED | windows.FOREGROUND_BLUE,
.cyan => windows.FOREGROUND_GREEN | windows.FOREGROUND_BLUE,
.white => windows.FOREGROUND_RED | windows.FOREGROUND_GREEN | windows.FOREGROUND_BLUE,
.bright_black => windows.FOREGROUND_INTENSITY,
.bright_red => windows.FOREGROUND_RED | windows.FOREGROUND_INTENSITY,
.bright_green => windows.FOREGROUND_GREEN | windows.FOREGROUND_INTENSITY,
.bright_yellow => windows.FOREGROUND_RED | windows.FOREGROUND_GREEN | windows.FOREGROUND_INTENSITY,
.bright_blue => windows.FOREGROUND_BLUE | windows.FOREGROUND_INTENSITY,
.bright_magenta => windows.FOREGROUND_RED | windows.FOREGROUND_BLUE | windows.FOREGROUND_INTENSITY,
.bright_cyan => windows.FOREGROUND_GREEN | windows.FOREGROUND_BLUE | windows.FOREGROUND_INTENSITY,
.bright_white, .bold => windows.FOREGROUND_RED | windows.FOREGROUND_GREEN | windows.FOREGROUND_BLUE | windows.FOREGROUND_INTENSITY,
// 基本字符属性不支持“dim”,但仍让它产生*某种*效果。
// 这与加入明亮变体之前 TTY.Color 的旧行为一致。
.dim => windows.FOREGROUND_INTENSITY,
.reset => wa.reset_attributes,
};
try t.writer.flush();
var set_text_attribute = windows.CONSOLE.USER_IO.SET_TEXT_ATTRIBUTE(attributes);
switch (try set_text_attribute.operate(wa.io, wa.file)) {
.SUCCESS => {},
else => |status| return windows.unexpectedStatus(status),
}
},
}
}