Skip to content

Commit fc64679

Browse files
ahoppenahoppen
committed
Improve folding of line comments
Previously, the folding range of a block of line comments was ended after the newline of the last line comment, which would usually be the line of the function’s start. That caused VS Code to not show a folding range for the function body itself since it started on the same line that the line comment folding range ended. Rewrite the trivia folding logic so that the folding range of those line comments ends on the line of the last line comment. Fixes #803 rdar://114428202
1 parent f10a733 commit fc64679

File tree

4 files changed

+124
-38
lines changed

4 files changed

+124
-38
lines changed

‎Sources/SKTestSupport/INPUTS/FoldingRange/FoldingRangeMultilineDocLineComment.swift‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/// Do some fancy stuff
2+
///
3+
/// This does very fancy stuff. Use it when building a great app.
4+
func doStuff() {
5+
6+
}
7+
8+
// Some comment
9+
// And some more test
10+
11+
// And another comment separated by newlines
12+
func foo() {}
13+
14+
/*fr:multilineDocLineComment*/

‎Sources/SKTestSupport/INPUTS/FoldingRange/project.json‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,8 @@
1-
{ "sources": ["FoldingRangeBase.swift", "FoldingRangeEmptyFile.swift"] }
1+
{
2+
"sources": [
3+
"FoldingRangeBase.swift",
4+
"FoldingRangeEmptyFile.swift",
5+
"FoldingRangeMultilineDocLineComment.swift",
6+
"FoldingRangeDuplicateRanges.swift"
7+
]
8+
}

‎Sources/SourceKitLSP/Swift/SwiftLanguageServer.swift‎

Lines changed: 70 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1072,50 +1072,78 @@ extension SwiftLanguageServer {
10721072
}
10731073

10741074
private func addTrivia(from node: TokenSyntax, _ trivia: Trivia) {
1075+
let pieces = trivia.pieces
10751076
var start = node.position.utf8Offset
1076-
var lineCommentStart: Int? = nil
1077-
func flushLineComment(_ offset: Int = 0) {
1078-
if let lineCommentStart = lineCommentStart {
1079-
_ = self.addFoldingRange(
1080-
start: lineCommentStart,
1081-
end: start + offset,
1082-
kind: .comment)
1077+
/// The index of the trivia piece we are currently inspecting.
1078+
var index = 0
1079+
1080+
while index < pieces.count {
1081+
let piece = pieces[index]
1082+
defer {
1083+
start += pieces[index].sourceLength.utf8Length
1084+
index += 1
10831085
}
1084-
lineCommentStart = nil
1085-
}
1086-
1087-
for piece in node.leadingTrivia {
1088-
defer { start += piece.sourceLength.utf8Length }
10891086
switch piece {
1090-
case .blockComment(_):
1091-
flushLineComment()
1087+
case .blockComment:
10921088
_ = self.addFoldingRange(
10931089
start: start,
10941090
end: start + piece.sourceLength.utf8Length,
1095-
kind: .comment)
1096-
case .docBlockComment(_):
1097-
flushLineComment()
1091+
kind: .comment
1092+
)
1093+
case .docBlockComment:
10981094
_ = self.addFoldingRange(
10991095
start: start,
11001096
end: start + piece.sourceLength.utf8Length,
1101-
kind: .comment)
1102-
case .lineComment(_), .docLineComment(_):
1103-
if lineCommentStart == nil {
1104-
lineCommentStart = start
1105-
}
1106-
case .newlines(1), .carriageReturns(1), .spaces(_), .tabs(_):
1107-
if lineCommentStart != nil {
1108-
continue
1109-
} else {
1110-
flushLineComment()
1097+
kind: .comment
1098+
)
1099+
case .lineComment, .docLineComment:
1100+
let lineCommentBlockStart = start
1101+
1102+
// Keep scanning the upcoming trivia pieces to find the end of the
1103+
// block of line comments.
1104+
// As we find a new end of the block comment, we set `index` and
1105+
// `start` to `lookaheadIndex` and `lookaheadStart` resp. to
1106+
// commit the newly found end.
1107+
var lookaheadIndex = index
1108+
var lookaheadStart = start
1109+
var hasSeenNewline = false
1110+
LOOP: while lookaheadIndex < pieces.count {
1111+
let piece = pieces[lookaheadIndex]
1112+
defer {
1113+
lookaheadIndex += 1
1114+
lookaheadStart += piece.sourceLength.utf8Length
1115+
}
1116+
switch piece {
1117+
case .newlines(let count), .carriageReturns(let count), .carriageReturnLineFeeds(let count):
1118+
if count > 1 || hasSeenNewline {
1119+
// More than one newline is separating the two line comment blocks.
1120+
// We have reached the end of this block of line comments.
1121+
break LOOP
1122+
}
1123+
hasSeenNewline = true
1124+
case .spaces, .tabs:
1125+
// We allow spaces and tabs because the comments might be indented
1126+
continue
1127+
case .lineComment, .docLineComment:
1128+
// We have found a new line comment in this block. Commit it.
1129+
index = lookaheadIndex
1130+
start = lookaheadStart
1131+
hasSeenNewline = false
1132+
default:
1133+
// We assume that any other trivia piece terminates the block
1134+
// of line comments.
1135+
break LOOP
1136+
}
11111137
}
1138+
_ = self.addFoldingRange(
1139+
start: lineCommentBlockStart,
1140+
end: start + pieces[index].sourceLength.utf8Length,
1141+
kind: .comment
1142+
)
11121143
default:
1113-
flushLineComment()
1114-
continue
1144+
break
11151145
}
11161146
}
1117-
1118-
flushLineComment()
11191147
}
11201148

11211149
override func visit(_ node: CodeBlockSyntax) -> SyntaxVisitorContinueKind {
@@ -1716,3 +1744,14 @@ extension sourcekitd_uid_t {
17161744
}
17171745
}
17181746
}
1747+
1748+
extension TriviaPiece {
1749+
var isLineComment: Bool {
1750+
switch self {
1751+
case .lineComment, .docLineComment:
1752+
return true
1753+
default:
1754+
return false
1755+
}
1756+
}
1757+
}

