Commit e2b954c2738c683a85b864eb33530f0e3dbbc480 | zig

author	Martin Wickham <spexguy070@gmail.com> 2021-06-21 13:47:38-05:00
committer	Andrew Kelley <andrew@ziglang.org> 2021-07-08 14:30:45-04:00
log	e2b954c2738c683a85b864eb33530f0e3dbbc480
tree	47d90ba0a28ee7ce3e4e2f12b325567c31f307e2
parent	7bdeda82aea82b9a71378462f51a708b8ad88161

Add support for NO_COLOR

7 files changed, 42 insertions(+), 20 deletions(-)

lib
- std
  - debug.zig
  - process.zig
  - special
    build_runner.zig
src
- main.zig
- stage1

lib/std/debug.zig+4-4

 @@ -90,11 +90,11 @@ pub fn getSelfDebugInfo() !*DebugInfo {
 }
 pub fn detectTTYConfig() TTY.Config {
-    var bytes: [128]u8 = undefined;
+    if (process.hasEnvVarConstant("ZIG_DEBUG_COLOR")) {
-    const allocator = &std.heap.FixedBufferAllocator.init(bytes[0..]).allocator;
-    if (process.getEnvVarOwned(allocator, "ZIG_DEBUG_COLOR")) |_| {
         return .escape_codes;
-    } else |_| {
+    } else if (process.hasEnvVarConstant("NO_COLOR")) {
+        return .no_color;
+    } else {
         const stderr_file = io.getStdErr();
         if (stderr_file.supportsAnsiEscapeCodes()) {
             return .escape_codes;

lib/std/process.zig+20

...	@@ -179,6 +179,26 @@ pub fn getEnvVarOwned(allocator: *mem.Allocator, key: []const u8) GetEnvVarOwned	...	@@ -179,6 +179,26 @@ pub fn getEnvVarOwned(allocator: *mem.Allocator, key: []const u8) GetEnvVarOwned
179	}	179	}
180	}	180	}
181		181
		182	pub fn hasEnvVarConstant(comptime key: []const u8) bool {
		183	if (builtin.os.tag == .windows) {
		184	const key_w = comptime std.unicode.utf8ToUtf16LeStringLiteral(key);
		185	return std.os.getenvW(key_w) != null;
		186	} else {
		187	return os.getenv(key) != null;
		188	}
		189	}
		190
		191	pub fn hasEnvVar(allocator: *Allocator, key: []const u8) error{OutOfMemory}!bool {
		192	if (builtin.os.tag == .windows) {
		193	var stack_alloc = std.heap.stackFallback(256 * @sizeOf(u16), allocator);
		194	const key_w = try std.unicode.utf8ToUtf16LeWithNull(&stack_alloc.allocator, key);
		195	defer stack_alloc.allocator.free(key_w);
		196	return std.os.getenvW(key_w) != null;
		197	} else {
		198	return os.getenv(key) != null;
		199	}
		200	}
		201
