Skip to content

Commit c9ee1c2

Browse files
committed
Port incremental parse ability to sourcekit-lsp
This feature will be used when we call `changeDocument` in SwiftLanguageServer
1 parent 869fd0a commit c9ee1c2

File tree

2 files changed

+84
-7
lines changed

2 files changed

+84
-7
lines changed

Sources/SourceKitLSP/Swift/SwiftLanguageServer.swift

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,10 @@ public final class SwiftLanguageServer: ToolchainLanguageServer {
119119

120120
var commandsByFile: [DocumentURI: SwiftCompileCommand] = [:]
121121

122+
var documentParseTransition: [DocumentURI: (SourceFileSyntax, IncrementalParseNodeAffectRangeCollector)] = [:]
123+
124+
public var documentReusedNodeCollector: [DocumentURI: IncrementalParseReusedNodeCollector] = [:]
125+
122126
var keys: sourcekitd_keys { return sourcekitd.keys }
123127
var requests: sourcekitd_requests { return sourcekitd.requests }
124128
var values: sourcekitd_values { return sourcekitd.values }
@@ -198,13 +202,31 @@ public final class SwiftLanguageServer: ToolchainLanguageServer {
198202

199203
/// Returns the updated lexical tokens for the given `snapshot`.
200204
private func updateSyntaxTree(
201-
for snapshot: DocumentSnapshot
205+
for snapshot: DocumentSnapshot,
206+
with edits: [IncrementalEdit]? = nil
202207
) -> DocumentTokens {
203208
logExecutionTime(level: .debug) {
204209
var docTokens = snapshot.tokens
210+
let documentURI = snapshot.document.uri
211+
212+
var reusedNodeCollector = documentReusedNodeCollector[documentURI]
213+
if reusedNodeCollector == nil {
214+
documentReusedNodeCollector[documentURI] = IncrementalParseReusedNodeCollector()
215+
reusedNodeCollector = documentReusedNodeCollector[documentURI]
216+
}
217+
218+
var parseTransition: IncrementalParseTransition? = nil
219+
if let previousTree = documentParseTransition[documentURI]?.0,
220+
let nodeAffectRange = documentParseTransition[documentURI]?.1 {
221+
parseTransition = IncrementalParseTransition(previousTree: previousTree, edits: ConcurrentEdits(fromSequential: edits ?? []), nodeAffectRangeCollector: nodeAffectRange, reusedNodeDelegate: reusedNodeCollector)
222+
}
223+
let (tree, nodeAffectRangeCollector) = Parser.parse(
224+
source: snapshot.text, parseTransition: parseTransition)
205225

206-
docTokens.syntaxTree = Parser.parse(source: snapshot.text)
226+
docTokens.syntaxTree = tree
207227

228+
documentParseTransition[documentURI] = (tree, nodeAffectRangeCollector)
229+
208230
return docTokens
209231
}
210232
}
@@ -527,27 +549,37 @@ extension SwiftLanguageServer {
527549

528550
public func changeDocument(_ note: DidChangeTextDocumentNotification) {
529551
let keys = self.keys
552+
var edits: [IncrementalEdit] = []
530553

531554
self.queue.async {
532555
var lastResponse: SKDResponseDictionary? = nil
533556

534-
let snapshot = self.documentManager.edit(note) { (before: DocumentSnapshot, edit: TextDocumentContentChangeEvent) in
557+
let snapshot = self.documentManager.edit(note) {
558+
(before: DocumentSnapshot, edit: TextDocumentContentChangeEvent) in
535559
let req = SKDRequestDictionary(sourcekitd: self.sourcekitd)
536560
req[keys.request] = self.requests.editor_replacetext
537561
req[keys.name] = note.textDocument.uri.pseudoPath
538562

539563
if let range = edit.range {
540-
guard let offset = before.utf8Offset(of: range.lowerBound), let end = before.utf8Offset(of: range.upperBound) else {
564+
guard let offset = before.utf8Offset(of: range.lowerBound),
565+
let end = before.utf8Offset(of: range.upperBound)
566+
else {
541567
fatalError("invalid edit \(range)")
542568
}
543569

570+
let length = end - offset
544571
req[keys.offset] = offset
545-
req[keys.length] = end - offset
572+
req[keys.length] = length
546573

574+
edits.append(IncrementalEdit(offset: offset, length: length, replacementLength: edit.text.utf8.count)
575+
)
547576
} else {
548577
// Full text
578+
let length = before.text.utf8.count
549579
req[keys.offset] = 0
550-
req[keys.length] = before.text.utf8.count
580+
req[keys.length] = length
581+
582+
edits.append(IncrementalEdit(offset: 0, length: length, replacementLength: edit.text.utf8.count))
551583
}
552584

553585
req[keys.sourcetext] = edit.text
@@ -556,7 +588,7 @@ extension SwiftLanguageServer {
556588
self.adjustDiagnosticRanges(of: note.textDocument.uri, for: edit)
557589
} updateDocumentTokens: { (after: DocumentSnapshot) in
558590
if lastResponse != nil {
559-
return self.updateSyntaxTree(for: after)
591+
return self.updateSyntaxTree(for: after, with: edits)
560592
} else {
561593
return DocumentTokens()
562594
}

Tests/SourceKitLSPTests/LocalSwiftTests.swift

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1476,4 +1476,49 @@ final class LocalSwiftTests: XCTestCase {
14761476
data = EditorPlaceholder(text)
14771477
XCTAssertNil(data)
14781478
}
1479+
1480+
func testIncrementalParse() throws {
1481+
let url = URL(fileURLWithPath: "/\(UUID())/a.swift")
1482+
let uri = DocumentURI(url)
1483+
1484+
sk.allowUnexpectedNotification = false
1485+
1486+
sk.send(DidOpenTextDocumentNotification(textDocument: TextDocumentItem(
1487+
uri: uri,
1488+
language: .swift,
1489+
version: 0,
1490+
text: """
1491+
func foo() {
1492+
}
1493+
class bar {
1494+
}
1495+
"""
1496+
)))
1497+
1498+
sk.sendNoteSync(DidChangeTextDocumentNotification(textDocument: .init(uri, version: 1), contentChanges: [
1499+
.init(range: Range(Position(line: 2, utf16index: 7)), text: "a")
1500+
]), { (note: LanguageServerProtocol.Notification<PublishDiagnosticsNotification>) -> Void in
1501+
log("Received diagnostics for text edit - syntactic")
1502+
}, { (note: LanguageServerProtocol.Notification<PublishDiagnosticsNotification>) -> Void in
1503+
log("Received diagnostics for text edit - semantic")
1504+
})
1505+
1506+
1507+
let swiftLanguageServer = connection.server!._languageService(for: uri, .swift, in: connection.server!.workspaceForDocumentOnQueue(uri: uri)!) as! SwiftLanguageServer
1508+
1509+
guard let nodes = swiftLanguageServer.documentReusedNodeCollector[uri]?.nodes else {
1510+
XCTFail("Can not find reused nodes in \(uri)")
1511+
return
1512+
}
1513+
XCTAssertEqual(nodes.count, 1)
1514+
1515+
let firstNode = try XCTUnwrap(nodes.first)
1516+
XCTAssertEqual(firstNode.description,
1517+
"""
1518+
func foo() {
1519+
}
1520+
"""
1521+
)
1522+
XCTAssertEqual(firstNode.kind, .codeBlockItem)
1523+
}
14791524
}

0 commit comments

Comments
 (0)