Ekdohibs
/
zig
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

zig fmt: only some docs have doc comments

master
Andrew Kelley 2018-04-30 20:25:54 -04:00
parent 61a726c290
commit 7c822869fe
3 changed files with 125 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
std/zig/ast.zig
View File

@ -6,7 +6,6 @@ const mem = std.mem;
pub const Node = struct { pub const Node = struct {
id: Id, id: Id,
doc_comments: ?&DocComment,
same_line_comment: ?&Token, same_line_comment: ?&Token,
pub const Id = enum { pub const Id = enum {
@ -70,6 +69,7 @@ pub const Node = struct {
StructField, StructField,
UnionTag, UnionTag,
EnumTag, EnumTag,
ErrorTag,
AsmInput, AsmInput,
AsmOutput, AsmOutput,
AsyncAttribute, AsyncAttribute,
@ -77,6 +77,13 @@ pub const Node = struct {
FieldInitializer, FieldInitializer,
}; };
pub fn cast(base: &Node, comptime T: type) ?&T {
if (base.id == comptime typeToId(T)) {
return @fieldParentPtr(T, "base", base);
}
return null;
}
pub fn iterate(base: &Node, index: usize) ?&Node { pub fn iterate(base: &Node, index: usize) ?&Node {
comptime var i = 0; comptime var i = 0;
inline while (i < @memberCount(Id)) : (i += 1) { inline while (i < @memberCount(Id)) : (i += 1) {
@ -122,6 +129,7 @@ pub const Node = struct {
pub const Root = struct { pub const Root = struct {
base: Node, base: Node,
doc_comments: ?&DocComment,
decls: ArrayList(&Node), decls: ArrayList(&Node),
eof_token: Token, eof_token: Token,
@ -143,6 +151,7 @@ pub const Node = struct {
pub const VarDecl = struct { pub const VarDecl = struct {
base: Node, base: Node,
doc_comments: ?&DocComment,
visib_token: ?Token, visib_token: ?Token,
name_token: Token, name_token: Token,
eq_token: Token, eq_token: Token,
@ -191,6 +200,7 @@ pub const Node = struct {
pub const Use = struct { pub const Use = struct {
base: Node, base: Node,
doc_comments: ?&DocComment,
visib_token: ?Token, visib_token: ?Token,
expr: &Node, expr: &Node,
semicolon_token: Token, semicolon_token: Token,
@ -294,6 +304,7 @@ pub const Node = struct {
pub const StructField = struct { pub const StructField = struct {
base: Node, base: Node,
doc_comments: ?&DocComment,
visib_token: ?Token, visib_token: ?Token,
name_token: Token, name_token: Token,
type_expr: &Node, type_expr: &Node,
@ -319,6 +330,7 @@ pub const Node = struct {
pub const UnionTag = struct { pub const UnionTag = struct {
base: Node, base: Node,
doc_comments: ?&DocComment,
name_token: Token, name_token: Token,
type_expr: ?&Node, type_expr: ?&Node,
value_expr: ?&Node, value_expr: ?&Node,
@ -357,6 +369,7 @@ pub const Node = struct {
pub const EnumTag = struct { pub const EnumTag = struct {
base: Node, base: Node,
doc_comments: ?&DocComment,
name_token: Token, name_token: Token,
value: ?&Node, value: ?&Node,
@ -384,6 +397,31 @@ pub const Node = struct {
} }
}; };
pub const ErrorTag = struct {
base: Node,
doc_comments: ?&DocComment,
name_token: Token,
pub fn iterate(self: &ErrorTag, index: usize) ?&Node {
var i = index;
if (self.doc_comments) |comments| {
if (i < 1) return &comments.base;
i -= 1;
}
return null;
}
pub fn firstToken(self: &ErrorTag) Token {
return self.name_token;
}
pub fn lastToken(self: &ErrorTag) Token {
return self.name_token;
}
};
pub const Identifier = struct { pub const Identifier = struct {
base: Node, base: Node,
token: Token, token: Token,
@ -433,6 +471,7 @@ pub const Node = struct {
pub const FnProto = struct { pub const FnProto = struct {
base: Node, base: Node,
doc_comments: ?&DocComment,
visib_token: ?Token, visib_token: ?Token,
fn_token: Token, fn_token: Token,
name_token: ?Token, name_token: ?Token,
@ -626,6 +665,7 @@ pub const Node = struct {
pub const Comptime = struct { pub const Comptime = struct {
base: Node, base: Node,
doc_comments: ?&DocComment,
comptime_token: Token, comptime_token: Token,
expr: &Node, expr: &Node,
@ -1794,6 +1834,7 @@ pub const Node = struct {
pub const TestDecl = struct { pub const TestDecl = struct {
base: Node, base: Node,
doc_comments: ?&DocComment,
test_token: Token, test_token: Token,
name: &Node, name: &Node,
body_node: &Node, body_node: &Node,

153
std/zig/parser.zig
View File

@ -228,7 +228,6 @@ pub const Parser = struct {
Statement: &ast.Node.Block, Statement: &ast.Node.Block,
ComptimeStatement: ComptimeStatementCtx, ComptimeStatement: ComptimeStatementCtx,
Semicolon: &&ast.Node, Semicolon: &&ast.Node,
AddComments: AddCommentsCtx,
LookForSameLineComment: &&ast.Node, LookForSameLineComment: &&ast.Node,
LookForSameLineCommentDirect: &ast.Node, LookForSameLineCommentDirect: &ast.Node,
@ -243,8 +242,8 @@ pub const Parser = struct {
FieldInitListCommaOrEnd: ListSave(&ast.Node.FieldInitializer), FieldInitListCommaOrEnd: ListSave(&ast.Node.FieldInitializer),
FieldListCommaOrEnd: &ast.Node.ContainerDecl, FieldListCommaOrEnd: &ast.Node.ContainerDecl,
FieldInitValue: OptionalCtx, FieldInitValue: OptionalCtx,
IdentifierListItemOrEnd: ListSave(&ast.Node), ErrorTagListItemOrEnd: ListSave(&ast.Node),
IdentifierListCommaOrEnd: ListSave(&ast.Node), ErrorTagListCommaOrEnd: ListSave(&ast.Node),
SwitchCaseOrEnd: ListSave(&ast.Node), SwitchCaseOrEnd: ListSave(&ast.Node),
SwitchCaseCommaOrEnd: ListSave(&ast.Node), SwitchCaseCommaOrEnd: ListSave(&ast.Node),
SwitchCaseFirstItem: &ArrayList(&ast.Node), SwitchCaseFirstItem: &ArrayList(&ast.Node),
@ -301,6 +300,7 @@ pub const Parser = struct {
ErrorTypeOrSetDecl: ErrorTypeOrSetDeclCtx, ErrorTypeOrSetDecl: ErrorTypeOrSetDeclCtx,
StringLiteral: OptionalCtx, StringLiteral: OptionalCtx,
Identifier: OptionalCtx, Identifier: OptionalCtx,
ErrorTag: &&ast.Node,
IfToken: @TagType(Token.Id), IfToken: @TagType(Token.Id),
@ -325,6 +325,7 @@ pub const Parser = struct {
ast.Node.Root { ast.Node.Root {
.base = undefined, .base = undefined,
.decls = ArrayList(&ast.Node).init(arena), .decls = ArrayList(&ast.Node).init(arena),
.doc_comments = null,
// initialized when we get the eof token // initialized when we get the eof token
.eof_token = undefined, .eof_token = undefined,
} }
@ -354,7 +355,7 @@ pub const Parser = struct {
try root_node.decls.append(&line_comment.base); try root_node.decls.append(&line_comment.base);
} }
const comments = try self.eatComments(arena); const comments = try self.eatDocComments(arena);
const token = self.getNextToken(); const token = self.getNextToken();
switch (token.id) { switch (token.id) {
Token.Id.Keyword_test => { Token.Id.Keyword_test => {
@ -363,7 +364,6 @@ pub const Parser = struct {
const block = try arena.construct(ast.Node.Block { const block = try arena.construct(ast.Node.Block {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.Block, .id = ast.Node.Id.Block,
.doc_comments = null,
.same_line_comment = null, .same_line_comment = null,
}, },
.label = null, .label = null,
@ -374,9 +374,9 @@ pub const Parser = struct {
const test_node = try arena.construct(ast.Node.TestDecl { const test_node = try arena.construct(ast.Node.TestDecl {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.TestDecl, .id = ast.Node.Id.TestDecl,
.doc_comments = comments,
.same_line_comment = null, .same_line_comment = null,
}, },
.doc_comments = comments,
.test_token = token, .test_token = token,
.name = undefined, .name = undefined,
.body_node = &block.base, .body_node = &block.base,
@ -394,7 +394,11 @@ pub const Parser = struct {
}, },
Token.Id.Eof => { Token.Id.Eof => {
root_node.eof_token = token; root_node.eof_token = token;
return Tree {.root_node = root_node, .arena_allocator = arena_allocator}; root_node.doc_comments = comments;
return Tree {
.root_node = root_node,
.arena_allocator = arena_allocator,
};
}, },
Token.Id.Keyword_pub => { Token.Id.Keyword_pub => {
stack.append(State.TopLevel) catch unreachable; stack.append(State.TopLevel) catch unreachable;
@ -424,6 +428,7 @@ pub const Parser = struct {
.base = undefined, .base = undefined,
.comptime_token = token, .comptime_token = token,
.expr = &block.base, .expr = &block.base,
.doc_comments = comments,
} }
); );
stack.append(State.TopLevel) catch unreachable; stack.append(State.TopLevel) catch unreachable;
@ -520,6 +525,7 @@ pub const Parser = struct {
.visib_token = ctx.visib_token, .visib_token = ctx.visib_token,
.expr = undefined, .expr = undefined,
.semicolon_token = undefined, .semicolon_token = undefined,
.doc_comments = ctx.comments,
} }
); );
stack.append(State { stack.append(State {
@ -556,9 +562,9 @@ pub const Parser = struct {
const fn_proto = try arena.construct(ast.Node.FnProto { const fn_proto = try arena.construct(ast.Node.FnProto {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.FnProto, .id = ast.Node.Id.FnProto,
.doc_comments = ctx.comments,
.same_line_comment = null, .same_line_comment = null,
}, },
.doc_comments = ctx.comments,
.visib_token = ctx.visib_token, .visib_token = ctx.visib_token,
.name_token = null, .name_token = null,
.fn_token = undefined, .fn_token = undefined,
@ -625,9 +631,9 @@ pub const Parser = struct {
const node = try arena.construct(ast.Node.StructField { const node = try arena.construct(ast.Node.StructField {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.StructField, .id = ast.Node.Id.StructField,
.doc_comments = null,
.same_line_comment = null, .same_line_comment = null,
}, },
.doc_comments = ctx.comments,
.visib_token = ctx.visib_token, .visib_token = ctx.visib_token,
.name_token = identifier, .name_token = identifier,
.type_expr = undefined, .type_expr = undefined,
@ -734,7 +740,7 @@ pub const Parser = struct {
try container_decl.fields_and_decls.append(&line_comment.base); try container_decl.fields_and_decls.append(&line_comment.base);
} }
const comments = try self.eatComments(arena); const comments = try self.eatDocComments(arena);
const token = self.getNextToken(); const token = self.getNextToken();
switch (token.id) { switch (token.id) {
Token.Id.Identifier => { Token.Id.Identifier => {
@ -743,9 +749,9 @@ pub const Parser = struct {
const node = try arena.construct(ast.Node.StructField { const node = try arena.construct(ast.Node.StructField {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.StructField, .id = ast.Node.Id.StructField,
.doc_comments = comments,
.same_line_comment = null, .same_line_comment = null,
}, },
.doc_comments = comments,
.visib_token = null, .visib_token = null,
.name_token = token, .name_token = token,
.type_expr = undefined, .type_expr = undefined,
@ -765,6 +771,7 @@ pub const Parser = struct {
.name_token = token, .name_token = token,
.type_expr = null, .type_expr = null,
.value_expr = null, .value_expr = null,
.doc_comments = comments,
} }
); );
@ -780,6 +787,7 @@ pub const Parser = struct {
.base = undefined, .base = undefined,
.name_token = token, .name_token = token,
.value = null, .value = null,
.doc_comments = comments,
} }
); );
@ -831,6 +839,9 @@ pub const Parser = struct {
continue; continue;
}, },
Token.Id.RBrace => { Token.Id.RBrace => {
if (comments != null) {
return self.parseError(token, "doc comments must be attached to a node");
}
container_decl.rbrace_token = token; container_decl.rbrace_token = token;
continue; continue;
}, },
@ -856,9 +867,9 @@ pub const Parser = struct {
const var_decl = try arena.construct(ast.Node.VarDecl { const var_decl = try arena.construct(ast.Node.VarDecl {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.VarDecl, .id = ast.Node.Id.VarDecl,
.doc_comments = ctx.comments,
.same_line_comment = null, .same_line_comment = null,
}, },
.doc_comments = ctx.comments,
.visib_token = ctx.visib_token, .visib_token = ctx.visib_token,
.mut_token = ctx.mut_token, .mut_token = ctx.mut_token,
.comptime_token = ctx.comptime_token, .comptime_token = ctx.comptime_token,
@ -1119,7 +1130,6 @@ pub const Parser = struct {
const node = try arena.construct(ast.Node.Suspend { const node = try arena.construct(ast.Node.Suspend {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.Suspend, .id = ast.Node.Id.Suspend,
.doc_comments = null,
.same_line_comment = null, .same_line_comment = null,
}, },
.label = ctx.label, .label = ctx.label,
@ -1283,7 +1293,6 @@ pub const Parser = struct {
} }
}, },
State.Statement => |block| { State.Statement => |block| {
const comments = try self.eatComments(arena);
const token = self.getNextToken(); const token = self.getNextToken();
switch (token.id) { switch (token.id) {
Token.Id.Keyword_comptime => { Token.Id.Keyword_comptime => {
@ -1298,7 +1307,7 @@ pub const Parser = struct {
Token.Id.Keyword_var, Token.Id.Keyword_const => { Token.Id.Keyword_var, Token.Id.Keyword_const => {
stack.append(State { stack.append(State {
.VarDecl = VarDeclCtx { .VarDecl = VarDeclCtx {
.comments = comments, .comments = null,
.visib_token = null, .visib_token = null,
.comptime_token = null, .comptime_token = null,
.extern_export_token = null, .extern_export_token = null,
@ -1313,7 +1322,6 @@ pub const Parser = struct {
const node = try arena.construct(ast.Node.Defer { const node = try arena.construct(ast.Node.Defer {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.Defer, .id = ast.Node.Id.Defer,
.doc_comments = comments,
.same_line_comment = null, .same_line_comment = null,
}, },
.defer_token = token, .defer_token = token,
@ -1349,23 +1357,18 @@ pub const Parser = struct {
const statement = try block.statements.addOne(); const statement = try block.statements.addOne();
stack.append(State { .LookForSameLineComment = statement }) catch unreachable; stack.append(State { .LookForSameLineComment = statement }) catch unreachable;
try stack.append(State { .Semicolon = statement }); try stack.append(State { .Semicolon = statement });
try stack.append(State { .AddComments = AddCommentsCtx {
.node_ptr = statement,
.comments = comments,
}});
try stack.append(State { .AssignmentExpressionBegin = OptionalCtx{ .Required = statement } }); try stack.append(State { .AssignmentExpressionBegin = OptionalCtx{ .Required = statement } });
continue; continue;
} }
} }
}, },
State.ComptimeStatement => |ctx| { State.ComptimeStatement => |ctx| {
const comments = try self.eatComments(arena);
const token = self.getNextToken(); const token = self.getNextToken();
switch (token.id) { switch (token.id) {
Token.Id.Keyword_var, Token.Id.Keyword_const => { Token.Id.Keyword_var, Token.Id.Keyword_const => {
stack.append(State { stack.append(State {
.VarDecl = VarDeclCtx { .VarDecl = VarDeclCtx {
.comments = comments, .comments = null,
.visib_token = null, .visib_token = null,
.comptime_token = ctx.comptime_token, .comptime_token = ctx.comptime_token,
.extern_export_token = null, .extern_export_token = null,
@ -1395,12 +1398,6 @@ pub const Parser = struct {
continue; continue;
}, },
State.AddComments => |add_comments_ctx| {
const node = *add_comments_ctx.node_ptr;
node.doc_comments = add_comments_ctx.comments;
continue;
},
State.LookForSameLineComment => |node_ptr| { State.LookForSameLineComment => |node_ptr| {
try self.lookForSameLineComment(arena, *node_ptr); try self.lookForSameLineComment(arena, *node_ptr);
continue; continue;
@ -1521,7 +1518,6 @@ pub const Parser = struct {
const node = try arena.construct(ast.Node.FieldInitializer { const node = try arena.construct(ast.Node.FieldInitializer {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.FieldInitializer, .id = ast.Node.Id.FieldInitializer,
.doc_comments = null,
.same_line_comment = null, .same_line_comment = null,
}, },
.period_token = undefined, .period_token = undefined,
@ -1566,7 +1562,7 @@ pub const Parser = struct {
try stack.append(State { .ContainerDecl = container_decl }); try stack.append(State { .ContainerDecl = container_decl });
continue; continue;
}, },
State.IdentifierListItemOrEnd => |list_state| { State.ErrorTagListItemOrEnd => |list_state| {
while (try self.eatLineComment(arena)) |line_comment| { while (try self.eatLineComment(arena)) |line_comment| {
try list_state.list.append(&line_comment.base); try list_state.list.append(&line_comment.base);
} }
@ -1576,23 +1572,18 @@ pub const Parser = struct {
continue; continue;
} }
const comments = try self.eatComments(arena);
const node_ptr = try list_state.list.addOne(); const node_ptr = try list_state.list.addOne();
try stack.append(State { .AddComments = AddCommentsCtx { try stack.append(State { .ErrorTagListCommaOrEnd = list_state });
.node_ptr = node_ptr, try stack.append(State { .ErrorTag = node_ptr });
.comments = comments,
}});
try stack.append(State { .IdentifierListCommaOrEnd = list_state });
try stack.append(State { .Identifier = OptionalCtx { .Required = node_ptr } });
continue; continue;
}, },
State.IdentifierListCommaOrEnd => |list_state| { State.ErrorTagListCommaOrEnd => |list_state| {
if (try self.expectCommaOrEnd(Token.Id.RBrace)) |end| { if (try self.expectCommaOrEnd(Token.Id.RBrace)) |end| {
*list_state.ptr = end; *list_state.ptr = end;
continue; continue;
} else { } else {
stack.append(State { .IdentifierListItemOrEnd = list_state }) catch unreachable; stack.append(State { .ErrorTagListItemOrEnd = list_state }) catch unreachable;
continue; continue;
} }
}, },
@ -1606,11 +1597,10 @@ pub const Parser = struct {
continue; continue;
} }
const comments = try self.eatComments(arena); const comments = try self.eatDocComments(arena);
const node = try arena.construct(ast.Node.SwitchCase { const node = try arena.construct(ast.Node.SwitchCase {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.SwitchCase, .id = ast.Node.Id.SwitchCase,
.doc_comments = comments,
.same_line_comment = null, .same_line_comment = null,
}, },
.items = ArrayList(&ast.Node).init(arena), .items = ArrayList(&ast.Node).init(arena),
@ -1723,9 +1713,9 @@ pub const Parser = struct {
const fn_proto = try arena.construct(ast.Node.FnProto { const fn_proto = try arena.construct(ast.Node.FnProto {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.FnProto, .id = ast.Node.Id.FnProto,
.doc_comments = ctx.comments,
.same_line_comment = null, .same_line_comment = null,
}, },
.doc_comments = ctx.comments,
.visib_token = null, .visib_token = null,
.name_token = null, .name_token = null,
.fn_token = fn_token, .fn_token = fn_token,
@ -2593,7 +2583,6 @@ pub const Parser = struct {
const node = try arena.construct(ast.Node.PromiseType { const node = try arena.construct(ast.Node.PromiseType {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.PromiseType, .id = ast.Node.Id.PromiseType,
.doc_comments = null,
.same_line_comment = null, .same_line_comment = null,
}, },
.promise_token = token, .promise_token = token,
@ -2719,9 +2708,9 @@ pub const Parser = struct {
const fn_proto = try arena.construct(ast.Node.FnProto { const fn_proto = try arena.construct(ast.Node.FnProto {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.FnProto, .id = ast.Node.Id.FnProto,
.doc_comments = null,
.same_line_comment = null, .same_line_comment = null,
}, },
.doc_comments = null,
.visib_token = null, .visib_token = null,
.name_token = null, .name_token = null,
.fn_token = token, .fn_token = token,
@ -2743,9 +2732,9 @@ pub const Parser = struct {
const fn_proto = try arena.construct(ast.Node.FnProto { const fn_proto = try arena.construct(ast.Node.FnProto {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.FnProto, .id = ast.Node.Id.FnProto,
.doc_comments = null,
.same_line_comment = null, .same_line_comment = null,
}, },
.doc_comments = null,
.visib_token = null, .visib_token = null,
.name_token = null, .name_token = null,
.fn_token = undefined, .fn_token = undefined,
@ -2836,7 +2825,6 @@ pub const Parser = struct {
const node = try arena.construct(ast.Node.ErrorSetDecl { const node = try arena.construct(ast.Node.ErrorSetDecl {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.ErrorSetDecl, .id = ast.Node.Id.ErrorSetDecl,
.doc_comments = null,
.same_line_comment = null, .same_line_comment = null,
}, },
.error_token = ctx.error_token, .error_token = ctx.error_token,
@ -2846,7 +2834,7 @@ pub const Parser = struct {
ctx.opt_ctx.store(&node.base); ctx.opt_ctx.store(&node.base);
stack.append(State { stack.append(State {
.IdentifierListItemOrEnd = ListSave(&ast.Node) { .ErrorTagListItemOrEnd = ListSave(&ast.Node) {
.list = &node.decls, .list = &node.decls,
.ptr = &node.rbrace_token, .ptr = &node.rbrace_token,
} }
@ -2866,6 +2854,7 @@ pub const Parser = struct {
} }
); );
}, },
State.Identifier => |opt_ctx| { State.Identifier => |opt_ctx| {
if (self.eatToken(Token.Id.Identifier)) |ident_token| { if (self.eatToken(Token.Id.Identifier)) |ident_token| {
_ = try self.createToCtxLiteral(arena, opt_ctx, ast.Node.Identifier, ident_token); _ = try self.createToCtxLiteral(arena, opt_ctx, ast.Node.Identifier, ident_token);
@ -2878,6 +2867,25 @@ pub const Parser = struct {
} }
}, },
State.ErrorTag => |node_ptr| {
const comments = try self.eatDocComments(arena);
const ident_token = self.getNextToken();
if (ident_token.id != Token.Id.Identifier) {
return self.parseError(ident_token, "expected {}, found {}",
@tagName(Token.Id.Identifier), @tagName(ident_token.id));
}
const node = try arena.construct(ast.Node.ErrorTag {
.base = ast.Node {
.id = ast.Node.Id.ErrorTag,
.same_line_comment = null,
},
.doc_comments = comments,
.name_token = ident_token,
});
*node_ptr = &node.base;
continue;
},
State.ExpectToken => |token_id| { State.ExpectToken => |token_id| {
_ = try self.expectToken(token_id); _ = try self.expectToken(token_id);
@ -2916,7 +2924,7 @@ pub const Parser = struct {
} }
} }
fn eatComments(self: &Parser, arena: &mem.Allocator) !?&ast.Node.DocComment { fn eatDocComments(self: &Parser, arena: &mem.Allocator) !?&ast.Node.DocComment {
var result: ?&ast.Node.DocComment = null; var result: ?&ast.Node.DocComment = null;
while (true) { while (true) {
if (self.eatToken(Token.Id.DocComment)) |line_comment| { if (self.eatToken(Token.Id.DocComment)) |line_comment| {
@ -2927,7 +2935,6 @@ pub const Parser = struct {
const comment_node = try arena.construct(ast.Node.DocComment { const comment_node = try arena.construct(ast.Node.DocComment {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.DocComment, .id = ast.Node.Id.DocComment,
.doc_comments = null,
.same_line_comment = null, .same_line_comment = null,
}, },
.lines = ArrayList(Token).init(arena), .lines = ArrayList(Token).init(arena),
@ -2949,7 +2956,6 @@ pub const Parser = struct {
return try arena.construct(ast.Node.LineComment { return try arena.construct(ast.Node.LineComment {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.LineComment, .id = ast.Node.Id.LineComment,
.doc_comments = null,
.same_line_comment = null, .same_line_comment = null,
}, },
.token = token, .token = token,
@ -3142,7 +3148,6 @@ pub const Parser = struct {
const node = try arena.construct(ast.Node.Switch { const node = try arena.construct(ast.Node.Switch {
.base = ast.Node { .base = ast.Node {
.id = ast.Node.Id.Switch, .id = ast.Node.Id.Switch,
.doc_comments = null,
.same_line_comment = null, .same_line_comment = null,
}, },
.switch_token = *token, .switch_token = *token,
@ -3170,6 +3175,7 @@ pub const Parser = struct {
.base = undefined, .base = undefined,
.comptime_token = *token, .comptime_token = *token,
.expr = undefined, .expr = undefined,
.doc_comments = null,
} }
); );
try stack.append(State { .Expression = OptionalCtx { .Required = &node.expr } }); try stack.append(State { .Expression = OptionalCtx { .Required = &node.expr } });
@ -3312,7 +3318,6 @@ pub const Parser = struct {
const id = ast.Node.typeToId(T); const id = ast.Node.typeToId(T);
break :blk ast.Node { break :blk ast.Node {
.id = id, .id = id,
.doc_comments = null,
.same_line_comment = null, .same_line_comment = null,
}; };
}; };
@ -3451,7 +3456,6 @@ pub const Parser = struct {
PrintIndent, PrintIndent,
Indent: usize, Indent: usize,
PrintSameLineComment: ?&Token, PrintSameLineComment: ?&Token,
PrintComments: &ast.Node,
}; };
pub fn renderSource(self: &Parser, stream: var, root_node: &ast.Node.Root) !void { pub fn renderSource(self: &Parser, stream: var, root_node: &ast.Node.Root) !void {
@ -3490,7 +3494,7 @@ pub const Parser = struct {
switch (decl.id) { switch (decl.id) {
ast.Node.Id.FnProto => { ast.Node.Id.FnProto => {
const fn_proto = @fieldParentPtr(ast.Node.FnProto, "base", decl); const fn_proto = @fieldParentPtr(ast.Node.FnProto, "base", decl);
try self.renderComments(stream, &fn_proto.base, indent); try self.renderComments(stream, fn_proto, indent);
if (fn_proto.body_node) |body_node| { if (fn_proto.body_node) |body_node| {
stack.append(RenderState { .Expression = body_node}) catch unreachable; stack.append(RenderState { .Expression = body_node}) catch unreachable;
@ -3512,12 +3516,12 @@ pub const Parser = struct {
}, },
ast.Node.Id.VarDecl => { ast.Node.Id.VarDecl => {
const var_decl = @fieldParentPtr(ast.Node.VarDecl, "base", decl); const var_decl = @fieldParentPtr(ast.Node.VarDecl, "base", decl);
try self.renderComments(stream, &var_decl.base, indent); try self.renderComments(stream, var_decl, indent);
try stack.append(RenderState { .VarDecl = var_decl}); try stack.append(RenderState { .VarDecl = var_decl});
}, },
ast.Node.Id.TestDecl => { ast.Node.Id.TestDecl => {
const test_decl = @fieldParentPtr(ast.Node.TestDecl, "base", decl); const test_decl = @fieldParentPtr(ast.Node.TestDecl, "base", decl);
try self.renderComments(stream, &test_decl.base, indent); try self.renderComments(stream, test_decl, indent);
try stream.print("test "); try stream.print("test ");
try stack.append(RenderState { .Expression = test_decl.body_node }); try stack.append(RenderState { .Expression = test_decl.body_node });
try stack.append(RenderState { .Text = " " }); try stack.append(RenderState { .Text = " " });
@ -3525,7 +3529,7 @@ pub const Parser = struct {
}, },
ast.Node.Id.StructField => { ast.Node.Id.StructField => {
const field = @fieldParentPtr(ast.Node.StructField, "base", decl); const field = @fieldParentPtr(ast.Node.StructField, "base", decl);
try self.renderComments(stream, &field.base, indent); try self.renderComments(stream, field, indent);
if (field.visib_token) |visib_token| { if (field.visib_token) |visib_token| {
try stream.print("{} ", self.tokenizer.getTokenSlice(visib_token)); try stream.print("{} ", self.tokenizer.getTokenSlice(visib_token));
} }
@ -3535,7 +3539,7 @@ pub const Parser = struct {
}, },
ast.Node.Id.UnionTag => { ast.Node.Id.UnionTag => {
const tag = @fieldParentPtr(ast.Node.UnionTag, "base", decl); const tag = @fieldParentPtr(ast.Node.UnionTag, "base", decl);
try self.renderComments(stream, &tag.base, indent); try self.renderComments(stream, tag, indent);
try stream.print("{}", self.tokenizer.getTokenSlice(tag.name_token)); try stream.print("{}", self.tokenizer.getTokenSlice(tag.name_token));
try stack.append(RenderState { .Text = "," }); try stack.append(RenderState { .Text = "," });
@ -3552,7 +3556,7 @@ pub const Parser = struct {
}, },
ast.Node.Id.EnumTag => { ast.Node.Id.EnumTag => {
const tag = @fieldParentPtr(ast.Node.EnumTag, "base", decl); const tag = @fieldParentPtr(ast.Node.EnumTag, "base", decl);
try self.renderComments(stream, &tag.base, indent); try self.renderComments(stream, tag, indent);
try stream.print("{}", self.tokenizer.getTokenSlice(tag.name_token)); try stream.print("{}", self.tokenizer.getTokenSlice(tag.name_token));
try stack.append(RenderState { .Text = "," }); try stack.append(RenderState { .Text = "," });
@ -3561,6 +3565,11 @@ pub const Parser = struct {
try stack.append(RenderState { .Expression = value}); try stack.append(RenderState { .Expression = value});
} }
}, },
ast.Node.Id.ErrorTag => {
const tag = @fieldParentPtr(ast.Node.ErrorTag, "base", decl);
try self.renderComments(stream, tag, indent);
try stream.print("{}", self.tokenizer.getTokenSlice(tag.name_token));
},
ast.Node.Id.Comptime => { ast.Node.Id.Comptime => {
if (requireSemiColon(decl)) { if (requireSemiColon(decl)) {
try stack.append(RenderState { .Text = ";" }); try stack.append(RenderState { .Text = ";" });
@ -4122,11 +4131,20 @@ pub const Parser = struct {
if (decls.len == 1) blk: { if (decls.len == 1) blk: {
const node = decls[0]; const node = decls[0];
if (node.same_line_comment != null or node.doc_comments != null) break :blk;
// if there are any doc comments or same line comments
// don't try to put it all on one line
if (node.same_line_comment != null) break :blk;
if (node.cast(ast.Node.ErrorTag)) |tag| {
if (tag.doc_comments != null) break :blk;
} else {
break :blk;
}
try stream.write("error{"); try stream.write("error{");
try stack.append(RenderState { .Text = "}" }); try stack.append(RenderState { .Text = "}" });
try stack.append(RenderState { .Expression = node }); try stack.append(RenderState { .TopLevelDecl = node });
continue; continue;
} }
@ -4144,8 +4162,7 @@ pub const Parser = struct {
if (node.id != ast.Node.Id.LineComment) { if (node.id != ast.Node.Id.LineComment) {
try stack.append(RenderState { .Text = "," }); try stack.append(RenderState { .Text = "," });
} }
try stack.append(RenderState { .Expression = node }); try stack.append(RenderState { .TopLevelDecl = node });
try stack.append(RenderState { .PrintComments = node });
try stack.append(RenderState.PrintIndent); try stack.append(RenderState.PrintIndent);
try stack.append(RenderState { try stack.append(RenderState {
.Text = blk: { .Text = blk: {
@ -4304,8 +4321,6 @@ pub const Parser = struct {
ast.Node.Id.SwitchCase => { ast.Node.Id.SwitchCase => {
const switch_case = @fieldParentPtr(ast.Node.SwitchCase, "base", base); const switch_case = @fieldParentPtr(ast.Node.SwitchCase, "base", base);
try self.renderComments(stream, base, indent);
try stack.append(RenderState { .PrintSameLineComment = base.same_line_comment }); try stack.append(RenderState { .PrintSameLineComment = base.same_line_comment });
try stack.append(RenderState { .Text = "," }); try stack.append(RenderState { .Text = "," });
try stack.append(RenderState { .Expression = switch_case.expr }); try stack.append(RenderState { .Expression = switch_case.expr });
@ -4617,6 +4632,7 @@ pub const Parser = struct {
ast.Node.Id.StructField, ast.Node.Id.StructField,
ast.Node.Id.UnionTag, ast.Node.Id.UnionTag,
ast.Node.Id.EnumTag, ast.Node.Id.EnumTag,
ast.Node.Id.ErrorTag,
ast.Node.Id.Root, ast.Node.Id.Root,
ast.Node.Id.VarDecl, ast.Node.Id.VarDecl,
ast.Node.Id.Use, ast.Node.Id.Use,
@ -4624,7 +4640,6 @@ pub const Parser = struct {
ast.Node.Id.ParamDecl => unreachable, ast.Node.Id.ParamDecl => unreachable,
}, },
RenderState.Statement => |base| { RenderState.Statement => |base| {
try self.renderComments(stream, base, indent);
try stack.append(RenderState { .PrintSameLineComment = base.same_line_comment } ); try stack.append(RenderState { .PrintSameLineComment = base.same_line_comment } );
switch (base.id) { switch (base.id) {
ast.Node.Id.VarDecl => { ast.Node.Id.VarDecl => {
@ -4645,15 +4660,11 @@ pub const Parser = struct {
const comment_token = maybe_comment ?? break :blk; const comment_token = maybe_comment ?? break :blk;
try stream.print(" {}", self.tokenizer.getTokenSlice(comment_token)); try stream.print(" {}", self.tokenizer.getTokenSlice(comment_token));
}, },
RenderState.PrintComments => |node| blk: {
try self.renderComments(stream, node, indent);
},
} }
} }
} }
fn renderComments(self: &Parser, stream: var, node: &ast.Node, indent: usize) !void { fn renderComments(self: &Parser, stream: var, node: var, indent: usize) !void {
const comment = node.doc_comments ?? return; const comment = node.doc_comments ?? return;
for (comment.lines.toSliceConst()) |line_token| { for (comment.lines.toSliceConst()) |line_token| {
try stream.print("{}\n", self.tokenizer.getTokenSlice(line_token)); try stream.print("{}\n", self.tokenizer.getTokenSlice(line_token));

18
std/zig/parser_test.zig
View File

@ -181,7 +181,7 @@ test "zig fmt: comments before global variables" {
); );
} }
test "zig fmt: comments before statements" { test "zig fmt: comments in statements" {
try testCanonical( try testCanonical(
\\test "std" { \\test "std" {
\\ // statement comment \\ // statement comment
@ -211,22 +211,6 @@ test "zig fmt: comments before test decl" {
); );
} }
test "zig fmt: comments before variable declarations" {
try testCanonical(
\\const std = @import("std");
\\
\\pub fn main() !void {
\\ /// If this program is run without stdout attached, exit with an error.
\\ /// another comment
\\ var stdout_file = try std.io.getStdOut;
\\ // If this program is run without stdout attached, exit with an error.
\\ // another comment
\\ var stdout_file = try std.io.getStdOut;
\\}
\\
);
}
test "zig fmt: preserve spacing" { test "zig fmt: preserve spacing" {
try testCanonical( try testCanonical(
\\const std = @import("std"); \\const std = @import("std");