authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2020-02-02 15:27:53-05:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2020-02-02 15:27:53-05:00
loga795c36d7b299f8167fbeb8a650e7477b5390be8
treedf67cfa147e0531ad23f15ea4a32a2ed0be37519
parent32291ab70249c874e6941292de8611e619c838e5
parente548195fd5ddedb5b2d87ef4b396666917e6d9b6
signaturebadge-question-mark Signed by PGP key 4AEE18F83AFDEB23

Merge pull request #4352 from LemonBoy/fix-4349

fmt: Respect trailing commas in field declarations

11 files changed, 157 insertions(+), 75 deletions(-)

lib/std/c/parse.zig-1
......@@ -1428,4 +1428,3 @@ const Parser = struct {
14281428 });
14291429 }
14301430};
1431
lib/std/c/tokenizer.zig+1-1
......@@ -631,7 +631,7 @@ pub const Tokenizer = struct {
631631 },
632632 .BackSlashCr => switch (c) {
633633 '\n' => {
634 state = .Start;
634 state = .Start;
635635 },
636636 else => {
637637 result.id = .Invalid;
lib/std/hash/benchmark.zig+2-2
......@@ -250,13 +250,13 @@ pub fn main() !void {
250250 if (H.has_iterative_api) {
251251 prng.seed(seed);
252252 const result = try benchmarkHash(H, count);
253 try stdout.print(" iterative: {:4} MiB/s [{x:0<16}]\n", .{result.throughput / (1 * MiB), result.hash});
253 try stdout.print(" iterative: {:4} MiB/s [{x:0<16}]\n", .{ result.throughput / (1 * MiB), result.hash });
254254 }
255255
256256 if (!test_iterative_only) {
257257 prng.seed(seed);
258258 const result_small = try benchmarkHashSmallKeys(H, key_size, count);
259 try stdout.print(" small keys: {:4} MiB/s [{x:0<16}]\n", .{result_small.throughput / (1 * MiB), result_small.hash});
259 try stdout.print(" small keys: {:4} MiB/s [{x:0<16}]\n", .{ result_small.throughput / (1 * MiB), result_small.hash });
260260 }
261261 }
262262 }
lib/std/os/uefi.zig+2-1
......@@ -40,7 +40,8 @@ pub const Guid = extern struct {
4040 self.time_mid,
4141 self.time_high_and_version,
4242 self.clock_seq_high_and_reserved,
43 self.clock_seq_low, self.node,
43 self.clock_seq_low,
44 self.node,
4445 });
4546 } else {
4647 @compileError("Unknown format character: '" ++ f ++ "'");
lib/std/os/windows/bits.zig+7-13
......@@ -928,10 +928,7 @@ pub usingnamespace switch (builtin.arch) {
928928 SegSs: DWORD,
929929 ExtendedRegisters: [512]BYTE,
930930
931 pub fn getRegs(ctx: *const CONTEXT) struct {
932 bp: usize,
933 ip: usize,
934 } {
931 pub fn getRegs(ctx: *const CONTEXT) struct { bp: usize, ip: usize } {
935932 return .{ .bp = ctx.Ebp, .ip = ctx.Eip };
936933 }
937934 };
......@@ -1034,10 +1031,7 @@ pub usingnamespace switch (builtin.arch) {
10341031 LastExceptionToRip: DWORD64,
10351032 LastExceptionFromRip: DWORD64,
10361033
1037 pub fn getRegs(ctx: *const CONTEXT) struct {
1038 bp: usize,
1039 ip: usize,
1040 } {
1034 pub fn getRegs(ctx: *const CONTEXT) struct { bp: usize, ip: usize } {
10411035 return .{ .bp = ctx.Rbp, .ip = ctx.Rip };
10421036 }
10431037 };
......@@ -1105,11 +1099,11 @@ pub usingnamespace switch (builtin.arch) {
11051099 Wcr: [2]DWORD,
11061100 Wvr: [2]DWORD64,
11071101
1108 pub fn getRegs(ctx: *const CONTEXT) struct {
1109 bp: usize,
1110 ip: usize,
1111 } {
1112 return .{ .bp = ctx.DUMMYUNIONNAME.DUMMYSTRUCTNAME.Fp, .ip = ctx.Pc };
1102 pub fn getRegs(ctx: *const CONTEXT) struct { bp: usize, ip: usize } {
1103 return .{
1104 .bp = ctx.DUMMYUNIONNAME.DUMMYSTRUCTNAME.Fp,
1105 .ip = ctx.Pc,
1106 };
11131107 }
11141108 };
11151109
lib/std/zig/ast.zig+11
......@@ -10,6 +10,7 @@ pub const TokenIndex = usize;
1010pub const Tree = struct {
1111 source: []const u8,
1212 tokens: TokenList,
13
1314 /// undefined on parse error (errors not empty)
1415 root_node: *Node.Root,
1516 arena_allocator: std.heap.ArenaAllocator,
......@@ -780,6 +781,11 @@ pub const Node = struct {
780781 i -= 1;
781782 }
782783
784 if (self.align_expr) |align_expr| {
785 if (i < 1) return align_expr;
786 i -= 1;
787 }
788
783789 if (self.value_expr) |value_expr| {
784790 if (i < 1) return value_expr;
785791 i -= 1;
......@@ -796,6 +802,11 @@ pub const Node = struct {
796802 if (self.value_expr) |value_expr| {
797803 return value_expr.lastToken();
798804 }
805 if (self.align_expr) |align_expr| {
806 // The expression refers to what's inside the parenthesis, the
807 // last token is the closing one
808 return align_expr.lastToken() + 1;
809 }
799810 if (self.type_expr) |type_expr| {
800811 return type_expr.lastToken();
801812 }
lib/std/zig/parser_test.zig+23-14
......@@ -1,3 +1,23 @@
1test "zig fmt: trailing comma in container declaration" {
2 try testCanonical(
3 \\const X = struct { foo: i32 };
4 \\const X = struct { foo: i32, bar: i32 };
5 \\const X = struct { foo: i32 = 1, bar: i32 = 2 };
6 \\const X = struct { foo: i32 align(4), bar: i32 align(4) };
7 \\const X = struct { foo: i32 align(4) = 1, bar: i32 align(4) = 2 };
8 \\
9 );
10 try testTransform(
11 \\const X = struct {
12 \\ foo: i32, bar: i8 };
13 ,
14 \\const X = struct {
15 \\ foo: i32, bar: i8
16 \\};
17 \\
18 );
19}
20
121test "zig fmt: trailing comma in fn parameter list" {
222 try testCanonical(
323 \\pub fn f(
......@@ -727,10 +747,7 @@ test "zig fmt: enum decl with no trailing comma" {
727747 try testTransform(
728748 \\const StrLitKind = enum {Normal, C};
729749 ,
730 \\const StrLitKind = enum {
731 \\ Normal,
732 \\ C,
733 \\};
750 \\const StrLitKind = enum { Normal, C };
734751 \\
735752 );
736753}
......@@ -984,16 +1001,10 @@ test "zig fmt: empty block with only comment" {
9841001}
9851002
9861003test "zig fmt: no trailing comma on struct decl" {
987 try testTransform(
1004 try testCanonical(
9881005 \\const RoundParam = struct {
9891006 \\ k: usize, s: u32, t: u32
9901007 \\};
991 ,
992 \\const RoundParam = struct {
993 \\ k: usize,
994 \\ s: u32,
995 \\ t: u32,
996 \\};
9971008 \\
9981009 );
9991010}
......@@ -2560,10 +2571,8 @@ test "zig fmt: if type expr" {
25602571 );
25612572}
25622573test "zig fmt: file ends with struct field" {
2563 try testTransform(
2574 try testCanonical(
25642575 \\a: bool
2565 ,
2566 \\a: bool,
25672576 \\
25682577 );
25692578}
lib/std/zig/perf_test.zig+1-1
......@@ -25,7 +25,7 @@ pub fn main() !void {
2525
2626 var stdout_file = std.io.getStdOut();
2727 const stdout = &stdout_file.outStream().stream;
28 try stdout.print("{:.3} MiB/s, {} KiB used \n", .{mb_per_sec, memory_used / 1024});
28 try stdout.print("{:.3} MiB/s, {} KiB used \n", .{ mb_per_sec, memory_used / 1024 });
2929}
3030
3131fn testOnce() usize {
lib/std/zig/render.zig+108-40
......@@ -206,6 +206,10 @@ fn renderExtraNewline(tree: *ast.Tree, stream: var, start_col: *usize, node: *as
206206}
207207
208208fn renderTopLevelDecl(allocator: *mem.Allocator, stream: var, tree: *ast.Tree, indent: usize, start_col: *usize, decl: *ast.Node) (@TypeOf(stream).Child.Error || Error)!void {
209 try renderContainerDecl(allocator, stream, tree, indent, start_col, decl, .Newline);
210}
211
212fn renderContainerDecl(allocator: *mem.Allocator, stream: var, tree: *ast.Tree, indent: usize, start_col: *usize, decl: *ast.Node, space: Space) (@TypeOf(stream).Child.Error || Error)!void {
209213 switch (decl.id) {
210214 .FnProto => {
211215 const fn_proto = @fieldParentPtr(ast.Node.FnProto, "base", decl);
......@@ -213,11 +217,11 @@ fn renderTopLevelDecl(allocator: *mem.Allocator, stream: var, tree: *ast.Tree, i
213217 try renderDocComments(tree, stream, fn_proto, indent, start_col);
214218
215219 if (fn_proto.body_node) |body_node| {
216 try renderExpression(allocator, stream, tree, indent, start_col, decl, Space.Space);
217 try renderExpression(allocator, stream, tree, indent, start_col, body_node, Space.Newline);
220 try renderExpression(allocator, stream, tree, indent, start_col, decl, .Space);
221 try renderExpression(allocator, stream, tree, indent, start_col, body_node, space);
218222 } else {
219 try renderExpression(allocator, stream, tree, indent, start_col, decl, Space.None);
220 try renderToken(tree, stream, tree.nextToken(decl.lastToken()), indent, start_col, Space.Newline);
223 try renderExpression(allocator, stream, tree, indent, start_col, decl, .None);
224 try renderToken(tree, stream, tree.nextToken(decl.lastToken()), indent, start_col, space);
221225 }
222226 },
223227
......@@ -225,11 +229,11 @@ fn renderTopLevelDecl(allocator: *mem.Allocator, stream: var, tree: *ast.Tree, i
225229 const use_decl = @fieldParentPtr(ast.Node.Use, "base", decl);
226230
227231 if (use_decl.visib_token) |visib_token| {
228 try renderToken(tree, stream, visib_token, indent, start_col, Space.Space); // pub
232 try renderToken(tree, stream, visib_token, indent, start_col, .Space); // pub
229233 }
230 try renderToken(tree, stream, use_decl.use_token, indent, start_col, Space.Space); // usingnamespace
231 try renderExpression(allocator, stream, tree, indent, start_col, use_decl.expr, Space.None);
232 try renderToken(tree, stream, use_decl.semicolon_token, indent, start_col, Space.Newline); // ;
234 try renderToken(tree, stream, use_decl.use_token, indent, start_col, .Space); // usingnamespace
235 try renderExpression(allocator, stream, tree, indent, start_col, use_decl.expr, .None);
236 try renderToken(tree, stream, use_decl.semicolon_token, indent, start_col, space); // ;
233237 },
234238
235239 .VarDecl => {
......@@ -243,9 +247,9 @@ fn renderTopLevelDecl(allocator: *mem.Allocator, stream: var, tree: *ast.Tree, i
243247 const test_decl = @fieldParentPtr(ast.Node.TestDecl, "base", decl);
244248
245249 try renderDocComments(tree, stream, test_decl, indent, start_col);
246 try renderToken(tree, stream, test_decl.test_token, indent, start_col, Space.Space);
247 try renderExpression(allocator, stream, tree, indent, start_col, test_decl.name, Space.Space);
248 try renderExpression(allocator, stream, tree, indent, start_col, test_decl.body_node, Space.Newline);
250 try renderToken(tree, stream, test_decl.test_token, indent, start_col, .Space);
251 try renderExpression(allocator, stream, tree, indent, start_col, test_decl.name, .Space);
252 try renderExpression(allocator, stream, tree, indent, start_col, test_decl.body_node, space);
249253 },
250254
251255 .ContainerField => {
......@@ -253,62 +257,76 @@ fn renderTopLevelDecl(allocator: *mem.Allocator, stream: var, tree: *ast.Tree, i
253257
254258 try renderDocComments(tree, stream, field, indent, start_col);
255259 if (field.comptime_token) |t| {
256 try renderToken(tree, stream, t, indent, start_col, Space.Space); // comptime
260 try renderToken(tree, stream, t, indent, start_col, .Space); // comptime
257261 }
258262
263 const src_has_trailing_comma = blk: {
264 const maybe_comma = tree.nextToken(field.lastToken());
265 break :blk tree.tokens.at(maybe_comma).id == .Comma;
266 };
267
268 // The trailing comma is emitted at the end, but if it's not present
269 // we still have to respect the specified `space` parameter
270 const last_token_space: Space = if (src_has_trailing_comma) .None else space;
271
259272 if (field.type_expr == null and field.value_expr == null) {
260 return renderToken(tree, stream, field.name_token, indent, start_col, Space.Comma); // name,
273 try renderToken(tree, stream, field.name_token, indent, start_col, last_token_space); // name
261274 } else if (field.type_expr != null and field.value_expr == null) {
262 try renderToken(tree, stream, field.name_token, indent, start_col, Space.None); // name
263 try renderToken(tree, stream, tree.nextToken(field.name_token), indent, start_col, Space.Space); // :
275 try renderToken(tree, stream, field.name_token, indent, start_col, .None); // name
276 try renderToken(tree, stream, tree.nextToken(field.name_token), indent, start_col, .Space); // :
264277
265278 if (field.align_expr) |align_value_expr| {
266 try renderExpression(allocator, stream, tree, indent, start_col, field.type_expr.?, Space.Space); // type
279 try renderExpression(allocator, stream, tree, indent, start_col, field.type_expr.?, .Space); // type
267280 const lparen_token = tree.prevToken(align_value_expr.firstToken());
268281 const align_kw = tree.prevToken(lparen_token);
269282 const rparen_token = tree.nextToken(align_value_expr.lastToken());
270 try renderToken(tree, stream, align_kw, indent, start_col, Space.None); // align
271 try renderToken(tree, stream, lparen_token, indent, start_col, Space.None); // (
272 try renderExpression(allocator, stream, tree, indent, start_col, align_value_expr, Space.None); // alignment
273 try renderToken(tree, stream, rparen_token, indent, start_col, Space.Comma); // ),
283 try renderToken(tree, stream, align_kw, indent, start_col, .None); // align
284 try renderToken(tree, stream, lparen_token, indent, start_col, .None); // (
285 try renderExpression(allocator, stream, tree, indent, start_col, align_value_expr, .None); // alignment
286 try renderToken(tree, stream, rparen_token, indent, start_col, last_token_space); // )
274287 } else {
275 try renderExpression(allocator, stream, tree, indent, start_col, field.type_expr.?, Space.Comma); // type,
288 try renderExpression(allocator, stream, tree, indent, start_col, field.type_expr.?, last_token_space); // type
276289 }
277290 } else if (field.type_expr == null and field.value_expr != null) {
278 try renderToken(tree, stream, field.name_token, indent, start_col, Space.Space); // name
279 try renderToken(tree, stream, tree.nextToken(field.name_token), indent, start_col, Space.Space); // =
280 return renderExpression(allocator, stream, tree, indent, start_col, field.value_expr.?, Space.Comma); // value
291 try renderToken(tree, stream, field.name_token, indent, start_col, .Space); // name
292 try renderToken(tree, stream, tree.nextToken(field.name_token), indent, start_col, .Space); // =
293 try renderExpression(allocator, stream, tree, indent, start_col, field.value_expr.?, last_token_space); // value
281294 } else {
282 try renderToken(tree, stream, field.name_token, indent, start_col, Space.None); // name
283 try renderToken(tree, stream, tree.nextToken(field.name_token), indent, start_col, Space.Space); // :
295 try renderToken(tree, stream, field.name_token, indent, start_col, .None); // name
296 try renderToken(tree, stream, tree.nextToken(field.name_token), indent, start_col, .Space); // :
284297
285298 if (field.align_expr) |align_value_expr| {
286 try renderExpression(allocator, stream, tree, indent, start_col, field.type_expr.?, Space.Space); // type
299 try renderExpression(allocator, stream, tree, indent, start_col, field.type_expr.?, .Space); // type
287300 const lparen_token = tree.prevToken(align_value_expr.firstToken());
288301 const align_kw = tree.prevToken(lparen_token);
289302 const rparen_token = tree.nextToken(align_value_expr.lastToken());
290 try renderToken(tree, stream, align_kw, indent, start_col, Space.None); // align
291 try renderToken(tree, stream, lparen_token, indent, start_col, Space.None); // (
292 try renderExpression(allocator, stream, tree, indent, start_col, align_value_expr, Space.None); // alignment
293 try renderToken(tree, stream, rparen_token, indent, start_col, Space.Space); // )
303 try renderToken(tree, stream, align_kw, indent, start_col, .None); // align
304 try renderToken(tree, stream, lparen_token, indent, start_col, .None); // (
305 try renderExpression(allocator, stream, tree, indent, start_col, align_value_expr, .None); // alignment
306 try renderToken(tree, stream, rparen_token, indent, start_col, .Space); // )
294307 } else {
295 try renderExpression(allocator, stream, tree, indent, start_col, field.type_expr.?, Space.Space); // type
308 try renderExpression(allocator, stream, tree, indent, start_col, field.type_expr.?, .Space); // type
296309 }
297 try renderToken(tree, stream, tree.prevToken(field.value_expr.?.firstToken()), indent, start_col, Space.Space); // =
298 return renderExpression(allocator, stream, tree, indent, start_col, field.value_expr.?, Space.Comma); // value,
310 try renderToken(tree, stream, tree.prevToken(field.value_expr.?.firstToken()), indent, start_col, .Space); // =
311 try renderExpression(allocator, stream, tree, indent, start_col, field.value_expr.?, last_token_space); // value
312 }
313
314 if (src_has_trailing_comma) {
315 const comma = tree.nextToken(field.lastToken());
316 try renderToken(tree, stream, comma, indent, start_col, space);
299317 }
300318 },
301319
302320 .Comptime => {
303321 assert(!decl.requireSemiColon());
304 try renderExpression(allocator, stream, tree, indent, start_col, decl, Space.Newline);
322 try renderExpression(allocator, stream, tree, indent, start_col, decl, space);
305323 },
306324
307325 .DocComment => {
308326 const comment = @fieldParentPtr(ast.Node.DocComment, "base", decl);
309327 var it = comment.lines.iterator(0);
310328 while (it.next()) |line_token_index| {
311 try renderToken(tree, stream, line_token_index.*, indent, start_col, Space.Newline);
329 try renderToken(tree, stream, line_token_index.*, indent, start_col, .Newline);
312330 if (it.peek()) |_| {
313331 try stream.writeByteNTimes(' ', indent);
314332 }
......@@ -1150,14 +1168,42 @@ fn renderExpression(
11501168 if (container_decl.fields_and_decls.len == 0) {
11511169 try renderToken(tree, stream, container_decl.lbrace_token, indent + indent_delta, start_col, Space.None); // {
11521170 return renderToken(tree, stream, container_decl.rbrace_token, indent, start_col, space); // }
1153 } else {
1171 }
1172
1173 const src_has_trailing_comma = blk: {
1174 var maybe_comma = tree.prevToken(container_decl.lastToken());
1175 // Doc comments for a field may also appear after the comma, eg.
1176 // field_name: T, // comment attached to field_name
1177 if (tree.tokens.at(maybe_comma).id == .DocComment)
1178 maybe_comma = tree.prevToken(maybe_comma);
1179 break :blk tree.tokens.at(maybe_comma).id == .Comma;
1180 };
1181
1182 // Check if the first declaration and the { are on the same line
1183 const src_has_newline = !tree.tokensOnSameLine(
1184 container_decl.lbrace_token,
1185 container_decl.fields_and_decls.at(0).*.firstToken(),
1186 );
1187
1188 // We can only print all the elements in-line if all the
1189 // declarations inside are fields
1190 const src_has_only_fields = blk: {
1191 var it = container_decl.fields_and_decls.iterator(0);
1192 while (it.next()) |decl| {
1193 if (decl.*.id != .ContainerField) break :blk false;
1194 }
1195 break :blk true;
1196 };
1197
1198 if (src_has_trailing_comma or !src_has_only_fields) {
1199 // One declaration per line
11541200 const new_indent = indent + indent_delta;
1155 try renderToken(tree, stream, container_decl.lbrace_token, new_indent, start_col, Space.Newline); // {
1201 try renderToken(tree, stream, container_decl.lbrace_token, new_indent, start_col, .Newline); // {
11561202
11571203 var it = container_decl.fields_and_decls.iterator(0);
11581204 while (it.next()) |decl| {
11591205 try stream.writeByteNTimes(' ', new_indent);
1160 try renderTopLevelDecl(allocator, stream, tree, new_indent, start_col, decl.*);
1206 try renderContainerDecl(allocator, stream, tree, new_indent, start_col, decl.*, .Newline);
11611207
11621208 if (it.peek()) |next_decl| {
11631209 try renderExtraNewline(tree, stream, start_col, next_decl.*);
......@@ -1165,8 +1211,30 @@ fn renderExpression(
11651211 }
11661212
11671213 try stream.writeByteNTimes(' ', indent);
1168 return renderToken(tree, stream, container_decl.rbrace_token, indent, start_col, space); // }
1214 } else if (src_has_newline) {
1215 // All the declarations on the same line, but place the items on
1216 // their own line
1217 try renderToken(tree, stream, container_decl.lbrace_token, indent, start_col, .Newline); // {
1218
1219 const new_indent = indent + indent_delta;
1220 try stream.writeByteNTimes(' ', new_indent);
1221
1222 var it = container_decl.fields_and_decls.iterator(0);
1223 while (it.next()) |decl| {
1224 const space_after_decl: Space = if (it.peek() == null) .Newline else .Space;
1225 try renderContainerDecl(allocator, stream, tree, new_indent, start_col, decl.*, space_after_decl);
1226 }
1227 } else {
1228 // All the declarations on the same line
1229 try renderToken(tree, stream, container_decl.lbrace_token, indent, start_col, .Space); // {
1230
1231 var it = container_decl.fields_and_decls.iterator(0);
1232 while (it.next()) |decl| {
1233 try renderContainerDecl(allocator, stream, tree, indent, start_col, decl.*, .Space);
1234 }
11691235 }
1236
1237 return renderToken(tree, stream, container_decl.rbrace_token, indent, start_col, space); // }
11701238 },
11711239
11721240 .ErrorSetDecl => {
src-self-hosted/dep_tokenizer.zig+1-1
......@@ -894,7 +894,7 @@ fn printSection(out: var, label: []const u8, bytes: []const u8) !void {
894894
895895fn printLabel(out: var, label: []const u8, bytes: []const u8) !void {
896896 var buf: [80]u8 = undefined;
897 var text = try std.fmt.bufPrint(buf[0..], "{} {} bytes ", .{label, bytes.len});
897 var text = try std.fmt.bufPrint(buf[0..], "{} {} bytes ", .{ label, bytes.len });
898898 try out.write(text);
899899 var i: usize = text.len;
900900 const end = 79;
src-self-hosted/link.zig+1-1
......@@ -105,7 +105,7 @@ extern fn ZigLLDLink(
105105 context: *c_void,
106106) bool;
107107
108extern fn linkDiagCallback(context: *c_void, ptr: [*]const u8, len: usize) void {
108fn linkDiagCallback(context: *c_void, ptr: [*]const u8, len: usize) callconv(.C) void {
109109 const ctx = @ptrCast(*Context, @alignCast(@alignOf(Context), context));
110110 ctx.link_err = linkDiagCallbackErrorable(ctx, ptr[0..len]);
111111}