‎Tests/SourceKitLSPTests/FoldingRangeTests.swift‎

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ final class FoldingRangeTests: XCTestCase {
3838
let request = FoldingRangeRequest(textDocument: TextDocumentIdentifier(uri))
3939
let ranges = try withExtendedLifetime(ws) { try ws.sk.sendSync(request) }
4040

41-
XCTAssertEqual(ranges, [
41+
let expected = [
4242
FoldingRange(startLine: 0, startUTF16Index: 0, endLine: 1, endUTF16Index: 18, kind: .comment),
4343
FoldingRange(startLine: 3, startUTF16Index: 0, endLine: 13, endUTF16Index: 2, kind: .comment),
4444
FoldingRange(startLine: 14, startUTF16Index: 10, endLine: 27, endUTF16Index: 0, kind: nil),
45-
FoldingRange(startLine: 15, startUTF16Index: 2, endLine: 17, endUTF16Index: 2, kind: .comment),
45+
FoldingRange(startLine: 15, startUTF16Index: 2, endLine: 16, endUTF16Index: 6, kind: .comment),
4646
FoldingRange(startLine: 17, startUTF16Index: 2, endLine: 19, endUTF16Index: 4, kind: .comment),
4747
FoldingRange(startLine: 22, startUTF16Index: 21, endLine: 25, endUTF16Index: 2, kind: nil),
4848
FoldingRange(startLine: 23, startUTF16Index: 23, endLine: 23, endUTF16Index: 30, kind: nil),
@@ -51,7 +51,9 @@ final class FoldingRangeTests: XCTestCase {
5151
FoldingRange(startLine: 33, startUTF16Index: 0, endLine: 35, endUTF16Index: 2, kind: .comment),
5252
FoldingRange(startLine: 37, startUTF16Index: 0, endLine: 37, endUTF16Index: 32, kind: .comment),
5353
FoldingRange(startLine: 39, startUTF16Index: 0, endLine: 39, endUTF16Index: 11, kind: .comment),
54-
])
54+
]
55+
56+
XCTAssertEqual(ranges, expected)
5557
}
5658

5759
func testLineFoldingOnly() throws {
@@ -63,16 +65,18 @@ final class FoldingRangeTests: XCTestCase {
6365
let request = FoldingRangeRequest(textDocument: TextDocumentIdentifier(uri))
6466
let ranges = try withExtendedLifetime(ws) { try ws.sk.sendSync(request) }
6567

66-
XCTAssertEqual(ranges, [
68+
let expected = [
6769
FoldingRange(startLine: 0, endLine: 1, kind: .comment),
6870
FoldingRange(startLine: 3, endLine: 13, kind: .comment),
6971
FoldingRange(startLine: 14, endLine: 27, kind: nil),
70-
FoldingRange(startLine: 15, endLine: 17, kind: .comment),
72+
FoldingRange(startLine: 15, endLine: 16, kind: .comment),
7173
FoldingRange(startLine: 17, endLine: 19, kind: .comment),
7274
FoldingRange(startLine: 22, endLine: 25, kind: nil),
7375
FoldingRange(startLine: 29, endLine: 31, kind: .comment),
7476
FoldingRange(startLine: 33, endLine: 35, kind: .comment),
75-
])
77+
]
78+
79+
XCTAssertEqual(ranges, expected)
7680
}
7781

7882
func testRangeLimit() throws {
@@ -105,6 +109,28 @@ final class FoldingRangeTests: XCTestCase {
105109
XCTAssertEqual(ranges?.count, 0)
106110
}
107111

112+
func testMultilineDocLineComment() throws {
113+
// In this file the range of the call to `print` and the range of the argument "/*fr:duplicateRanges*/" are the same.
114+
// Test that we only report the folding range once.
115+
let capabilities = FoldingRangeCapabilities()
116+
117+
guard let (ws, url) = try initializeWorkspace(withCapabilities: capabilities, testLoc: "fr:multilineDocLineComment") else { return }
118+
119+
let request = FoldingRangeRequest(textDocument: TextDocumentIdentifier(url))
120+
let ranges = try withExtendedLifetime(ws) { try ws.sk.sendSync(request) }
121+
122+
let expected = [
123+
FoldingRange(startLine: 0, startUTF16Index: 0, endLine: 2, endUTF16Index: 65, kind: .comment),
124+
FoldingRange(startLine: 3, startUTF16Index: 16, endLine: 5, endUTF16Index: 0),
125+
FoldingRange(startLine: 7, startUTF16Index: 0, endLine: 8, endUTF16Index: 21, kind: .comment),
126+
FoldingRange(startLine: 10, startUTF16Index: 0, endLine: 10, endUTF16Index: 44, kind: .comment),
127+
FoldingRange(startLine: 11, startUTF16Index: 12, endLine: 11, endUTF16Index: 12),
128+
FoldingRange(startLine: 13, startUTF16Index: 0, endLine: 13, endUTF16Index: 30, kind: .comment)
129+
]
130+
131+
XCTAssertEqual(ranges, expected)
132+
}
133+
108134
func testDontReportDuplicateRangesRanges() throws {
109135
// In this file the range of the call to `print` and the range of the argument "/*fr:duplicateRanges*/" are the same.
110136
// Test that we only report the folding range once.

0 commit comments

Comments
 (0)