182	test "os.getEnvVarOwned" {	202	test "os.getEnvVarOwned" {
183	var ga = std.testing.allocator;	203	var ga = std.testing.allocator;
184	try testing.expectError(error.EnvironmentVariableNotFound, getEnvVarOwned(ga, "BADENV"));	204	try testing.expectError(error.EnvironmentVariableNotFound, getEnvVarOwned(ga, "BADENV"));

lib/std/special/build_runner.zig+5

 @@ -63,6 +63,11 @@ pub fn main() !void {
     var install_prefix: ?[]const u8 = null;
     var dir_list = Builder.DirList{};
+    // before arg parsing, check for the NO_COLOR environment variable
+    // if it exists, default the color setting to .off
+    // explicit --color arguments will still override this setting.
+    builder.color = if (std.process.hasEnvVarConstant("NO_COLOR")) .off else .auto;
     while (nextArg(args, &arg_idx)) |arg| {
         if (mem.startsWith(u8, arg, "-D")) {
             const option_contents = arg[2..];

src/main.zig+7-11

 @@ -503,15 +503,6 @@ const Emit = union(enum) {
     }
 };
-fn optionalBoolEnvVar(arena: *Allocator, name: []const u8) !bool {
-    if (std.process.getEnvVarOwned(arena, name)) |_| {
-        return true;
-    } else |err| switch (err) {
-        error.EnvironmentVariableNotFound => return false,
-        else => |e| return e,
-    }
-}
 fn optionalStringEnvVar(arena: *Allocator, name: []const u8) !?[]const u8 {
     if (std.process.getEnvVarOwned(arena, name)) |value| {
         return value;
 @@ -548,8 +539,8 @@ fn buildOutputType(
     var single_threaded = false;
     var function_sections = false;
     var watch = false;
-    var verbose_link = try optionalBoolEnvVar(arena, "ZIG_VERBOSE_LINK");
+    var verbose_link = std.process.hasEnvVarConstant("ZIG_VERBOSE_LINK");
-    var verbose_cc = try optionalBoolEnvVar(arena, "ZIG_VERBOSE_CC");
+    var verbose_cc = std.process.hasEnvVarConstant("ZIG_VERBOSE_CC");
     var verbose_air = false;
     var verbose_llvm_ir = false;
     var verbose_cimport = false;
 @@ -670,6 +661,11 @@ fn buildOutputType(
     defer freePkgTree(gpa, &pkg_tree_root, false);
     var cur_pkg: *Package = &pkg_tree_root;
+    // before arg parsing, check for the NO_COLOR environment variable
+    // if it exists, default the color setting to .off
+    // explicit --color arguments will still override this setting.
+    color = if (std.process.hasEnvVarConstant("NO_COLOR")) .off else .auto;
     switch (arg_mode) {
         .build, .translate_c, .zig_test, .run => {
             var optimize_mode_string: ?[]const u8 = null;

src/stage1/errmsg.cpp+2-2

...	@@ -16,8 +16,8 @@ enum ErrType {	...	@@ -16,8 +16,8 @@ enum ErrType {
16	};	16	};
17		17
18	static void print_err_msg_type(ErrorMsg *err, ErrColor color, ErrType err_type) {	18	static void print_err_msg_type(ErrorMsg *err, ErrColor color, ErrType err_type) {
19	bool is_tty = os_stderr_tty();	19	bool supports_color = os_stderr_supports_color();
20	bool use_colors = color == ErrColorOn \|\| (color == ErrColorAuto && is_tty);	20	bool use_colors = color == ErrColorOn \|\| (color == ErrColorAuto && supports_color);
21		21
22	// Show the error location, if available	22	// Show the error location, if available
23	if (err->path != nullptr) {	23	if (err->path != nullptr) {

src/stage1/os.cpp+3-2

 @@ -834,13 +834,14 @@ static bool is_stderr_cyg_pty(void) {
 }
 #endif
-bool os_stderr_tty(void) {
+bool os_stderr_supports_color(void) {
+    if (getenv("NO_COLOR") != NULL) return false;
 #if defined(ZIG_OS_WINDOWS)
     return _isatty(_fileno(stderr)) != 0 || is_stderr_cyg_pty();
 #elif defined(ZIG_OS_POSIX)
     return isatty(STDERR_FILENO) != 0;
 #else
-#error "missing os_stderr_tty implementation"
+#error "missing os_stderr_supports_color implementation"
 #endif
 }

src/stage1/os.hpp+1-1

...	@@ -99,7 +99,7 @@ Error ATTRIBUTE_MUST_USE os_fetch_file_path(Buf full_path, Buf out_contents);	...	@@ -99,7 +99,7 @@ Error ATTRIBUTE_MUST_USE os_fetch_file_path(Buf full_path, Buf out_contents);
99		99
100	Error ATTRIBUTE_MUST_USE os_get_cwd(Buf *out_cwd);	100	Error ATTRIBUTE_MUST_USE os_get_cwd(Buf *out_cwd);
101		101
102	bool os_stderr_tty(void);	102	bool os_stderr_supports_color(void);
103	void os_stderr_set_color(TermColor color);	103	void os_stderr_set_color(TermColor color);
104		104
105	Error os_rename(Buf src_path, Buf dest_path);	105	Error os_rename(Buf src_path, Buf dest_path);