diff options
| author | Andrew Kelley <andrew@ziglang.org> | 2025-06-27 20:05:22 -0700 |
|---|---|---|
| committer | Andrew Kelley <andrew@ziglang.org> | 2025-07-07 22:43:51 -0700 |
| commit | 0e37ff0d591dd75ceec9208196bec29efaec607a (patch) | |
| tree | c126fa823a1f3864e9c363aac70e3a3db0219957 /lib/std/Build/Cache | |
| parent | 0b3f0124dc33403d329fb8ee63a93215d9af1f1e (diff) | |
| download | zig-0e37ff0d591dd75ceec9208196bec29efaec607a.tar.gz zig-0e37ff0d591dd75ceec9208196bec29efaec607a.zip | |
std.fmt: breaking API changes
added adapter to AnyWriter and GenericWriter to help bridge the gap
between old and new API
make std.testing.expectFmt work at compile-time
std.fmt no longer has a dependency on std.unicode. Formatted printing
was never properly unicode-aware. Now it no longer pretends to be.
Breakage/deprecations:
* std.fs.File.reader -> std.fs.File.deprecatedReader
* std.fs.File.writer -> std.fs.File.deprecatedWriter
* std.io.GenericReader -> std.io.Reader
* std.io.GenericWriter -> std.io.Writer
* std.io.AnyReader -> std.io.Reader
* std.io.AnyWriter -> std.io.Writer
* std.fmt.format -> std.fmt.deprecatedFormat
* std.fmt.fmtSliceEscapeLower -> std.ascii.hexEscape
* std.fmt.fmtSliceEscapeUpper -> std.ascii.hexEscape
* std.fmt.fmtSliceHexLower -> {x}
* std.fmt.fmtSliceHexUpper -> {X}
* std.fmt.fmtIntSizeDec -> {B}
* std.fmt.fmtIntSizeBin -> {Bi}
* std.fmt.fmtDuration -> {D}
* std.fmt.fmtDurationSigned -> {D}
* {} -> {f} when there is a format method
* format method signature
- anytype -> *std.io.Writer
- inferred error set -> error{WriteFailed}
- options -> (deleted)
* std.fmt.Formatted
- now takes context type explicitly
- no fmt string
Diffstat (limited to 'lib/std/Build/Cache')
| -rw-r--r-- | lib/std/Build/Cache/DepTokenizer.zig | 201 | ||||
| -rw-r--r-- | lib/std/Build/Cache/Directory.zig | 11 | ||||
| -rw-r--r-- | lib/std/Build/Cache/Path.zig | 45 |
3 files changed, 66 insertions, 191 deletions
diff --git a/lib/std/Build/Cache/DepTokenizer.zig b/lib/std/Build/Cache/DepTokenizer.zig index a515d8a1f7..8221f92dba 100644 --- a/lib/std/Build/Cache/DepTokenizer.zig +++ b/lib/std/Build/Cache/DepTokenizer.zig @@ -7,6 +7,7 @@ state: State = .lhs, const std = @import("std"); const testing = std.testing; const assert = std.debug.assert; +const Allocator = std.mem.Allocator; pub fn next(self: *Tokenizer) ?Token { var start = self.index; @@ -362,7 +363,7 @@ pub const Token = union(enum) { }; /// Resolve escapes in target or prereq. Only valid with .target_must_resolve or .prereq_must_resolve. - pub fn resolve(self: Token, writer: anytype) @TypeOf(writer).Error!void { + pub fn resolve(self: Token, gpa: Allocator, list: *std.ArrayListUnmanaged(u8)) error{OutOfMemory}!void { switch (self) { .target_must_resolve => |bytes| { var state: enum { start, escape, dollar } = .start; @@ -372,27 +373,27 @@ pub const Token = union(enum) { switch (c) { '\\' => state = .escape, '$' => state = .dollar, - else => try writer.writeByte(c), + else => try list.append(gpa, c), } }, .escape => { switch (c) { ' ', '#', '\\' => {}, '$' => { - try writer.writeByte('\\'); + try list.append(gpa, '\\'); state = .dollar; continue; }, - else => try writer.writeByte('\\'), + else => try list.append(gpa, '\\'), } - try writer.writeByte(c); + try list.append(gpa, c); state = .start; }, .dollar => { - try writer.writeByte('$'); + try list.append(gpa, '$'); switch (c) { '$' => {}, - else => try writer.writeByte(c), + else => try list.append(gpa, c), } state = .start; }, @@ -406,19 +407,19 @@ pub const Token = union(enum) { .start => { switch (c) { '\\' => state = .escape, - else => try writer.writeByte(c), + else => try list.append(gpa, c), } }, .escape => { switch (c) { ' ' => {}, '\\' => { - try writer.writeByte(c); + try list.append(gpa, c); continue; }, - else => try writer.writeByte('\\'), + else => try list.append(gpa, '\\'), } - try writer.writeByte(c); + try list.append(gpa, c); state = .start; }, } @@ -428,20 +429,20 @@ pub const Token = union(enum) { } } - pub fn printError(self: Token, writer: anytype) @TypeOf(writer).Error!void { + pub fn printError(self: Token, gpa: Allocator, list: *std.ArrayListUnmanaged(u8)) error{OutOfMemory}!void { switch (self) { .target, .target_must_resolve, .prereq, .prereq_must_resolve => unreachable, // not an error .incomplete_quoted_prerequisite, .incomplete_target, => |index_and_bytes| { - try writer.print("{s} '", .{self.errStr()}); + try list.print(gpa, "{s} '", .{self.errStr()}); if (self == .incomplete_target) { const tmp = Token{ .target_must_resolve = index_and_bytes.bytes }; - try tmp.resolve(writer); + try tmp.resolve(gpa, list); } else { - try printCharValues(writer, index_and_bytes.bytes); + try printCharValues(gpa, list, index_and_bytes.bytes); } - try writer.print("' at position {d}", .{index_and_bytes.index}); + try list.print(gpa, "' at position {d}", .{index_and_bytes.index}); }, .invalid_target, .bad_target_escape, @@ -450,9 +451,9 @@ pub const Token = union(enum) { .incomplete_escape, .expected_colon, => |index_and_char| { - try writer.writeAll("illegal char "); - try printUnderstandableChar(writer, index_and_char.char); - try writer.print(" at position {d}: {s}", .{ index_and_char.index, self.errStr() }); + try list.appendSlice(gpa, "illegal char "); + try printUnderstandableChar(gpa, list, index_and_char.char); + try list.print(gpa, " at position {d}: {s}", .{ index_and_char.index, self.errStr() }); }, } } @@ -1026,41 +1027,41 @@ fn depTokenizer(input: []const u8, expect: []const u8) !void { defer arena_allocator.deinit(); var it: Tokenizer = .{ .bytes = input }; - var buffer = std.ArrayList(u8).init(arena); - var resolve_buf = std.ArrayList(u8).init(arena); + var buffer: std.ArrayListUnmanaged(u8) = .empty; + var resolve_buf: std.ArrayListUnmanaged(u8) = .empty; var i: usize = 0; while (it.next()) |token| { - if (i != 0) try buffer.appendSlice("\n"); + if (i != 0) try buffer.appendSlice(arena, "\n"); switch (token) { .target, .prereq => |bytes| { - try buffer.appendSlice(@tagName(token)); - try buffer.appendSlice(" = {"); + try buffer.appendSlice(arena, @tagName(token)); + try buffer.appendSlice(arena, " = {"); for (bytes) |b| { - try buffer.append(printable_char_tab[b]); + try buffer.append(arena, printable_char_tab[b]); } - try buffer.appendSlice("}"); + try buffer.appendSlice(arena, "}"); }, .target_must_resolve => { - try buffer.appendSlice("target = {"); - try token.resolve(resolve_buf.writer()); + try buffer.appendSlice(arena, "target = {"); + try token.resolve(arena, &resolve_buf); for (resolve_buf.items) |b| { - try buffer.append(printable_char_tab[b]); + try buffer.append(arena, printable_char_tab[b]); } resolve_buf.items.len = 0; - try buffer.appendSlice("}"); + try buffer.appendSlice(arena, "}"); }, .prereq_must_resolve => { - try buffer.appendSlice("prereq = {"); - try token.resolve(resolve_buf.writer()); + try buffer.appendSlice(arena, "prereq = {"); + try token.resolve(arena, &resolve_buf); for (resolve_buf.items) |b| { - try buffer.append(printable_char_tab[b]); + try buffer.append(arena, printable_char_tab[b]); } resolve_buf.items.len = 0; - try buffer.appendSlice("}"); + try buffer.appendSlice(arena, "}"); }, else => { - try buffer.appendSlice("ERROR: "); - try token.printError(buffer.writer()); + try buffer.appendSlice(arena, "ERROR: "); + try token.printError(arena, &buffer); break; }, } @@ -1072,134 +1073,18 @@ fn depTokenizer(input: []const u8, expect: []const u8) !void { return; } - const out = std.fs.File.stderr().writer(); - - try out.writeAll("\n"); - try printSection(out, "<<<< input", input); - try printSection(out, "==== expect", expect); - try printSection(out, ">>>> got", buffer.items); - try printRuler(out); - - try testing.expect(false); -} - -fn printSection(out: anytype, label: []const u8, bytes: []const u8) !void { - try printLabel(out, label, bytes); - try hexDump(out, bytes); - try printRuler(out); - try out.writeAll(bytes); - try out.writeAll("\n"); -} - -fn printLabel(out: anytype, label: []const u8, bytes: []const u8) !void { - var buf: [80]u8 = undefined; - const text = try std.fmt.bufPrint(buf[0..], "{s} {d} bytes ", .{ label, bytes.len }); - try out.writeAll(text); - var i: usize = text.len; - const end = 79; - while (i < end) : (i += 1) { - try out.writeAll(&[_]u8{label[0]}); - } - try out.writeAll("\n"); -} - -fn printRuler(out: anytype) !void { - var i: usize = 0; - const end = 79; - while (i < end) : (i += 1) { - try out.writeAll("-"); - } - try out.writeAll("\n"); -} - -fn hexDump(out: anytype, bytes: []const u8) !void { - const n16 = bytes.len >> 4; - var line: usize = 0; - var offset: usize = 0; - while (line < n16) : (line += 1) { - try hexDump16(out, offset, bytes[offset..][0..16]); - offset += 16; - } - - const n = bytes.len & 0x0f; - if (n > 0) { - try printDecValue(out, offset, 8); - try out.writeAll(":"); - try out.writeAll(" "); - const end1 = @min(offset + n, offset + 8); - for (bytes[offset..end1]) |b| { - try out.writeAll(" "); - try printHexValue(out, b, 2); - } - const end2 = offset + n; - if (end2 > end1) { - try out.writeAll(" "); - for (bytes[end1..end2]) |b| { - try out.writeAll(" "); - try printHexValue(out, b, 2); - } - } - const short = 16 - n; - var i: usize = 0; - while (i < short) : (i += 1) { - try out.writeAll(" "); - } - if (end2 > end1) { - try out.writeAll(" |"); - } else { - try out.writeAll(" |"); - } - try printCharValues(out, bytes[offset..end2]); - try out.writeAll("|\n"); - offset += n; - } - - try printDecValue(out, offset, 8); - try out.writeAll(":"); - try out.writeAll("\n"); + try testing.expectEqualStrings(expect, buffer.items); } -fn hexDump16(out: anytype, offset: usize, bytes: []const u8) !void { - try printDecValue(out, offset, 8); - try out.writeAll(":"); - try out.writeAll(" "); - for (bytes[0..8]) |b| { - try out.writeAll(" "); - try printHexValue(out, b, 2); - } - try out.writeAll(" "); - for (bytes[8..16]) |b| { - try out.writeAll(" "); - try printHexValue(out, b, 2); - } - try out.writeAll(" |"); - try printCharValues(out, bytes); - try out.writeAll("|\n"); -} - -fn printDecValue(out: anytype, value: u64, width: u8) !void { - var buffer: [20]u8 = undefined; - const len = std.fmt.formatIntBuf(buffer[0..], value, 10, .lower, .{ .width = width, .fill = '0' }); - try out.writeAll(buffer[0..len]); -} - -fn printHexValue(out: anytype, value: u64, width: u8) !void { - var buffer: [16]u8 = undefined; - const len = std.fmt.formatIntBuf(buffer[0..], value, 16, .lower, .{ .width = width, .fill = '0' }); - try out.writeAll(buffer[0..len]); -} - -fn printCharValues(out: anytype, bytes: []const u8) !void { - for (bytes) |b| { - try out.writeAll(&[_]u8{printable_char_tab[b]}); - } +fn printCharValues(gpa: Allocator, list: *std.ArrayListUnmanaged(u8), bytes: []const u8) !void { + for (bytes) |b| try list.append(gpa, printable_char_tab[b]); } -fn printUnderstandableChar(out: anytype, char: u8) !void { +fn printUnderstandableChar(gpa: Allocator, list: *std.ArrayListUnmanaged(u8), char: u8) !void { if (std.ascii.isPrint(char)) { - try out.print("'{c}'", .{char}); + try list.print(gpa, "'{c}'", .{char}); } else { - try out.print("\\x{X:0>2}", .{char}); + try list.print(gpa, "\\x{X:0>2}", .{char}); } } diff --git a/lib/std/Build/Cache/Directory.zig b/lib/std/Build/Cache/Directory.zig index 4de1cc18f1..cc6b930c23 100644 --- a/lib/std/Build/Cache/Directory.zig +++ b/lib/std/Build/Cache/Directory.zig @@ -1,5 +1,6 @@ const Directory = @This(); const std = @import("../../std.zig"); +const assert = std.debug.assert; const fs = std.fs; const fmt = std.fmt; const Allocator = std.mem.Allocator; @@ -55,14 +56,8 @@ pub fn closeAndFree(self: *Directory, gpa: Allocator) void { self.* = undefined; } -pub fn format( - self: Directory, - comptime fmt_string: []const u8, - options: fmt.FormatOptions, - writer: anytype, -) !void { - _ = options; - if (fmt_string.len != 0) fmt.invalidFmtError(fmt_string, self); +pub fn format(self: Directory, writer: *std.io.Writer, comptime f: []const u8) std.io.Writer.Error!void { + comptime assert(f.len == 0); if (self.path) |p| { try writer.writeAll(p); try writer.writeAll(fs.path.sep_str); diff --git a/lib/std/Build/Cache/Path.zig b/lib/std/Build/Cache/Path.zig index 8822fb64be..55af4fdbfa 100644 --- a/lib/std/Build/Cache/Path.zig +++ b/lib/std/Build/Cache/Path.zig @@ -1,3 +1,10 @@ +const Path = @This(); +const std = @import("../../std.zig"); +const assert = std.debug.assert; +const fs = std.fs; +const Allocator = std.mem.Allocator; +const Cache = std.Build.Cache; + root_dir: Cache.Directory, /// The path, relative to the root dir, that this `Path` represents. /// Empty string means the root_dir is the path. @@ -133,38 +140,32 @@ pub fn makePath(p: Path, sub_path: []const u8) !void { } pub fn toString(p: Path, allocator: Allocator) Allocator.Error![]u8 { - return std.fmt.allocPrint(allocator, "{}", .{p}); + return std.fmt.allocPrint(allocator, "{f}", .{p}); } pub fn toStringZ(p: Path, allocator: Allocator) Allocator.Error![:0]u8 { - return std.fmt.allocPrintZ(allocator, "{}", .{p}); + return std.fmt.allocPrintSentinel(allocator, "{f}", .{p}, 0); } -pub fn format( - self: Path, - comptime fmt_string: []const u8, - options: std.fmt.FormatOptions, - writer: anytype, -) !void { - if (fmt_string.len == 1) { +pub fn format(self: Path, writer: *std.io.Writer, comptime f: []const u8) std.io.Writer.Error!void { + if (f.len == 1) { // Quote-escape the string. - const stringEscape = std.zig.stringEscape; - const f = switch (fmt_string[0]) { - 'q' => "", - '\'' => "\'", - else => @compileError("unsupported format string: " ++ fmt_string), + const zigEscape = switch (f[0]) { + 'q' => std.zig.stringEscape, + '\'' => std.zig.charEscape, + else => @compileError("unsupported format string: " ++ f), }; if (self.root_dir.path) |p| { - try stringEscape(p, f, options, writer); - if (self.sub_path.len > 0) try stringEscape(fs.path.sep_str, f, options, writer); + try zigEscape(p, writer); + if (self.sub_path.len > 0) try zigEscape(fs.path.sep_str, writer); } if (self.sub_path.len > 0) { - try stringEscape(self.sub_path, f, options, writer); + try zigEscape(self.sub_path, writer); } return; } - if (fmt_string.len > 0) - std.fmt.invalidFmtError(fmt_string, self); + if (f.len > 0) + std.fmt.invalidFmtError(f, self); if (std.fs.path.isAbsolute(self.sub_path)) { try writer.writeAll(self.sub_path); return; @@ -223,9 +224,3 @@ pub const TableAdapter = struct { return a.eql(b); } }; - -const Path = @This(); -const std = @import("../../std.zig"); -const fs = std.fs; -const Allocator = std.mem.Allocator; -const Cache = std.Build.Cache; |
