Skip to content

Commit adbbb3e

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 adbbb3e

File tree

2 files changed

+84
-7
lines changed

2 files changed

+84
-7
lines changed

Sources/SourceKitLSP/Swift/SwiftLanguageServer.swift

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

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

122+
var documentLookaheadRanges: [DocumentURI: LookaheadRanges] = [:]
123+
124+
/// *For Testing*
125+
public var reusedNodeCallback: ReusedNodeCallback?
126+
122127
var keys: sourcekitd_keys { return sourcekitd.keys }
123128
var requests: sourcekitd_requests { return sourcekitd.requests }
124129
var values: sourcekitd_values { return sourcekitd.values }
@@ -197,14 +202,30 @@ public final class SwiftLanguageServer: ToolchainLanguageServer {
197202
}
198203

199204
/// Returns the updated lexical tokens for the given `snapshot`.
205+
///
206+
/// - Parameters:
207+
/// - edits: If we are in the context of editing the contents of a file, i.e. calling ``SwiftLanguageServer/changeDocument(_:)``, we should pass `edits` to enable incremental parse. Otherwise, `edits` should be `nil`.
200208
private func updateSyntaxTree(
201-
for snapshot: DocumentSnapshot
209+
for snapshot: DocumentSnapshot,
210+
with edits: ConcurrentEdits? = nil
202211
) -> DocumentTokens {
203212
logExecutionTime(level: .debug) {
204213
var docTokens = snapshot.tokens
214+
let documentURI = snapshot.document.uri
215+
216+
var parseTransition: IncrementalParseTransition? = nil
217+
if let previousTree = snapshot.tokens.syntaxTree,
218+
let lookaheadRanges = documentLookaheadRanges[documentURI],
219+
let edits {
220+
parseTransition = IncrementalParseTransition(previousTree: previousTree, edits: edits, lookaheadRanges: lookaheadRanges, reusedNodeCallback: reusedNodeCallback)
221+
}
222+
let (tree, nextLookaheadRanges) = Parser.parseIncrementally(
223+
source: snapshot.text, parseTransition: parseTransition)
205224

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

227+
documentLookaheadRanges[documentURI] = nextLookaheadRanges
228+
208229
return docTokens
209230
}
210231
}
@@ -520,34 +541,44 @@ extension SwiftLanguageServer {
520541
// Clear settings that should not be cached for closed documents.
521542
self.commandsByFile[uri] = nil
522543
self.currentDiagnostics[uri] = nil
544+
self.documentLookaheadRanges[uri] = nil
523545

524546
_ = try? self.sourcekitd.sendSync(req)
525547
}
526548
}
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))
547575
} else {
548576
// Full text
577+
let length = before.text.utf8.count
549578
req[keys.offset] = 0
550-
req[keys.length] = before.text.utf8.count
579+
req[keys.length] = length
580+
581+
edits.append(IncrementalEdit(offset: 0, length: length, replacementLength: edit.text.utf8.count))
551582
}
552583

553584
req[keys.sourcetext] = edit.text
@@ -556,7 +587,7 @@ extension SwiftLanguageServer {
556587
self.adjustDiagnosticRanges(of: note.textDocument.uri, for: edit)
557588
} updateDocumentTokens: { (after: DocumentSnapshot) in
558589
if lastResponse != nil {
559-
return self.updateSyntaxTree(for: after)
590+
return self.updateSyntaxTree(for: after, with: ConcurrentEdits(fromSequential: edits))
560591
} else {
561592
return DocumentTokens()
562593
}

Tests/SourceKitLSPTests/LocalSwiftTests.swift

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import LSPTestSupport
1616
import SKTestSupport
1717
import SourceKitLSP
1818
import XCTest
19+
import SwiftSyntax
1920

2021
// Workaround ambiguity with Foundation.
2122
typealias Notification = LanguageServerProtocol.Notification
@@ -1476,4 +1477,49 @@ final class LocalSwiftTests: XCTestCase {
14761477
data = EditorPlaceholder(text)
14771478
XCTAssertNil(data)
14781479
}
1480+
1481+
func testIncrementalParse() throws {
1482+
let url = URL(fileURLWithPath: "/\(UUID())/a.swift")
1483+
let uri = DocumentURI(url)
1484+
1485+
var reusedNodes: [Syntax] = []
1486+
let swiftLanguageServer = connection.server!._languageService(for: uri, .swift, in: connection.server!.workspaceForDocumentOnQueue(uri: uri)!) as! SwiftLanguageServer
1487+
swiftLanguageServer.reusedNodeCallback = { reusedNodes.append($0) }
1488+
sk.allowUnexpectedNotification = false
1489+
1490+
sk.send(DidOpenTextDocumentNotification(textDocument: TextDocumentItem(
1491+
uri: uri,
1492+
language: .swift,
1493+
version: 0,
1494+
text: """
1495+
func foo() {
1496+
}
1497+
class bar {
1498+
}
1499+
"""
1500+
)))
1501+
1502+
let didChangeTextDocumentExpectation = self.expectation(description: "didChangeTextDocument")
1503+
sk.sendNoteSync(DidChangeTextDocumentNotification(textDocument: .init(uri, version: 1), contentChanges: [
1504+
.init(range: Range(Position(line: 2, utf16index: 7)), text: "a"),
1505+
]), { (note: LanguageServerProtocol.Notification<PublishDiagnosticsNotification>) -> Void in
1506+
log("Received diagnostics for text edit - syntactic")
1507+
didChangeTextDocumentExpectation.fulfill()
1508+
}, { (note: LanguageServerProtocol.Notification<PublishDiagnosticsNotification>) -> Void in
1509+
log("Received diagnostics for text edit - semantic")
1510+
})
1511+
1512+
self.wait(for: [didChangeTextDocumentExpectation], timeout: defaultTimeout)
1513+
1514+
XCTAssertEqual(reusedNodes.count, 1)
1515+
1516+
let firstNode = try XCTUnwrap(reusedNodes.first)
1517+
XCTAssertEqual(firstNode.description,
1518+
"""
1519+
func foo() {
1520+
}
1521+
"""
1522+
)
1523+
XCTAssertEqual(firstNode.kind, .codeBlockItem)
1524+
}
14791525
}

0 commit comments

Comments
 (0)