Commit 04bca58a3a3a85eeaa36ab4c2cc0881347e123b0 | zig

author	Andrew Kelley <andrew@ziglang.org> 2018-05-15 00:33:34-04:00
committer	Andrew Kelley <andrew@ziglang.org> 2018-05-15 00:33:34-04:00
log	04bca58a3a3a85eeaa36ab4c2cc0881347e123b0
tree	38f8c506048be0df410e517e58367c3a015f613b
parent	abcd418451051fe8c3b5c283d1701d101337dde8

zig fmt: preserve same line doc comments on var decls

2 files changed, 58 insertions(+), 28 deletions(-)

std
- zig
  - parse.zig
  - parser_test.zig

std/zig/parse.zig+45-21

 @@ -640,12 +640,7 @@ pub fn parse(allocator: &mem.Allocator, source: []const u8) !ast.Tree {
                 switch (token_ptr.id) {
                     Token.Id.Equal => {
                         var_decl.eq_token = token_index;
-                        stack.append(State {
+                        stack.append(State { .VarDeclSemiColon = var_decl }) catch unreachable;
-                            .ExpectTokenSave = ExpectTokenSave {
-                                .id = Token.Id.Semicolon,
-                                .ptr = &var_decl.semicolon_token,
-                            },
-                        }) catch unreachable;
                         try stack.append(State { .Expression = OptionalCtx { .RequiredNull = &var_decl.init_node } });
                         continue;
                     },
 @@ -662,6 +657,30 @@ pub fn parse(allocator: &mem.Allocator, source: []const u8) !ast.Tree {
                 }
             },
+            State.VarDeclSemiColon => |var_decl| {
+                const semicolon_token = nextToken(&tok_it, &tree);
+                if (semicolon_token.ptr.id != Token.Id.Semicolon) {
+                    *(try tree.errors.addOne()) = Error {
+                        .ExpectedToken = Error.ExpectedToken {
+                            .token = semicolon_token.index,
+                            .expected_id = Token.Id.Semicolon,
+                        },
+                    };
+                    return tree;
+                }
+                var_decl.semicolon_token = semicolon_token.index;
+                if (eatToken(&tok_it, &tree, Token.Id.DocComment)) |doc_comment_token| {
+                    const loc = tree.tokenLocation(semicolon_token.ptr.end, doc_comment_token);
+                    if (loc.line == 0) {
+                        try pushDocComment(arena, doc_comment_token, &var_decl.doc_comments);
+                    } else {
+                        putBackToken(&tok_it, &tree);
+                    }
+                }
+            },
             State.FnDef => |fn_proto| {
                 const token = nextToken(&tok_it, &tree);
 @@ -2938,6 +2957,7 @@ const State = union(enum) {
     VarDecl: VarDeclCtx,
     VarDeclAlign: &ast.Node.VarDecl,
     VarDeclEq: &ast.Node.VarDecl,
+    VarDeclSemiColon: &ast.Node.VarDecl,
     FnDef: &ast.Node.FnProto,
     FnProto: &ast.Node.FnProto,
 @@ -3042,25 +3062,29 @@ const State = union(enum) {
     OptionalTokenSave: OptionalTokenSave,
 };
+fn pushDocComment(arena: &mem.Allocator, line_comment: TokenIndex, result: &?&ast.Node.DocComment) !void {
+    const node = blk: {
+        if (*result) |comment_node| {
+            break :blk comment_node;
+        } else {
+            const comment_node = try arena.construct(ast.Node.DocComment {
+                .base = ast.Node {
+                    .id = ast.Node.Id.DocComment,
+                },
+                .lines = ast.Node.DocComment.LineList.init(arena),
+            });
+            *result = comment_node;
+            break :blk comment_node;
+        }
+    };
+    try node.lines.push(line_comment);
+}
 fn eatDocComments(arena: &mem.Allocator, tok_it: &ast.Tree.TokenList.Iterator, tree: &ast.Tree) !?&ast.Node.DocComment {
     var result: ?&ast.Node.DocComment = null;
     while (true) {
         if (eatToken(tok_it, tree, Token.Id.DocComment)) |line_comment| {
-            const node = blk: {
+            try pushDocComment(arena, line_comment, &result);
-                if (result) |comment_node| {
-                    break :blk comment_node;
-                } else {
-                    const comment_node = try arena.construct(ast.Node.DocComment {
-                        .base = ast.Node {
-                            .id = ast.Node.Id.DocComment,
-                        },
-                        .lines = ast.Node.DocComment.LineList.init(arena),
-                    });
-                    result = comment_node;
-                    break :blk comment_node;
-                }
-            };
-            try node.lines.push(line_comment);
             continue;
         }
         break;

std/zig/parser_test.zig+13-7

...	@@ -1,10 +1,16 @@	...	@@ -1,10 +1,16 @@
1	//test "zig fmt: same-line doc comment on variable declaration" {	1	test "zig fmt: same-line doc comment on variable declaration" {
2	// try testCanonical(	2	try testTransform(
3	// \\pub const MAP_ANONYMOUS = 0x1000; /// allocated from memory, swap space	3	\\pub const MAP_ANONYMOUS = 0x1000; /// allocated from memory, swap space
4	// \\pub const MAP_FILE = 0x0000; /// map from file (default)	4	\\pub const MAP_FILE = 0x0000; /// map from file (default)
5	// \\	5	\\
6	// );	6	,
7	//}	7	\\/// allocated from memory, swap space
		8	\\pub const MAP_ANONYMOUS = 0x1000;
		9	\\/// map from file (default)
		10	\\pub const MAP_FILE = 0x0000;
		11	\\
		12	);
		13	}
8		14
9	test "zig fmt: same-line comment after a statement" {	15	test "zig fmt: same-line comment after a statement" {
10	try testCanonical(	16	try testCanonical(