Skip to content

Commit

Permalink
Formats
Browse files Browse the repository at this point in the history
  • Loading branch information
@MasonRemaley
MasonRemaley committed Jun 12, 2024
1 parent 3081773 commit f56aa19
Show file tree
Hide file tree
Showing 4 changed files with 83 additions and 102 deletions.
2 changes: 1 addition & 1 deletion lib/std/zig/AstGen.zig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8619,7 +8619,7 @@ pub fn failWithNumberError(
err: std.zig.number_literal.Error,
token: Ast.TokenIndex,
bytes: []const u8,
) (Allocator.Error || error { AnalysisFail }) {
) (Allocator.Error || error{AnalysisFail}) {
const is_float = std.mem.indexOfScalar(u8, bytes, '.') != null;
switch (err) {
.leading_zero => if (is_float) {
Expand Down
96 changes: 52 additions & 44 deletions lib/std/zon/stringify.zig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ test "typeIsRecursive" {
}));
}

fn checkValueDepth(val: anytype, depth: usize) error { MaxDepth }!void {
fn checkValueDepth(val: anytype, depth: usize) error{MaxDepth}!void {
if (depth == 0) return error.MaxDepth;
const child_depth = depth - 1;

Expand Down Expand Up @@ -232,16 +232,16 @@ test "checkValueDepth" {
x: u32,
y: struct { x: u32 },
};
try expectValueDepthEquals(2, Union{.x = 1});
try expectValueDepthEquals(3, Union{.y = .{.x = 1 }});
try expectValueDepthEquals(2, Union{ .x = 1 });
try expectValueDepthEquals(3, Union{ .y = .{ .x = 1 } });

const Recurse = struct { r: ?*const @This() };
try expectValueDepthEquals(2, Recurse { .r = null });
try expectValueDepthEquals(5, Recurse { .r = &Recurse { .r = null } });
try expectValueDepthEquals(8, Recurse { .r = &Recurse { .r = &Recurse { .r = null }} });
try expectValueDepthEquals(2, Recurse{ .r = null });
try expectValueDepthEquals(5, Recurse{ .r = &Recurse{ .r = null } });
try expectValueDepthEquals(8, Recurse{ .r = &Recurse{ .r = &Recurse{ .r = null } } });

try expectValueDepthEquals(2, @as([]const u8, &.{1, 2, 3}));
try expectValueDepthEquals(3, @as([]const []const u8, &.{&.{1, 2, 3}}));
try expectValueDepthEquals(2, @as([]const u8, &.{ 1, 2, 3 }));
try expectValueDepthEquals(3, @as([]const []const u8, &.{&.{ 1, 2, 3 }}));
}

/// Lower level control over stringification, you can create a new instance with `stringifier`.
Expand Down Expand Up @@ -281,7 +281,7 @@ pub fn Stringifier(comptime Writer: type) type {
return struct {
const Self = @This();

pub const MaxDepthError = error { MaxDepth } || Writer.Error;
pub const MaxDepthError = error{MaxDepth} || Writer.Error;

options: StringifierOptions,
indent_level: u8,
Expand Down Expand Up @@ -374,10 +374,10 @@ pub fn Stringifier(comptime Writer: type) type {
} else {
// Decide which fields to emit
const fields, const skipped = if (options.emit_default_optional_fields) b: {
break :b .{ StructInfo.fields.len, [1]bool{false} ** StructInfo.fields.len};
break :b .{ StructInfo.fields.len, [1]bool{false} ** StructInfo.fields.len };
} else b: {
var fields = StructInfo.fields.len;
var skipped = [1]bool {false} ** StructInfo.fields.len;
var skipped = [1]bool{false} ** StructInfo.fields.len;
inline for (StructInfo.fields, &skipped) |field_info, *skip| {
if (field_info.default_value) |default_field_value_opaque| {
const field_value = @field(val, field_info.name);
Expand Down Expand Up @@ -523,7 +523,7 @@ pub fn Stringifier(comptime Writer: type) type {
///
/// Returns `error.InnerCarriageReturn` if `val` contains a CR not followed by a newline,
/// since multiline strings cannot represent CR without a following newline.
pub fn multilineString(self: *Self, val: []const u8, options: MultilineStringOptions) (Writer.Error || error { InnerCarriageReturn })!void {
pub fn multilineString(self: *Self, val: []const u8, options: MultilineStringOptions) (Writer.Error || error{InnerCarriageReturn})!void {
// Make sure the string does not contain any carriage returns not followed by a newline
var i: usize = 0;
while (i < val.len) : (i += 1) {
Expand Down Expand Up @@ -626,7 +626,7 @@ pub fn Stringifier(comptime Writer: type) type {

/// Serialize a field. Equivalent to calling `fieldPrefix` followed by `valueMaxDepth`.
pub fn fieldMaxDepth(self: *Tuple, val: anytype, options: StringifyValueOptions, depth: usize) MaxDepthError!void {
try self.container.fieldMaxDepth(null, val, options, depth);
try self.container.fieldMaxDepth(null, val, options, depth);
}

/// Serialize a field. Equivalent to calling `fieldPrefix` followed by `valueArbitraryDepth`.
Expand Down Expand Up @@ -1424,41 +1424,41 @@ test "stringify multiline strings" {
const writer = buf.writer();
var serializer = stringifier(writer, .{});

inline for (.{true, false}) |whitespace| {
inline for (.{ true, false }) |whitespace| {
serializer.options.whitespace = whitespace;

{
try serializer.multilineString("", .{.top_level = true});
try serializer.multilineString("", .{ .top_level = true });
try std.testing.expectEqualStrings("\\\\", buf.items);
buf.clearRetainingCapacity();
}

{
try serializer.multilineString("abc⚡", .{.top_level = true});
try serializer.multilineString("abc⚡", .{ .top_level = true });
try std.testing.expectEqualStrings("\\\\abc⚡", buf.items);
buf.clearRetainingCapacity();
}

{
try serializer.multilineString("abc⚡\ndef", .{.top_level = true});
try serializer.multilineString("abc⚡\ndef", .{ .top_level = true });
try std.testing.expectEqualStrings("\\\\abc⚡\n\\\\def", buf.items);
buf.clearRetainingCapacity();
}

{
try serializer.multilineString("abc⚡\r\ndef", .{.top_level = true});
try serializer.multilineString("abc⚡\r\ndef", .{ .top_level = true });
try std.testing.expectEqualStrings("\\\\abc⚡\n\\\\def", buf.items);
buf.clearRetainingCapacity();
}

{
try serializer.multilineString("\nabc⚡", .{.top_level = true});
try serializer.multilineString("\nabc⚡", .{ .top_level = true });
try std.testing.expectEqualStrings("\\\\\n\\\\abc⚡", buf.items);
buf.clearRetainingCapacity();
}

{
try serializer.multilineString("\r\nabc⚡", .{.top_level = true});
try serializer.multilineString("\r\nabc⚡", .{ .top_level = true });
try std.testing.expectEqualStrings("\\\\\n\\\\abc⚡", buf.items);
buf.clearRetainingCapacity();
}
Expand All @@ -1474,16 +1474,16 @@ test "stringify multiline strings" {
}

{
const str: []const u8 = &.{'a', '\r', 'c'};
const str: []const u8 = &.{ 'a', '\r', 'c' };
try serializer.string(str);
try std.testing.expectEqualStrings("\"a\\rc\"", buf.items);
buf.clearRetainingCapacity();
}

{
try std.testing.expectError(error.InnerCarriageReturn, serializer.multilineString(@as([]const u8, &.{'a', '\r', 'c'}), .{}));
try std.testing.expectError(error.InnerCarriageReturn, serializer.multilineString(@as([]const u8, &.{'a', '\r', 'c', '\n'}), .{}));
try std.testing.expectError(error.InnerCarriageReturn, serializer.multilineString(@as([]const u8, &.{'a', '\r', 'c', '\r', '\n'}), .{}));
try std.testing.expectError(error.InnerCarriageReturn, serializer.multilineString(@as([]const u8, &.{ 'a', '\r', 'c' }), .{}));
try std.testing.expectError(error.InnerCarriageReturn, serializer.multilineString(@as([]const u8, &.{ 'a', '\r', 'c', '\n' }), .{}));
try std.testing.expectError(error.InnerCarriageReturn, serializer.multilineString(@as([]const u8, &.{ 'a', '\r', 'c', '\r', '\n' }), .{}));
try std.testing.expectEqualStrings("", buf.items);
buf.clearRetainingCapacity();
}
Expand Down Expand Up @@ -1534,7 +1534,8 @@ test "stringify skip default fields" {
\\ 'd',
\\ },
\\}
, Struct{
,
Struct{
.y = 3,
.z = 4,
.inner1 = .{
Expand All @@ -1558,7 +1559,8 @@ test "stringify skip default fields" {
\\ 'b',
\\ 'd',
\\} }
, Struct{
,
Struct{
.y = 3,
.z = 4,
.inner1 = .{
Expand Down Expand Up @@ -1589,7 +1591,8 @@ test "stringify skip default fields" {
\\ 'd',
\\ },
\\}
, Struct{
,
Struct{
.y = 3,
.z = 4,
.inner1 = .{
Expand All @@ -1614,13 +1617,15 @@ test "stringify skip default fields" {
};
try expectStringifyEqual(
\\.{}
, DefaultStrings { .foo = "abc" },
.{.emit_default_optional_fields = false},
,
DefaultStrings{ .foo = "abc" },
.{ .emit_default_optional_fields = false },
);
try expectStringifyEqual(
\\.{ .foo = "abcd" }
, DefaultStrings { .foo = "abcd" },
.{.emit_default_optional_fields = false},
,
DefaultStrings{ .foo = "abcd" },
.{ .emit_default_optional_fields = false },
);
}

Expand All @@ -1646,32 +1651,32 @@ test "depth limits" {

// Max depth passing on recursive type
{
const maybe_recurse = Recurse { .r = &.{} };
const maybe_recurse = Recurse{ .r = &.{} };
try stringifyMaxDepth(maybe_recurse, .{}, buf.writer(), 2);
try std.testing.expectEqualStrings(".{ .r = &.{} }", buf.items);
buf.clearRetainingCapacity();
}

// Unchecked passing on recursive type
{
const maybe_recurse = Recurse { .r = &.{} };
const maybe_recurse = Recurse{ .r = &.{} };
try stringifyArbitraryDepth(maybe_recurse, .{}, buf.writer());
try std.testing.expectEqualStrings(".{ .r = &.{} }", buf.items);
buf.clearRetainingCapacity();
}

// Max depth failing on recursive type due to depth
{
var maybe_recurse = Recurse { .r = &.{} };
maybe_recurse.r = &.{ .{ .r = &.{} } };
var maybe_recurse = Recurse{ .r = &.{} };
maybe_recurse.r = &.{.{ .r = &.{} }};
try std.testing.expectError(error.MaxDepth, stringifyMaxDepth(maybe_recurse, .{}, buf.writer(), 2));
try std.testing.expectEqualStrings("", buf.items);
buf.clearRetainingCapacity();
}

// Same but for a slice
{
var temp: [1]Recurse = .{ .{ .r = &.{} } };
var temp: [1]Recurse = .{.{ .r = &.{} }};
const maybe_recurse: []const Recurse = &temp;

try std.testing.expectError(error.MaxDepth, stringifyMaxDepth(maybe_recurse, .{}, buf.writer(), 2));
Expand All @@ -1691,7 +1696,7 @@ test "depth limits" {

// A slice succeeding
{
var temp: [1]Recurse = .{ .{ .r = &.{} } };
var temp: [1]Recurse = .{.{ .r = &.{} }};
const maybe_recurse: []const Recurse = &temp;

try stringifyMaxDepth(maybe_recurse, .{}, buf.writer(), 3);
Expand All @@ -1711,7 +1716,7 @@ test "depth limits" {

// Max depth failing on recursive type due to recursion
{
var temp: [1]Recurse = .{ .{ .r = &.{} } };
var temp: [1]Recurse = .{.{ .r = &.{} }};
temp[0].r = &temp;
const maybe_recurse: []const Recurse = &temp;

Expand Down Expand Up @@ -1788,7 +1793,8 @@ test "stringify primitives" {
\\ .g = -inf,
\\ .h = nan,
\\}
, .{
,
.{
.a = @as(f128, 1.5), // Make sure explicit f128s work
.b = 1.0 / 3.0,
.c = std.math.pi,
Expand All @@ -1809,7 +1815,8 @@ test "stringify primitives" {
\\ .d = -680564733841876926926749214863536422912,
\\ .e = 0,
\\}
, .{
,
.{
.a = 18446744073709551616,
.b = -18446744073709551616,
.c = 680564733841876926926749214863536422912,
Expand All @@ -1827,7 +1834,8 @@ test "stringify primitives" {
\\ .d = {},
\\ .e = null,
\\}
, .{
,
.{
.a = true,
.b = false,
.c = .foo,
Expand All @@ -1839,15 +1847,15 @@ test "stringify primitives" {

const Struct = struct { x: f32, y: f32 };
try expectStringifyEqual(
".{ .a = .{ .x = 1, .y = 2 }, .b = null }"
, .{
".{ .a = .{ .x = 1, .y = 2 }, .b = null }",
.{
.a = @as(?Struct, .{ .x = 1, .y = 2 }),
.b = @as(?Struct, null),
},
.{},
);

const E = enum (u8) {
const E = enum(u8) {
foo,
bar,
};
Expand Down
Loading

0 comments on commit f56aa19

Please sign in to comment.