mirror/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2026-02-17 23:10:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

zig fmt: fix spacing when moving doc comment on var decls

Browse Source
This commit is contained in:
Andrew Kelley 2018-05-28 23:41:09 -04:00
parent 0d1b47362c
commit 530d175422
2 changed files with 50 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
std/zig/parser_test.zig
View File

@ -1,3 +1,28 @@
test "zig fmt: same-line doc comment on variable declaration" {
try testTransform(
\\pub const MAP_ANONYMOUS = 0x1000; /// allocated from memory, swap space
\\pub const MAP_FILE = 0x0000; /// map from file (default)
\\
\\pub const EMEDIUMTYPE = 124; /// Wrong medium type
\\
\\// nameserver query return codes
\\pub const ENSROK = 0; /// DNS server returned answer with no data
,
\\/// allocated from memory, swap space
\\pub const MAP_ANONYMOUS = 0x1000;
\\/// map from file (default)
\\pub const MAP_FILE = 0x0000;
\\
\\/// Wrong medium type
\\pub const EMEDIUMTYPE = 124;
\\
\\// nameserver query return codes
\\/// DNS server returned answer with no data
\\pub const ENSROK = 0;
\\
);
}
test "zig fmt: if-else with comment before else" {
try testCanonical(
\\comptime {
@ -557,20 +582,6 @@ test "zig fmt: add comma on last switch prong" {
);
}
test "zig fmt: same-line doc comment on variable declaration" {
try testTransform(
\\pub const MAP_ANONYMOUS = 0x1000; /// allocated from memory, swap space
\\pub const MAP_FILE = 0x0000; /// map from file (default)
\\
,
\\/// allocated from memory, swap space
\\pub const MAP_ANONYMOUS = 0x1000;
\\/// map from file (default)
\\pub const MAP_FILE = 0x0000;
\\
);
}
test "zig fmt: same-line comment after a statement" {
try testCanonical(
\\test "" {

33
std/zig/render.zig
View File

@ -39,11 +39,12 @@ pub fn render(allocator: &mem.Allocator, stream: var, tree: &ast.Tree) (@typeOf(
}
fn renderExtraNewline(tree: &ast.Tree, stream: var, node: &ast.Node) !void {
var first_token = node.firstToken();
while (tree.tokens.at(first_token - 1).id == Token.Id.DocComment) {
first_token -= 1;
const first_token = node.firstToken();
var prev_token = first_token;
while (tree.tokens.at(prev_token - 1).id == Token.Id.DocComment) {
prev_token -= 1;
}
const prev_token_end = tree.tokens.at(first_token - 1).end;
const prev_token_end = tree.tokens.at(prev_token - 1).end;
const loc = tree.tokenLocation(prev_token_end, first_token);
if (loc.line >= 2) {
try stream.writeByte('\n');
@ -1715,7 +1716,17 @@ fn renderToken(tree: &ast.Tree, stream: var, token_index: ast.TokenIndex, indent
else => {},
}
if (next_token.id != Token.Id.LineComment) {
// Skip over same line doc comments
var offset: usize = 1;
if (next_token.id == Token.Id.DocComment) {
const loc = tree.tokenLocationPtr(token.end, next_token);
if (loc.line == 0) {
offset += 1;
next_token = tree.tokens.at(token_index + offset);
}
}
if (next_token.id != Token.Id.LineComment) blk: {
switch (space) {
Space.None, Space.NoNewline => return,
Space.Newline => {
@ -1739,7 +1750,6 @@ fn renderToken(tree: &ast.Tree, stream: var, token_index: ast.TokenIndex, indent
}
var loc = tree.tokenLocationPtr(token.end, next_token);
var offset: usize = 1;
if (loc.line == 0) {
try stream.print(" {}", mem.trimRight(u8, tree.tokenSlicePtr(next_token), " "));
offset = 2;
@ -1820,8 +1830,15 @@ fn renderToken(tree: &ast.Tree, stream: var, token_index: ast.TokenIndex, indent
fn renderDocComments(tree: &ast.Tree, stream: var, node: var, indent: usize) (@typeOf(stream).Child.Error || Error)!void {
const comment = node.doc_comments ?? return;
var it = comment.lines.iterator(0);
const first_token = node.firstToken();
while (it.next()) |line_token_index| {
try renderToken(tree, stream, line_token_index.*, indent, Space.Newline);
try stream.writeByteNTimes(' ', indent);
if (line_token_index.* < first_token) {
try renderToken(tree, stream, line_token_index.*, indent, Space.Newline);
try stream.writeByteNTimes(' ', indent);
} else {
try renderToken(tree, stream, line_token_index.*, indent, Space.NoComment);
try stream.write("\n");
try stream.writeByteNTimes(' ', indent);
}
}
}