@@ -15,27 +15,46 @@ import LanguageServerProtocol
1515import LSPLogging
1616import SKSupport
1717
18- public struct DocumentSnapshot {
19- public var document : Document
20- public var version : Int
21- public var lineTable : LineTable
22- /// Syntax highlighting tokens for the document. Note that
23- /// `uri` + `latestVersion` only uniquely identifies a snapshot's content,
24- /// the tokens are updated independently and only used internally.
25- public var tokens : DocumentTokens
18+ /// An immutable snapshot of a document at a given time.
19+ ///
20+ /// ``DocumentSnapshot`` is always derived from a ``Document``. That is, the
21+ /// data structure that is stored internally by the ``DocumentManager`` is a
22+ /// ``Document``. The purpose of a ``DocumentSnapshot`` is to be able to work
23+ /// with one version of a document without having to think about it changing.
24+ public struct DocumentSnapshot : Identifiable {
25+ /// An ID that uniquely identifies the version of the document stored in this
26+ /// snapshot.
27+ public struct ID : Hashable , Comparable {
28+ public let uri : DocumentURI
29+ public let version : Int
30+
31+ /// Returns `true` if the snapshots reference the same document but rhs has a
32+ /// later version than `lhs`.
33+ ///
34+ /// Snapshot IDs of different documents are not comparable to each other and
35+ /// will always return `false`.
36+ public static func < ( lhs: DocumentSnapshot . ID , rhs: DocumentSnapshot . ID ) -> Bool {
37+ return lhs. uri == rhs. uri && lhs. version < rhs. version
38+ }
39+ }
40+
41+ public let id : ID
42+ public let language : Language
43+ public let lineTable : LineTable
2644
45+ public var uri : DocumentURI { id. uri }
46+ public var version : Int { id. version }
2747 public var text : String { lineTable. content }
2848
2949 public init (
30- document: Document ,
50+ uri: DocumentURI ,
51+ language: Language ,
3152 version: Int ,
32- lineTable: LineTable ,
33- tokens: DocumentTokens
53+ lineTable: LineTable
3454 ) {
35- self . document = document
36- self . version = version
55+ self . id = ID ( uri : uri , version : version )
56+ self . language = language
3757 self . lineTable = lineTable
38- self . tokens = tokens
3958 }
4059
4160 func index( of pos: Position ) -> String . Index ? {
@@ -48,23 +67,21 @@ public final class Document {
4867 public let language : Language
4968 var latestVersion : Int
5069 var latestLineTable : LineTable
51- var latestTokens : DocumentTokens
5270
5371 init ( uri: DocumentURI , language: Language , version: Int , text: String ) {
5472 self . uri = uri
5573 self . language = language
5674 self . latestVersion = version
5775 self . latestLineTable = LineTable ( text)
58- self . latestTokens = DocumentTokens ( )
5976 }
6077
6178 /// **Not thread safe!** Use `DocumentManager.latestSnapshot` instead.
6279 fileprivate var latestSnapshot : DocumentSnapshot {
6380 DocumentSnapshot (
64- document: self ,
81+ uri: self . uri,
82+ language: self . language,
6583 version: latestVersion,
66- lineTable: latestLineTable,
67- tokens: latestTokens
84+ lineTable: latestLineTable
6885 )
6986 }
7087}
@@ -118,28 +135,31 @@ public final class DocumentManager {
118135
119136 /// Applies the given edits to the document.
120137 ///
121- /// - parameter willEditDocument: Optional closure to call before each edit.
122- /// - parameter updateDocumentTokens: Optional closure to call after each edit.
123- /// - parameter before: The document contents *before* the edit is applied.
124- /// - parameter after: The document contents *after* the edit is applied.
125- /// - returns: The contents of the file after all the edits are applied.
126- /// - throws: Error.missingDocument if the document is not open.
138+ /// - Parameters:
139+ /// - uri: The URI of the document to update
140+ /// - newVersion: The new version of the document. Must be greater than the
141+ /// latest version of the document.
142+ /// - edits: The edits to apply to the document
143+ /// - willEditDocument: Optional closure to call before each edit. Will be
144+ /// called multiple times if there are multiple edits.
145+ /// - Returns: The snapshot of the document before the edit and the snapshot
146+ /// of the document after the edit.
127147 @discardableResult
128148 public func edit(
129149 _ uri: DocumentURI ,
130150 newVersion: Int ,
131151 edits: [ TextDocumentContentChangeEvent ] ,
132- willEditDocument: ( ( _ before: DocumentSnapshot , TextDocumentContentChangeEvent ) -> Void ) ? = nil ,
133- updateDocumentTokens: ( ( _ after: DocumentSnapshot ) -> DocumentTokens ) ? = nil
134- ) throws -> DocumentSnapshot {
152+ willEditDocument: ( ( _ before: LineTable , TextDocumentContentChangeEvent ) -> Void ) ? = nil
153+ ) throws -> ( preEditSnapshot: DocumentSnapshot , postEditSnapshot: DocumentSnapshot ) {
135154 return try . sync {
136155 guard let document = documents [ uri] else {
137156 throw Error . missingDocument ( uri)
138157 }
158+ let preEditSnapshot = document. latestSnapshot
139159
140160 for edit in edits {
141- if let f = willEditDocument {
142- f ( document. latestSnapshot , edit)
161+ if let willEditDocument {
162+ willEditDocument ( document. latestLineTable , edit)
143163 }
144164
145165 if let range = edit. range {
@@ -149,49 +169,17 @@ public final class DocumentManager {
149169 toLine: range. upperBound. line,
150170 utf16Offset: range. upperBound. utf16index,
151171 with: edit. text)
152-
153- // Remove all tokens in the updated range and shift later ones.
154- let rangeAdjuster = RangeAdjuster ( edit: edit) !
155-
156- document. latestTokens. semantic = document. latestTokens. semantic. compactMap {
157- var token = $0
158- if let adjustedRange = rangeAdjuster. adjust ( token. range) {
159- token. range = adjustedRange
160- return token
161- } else {
162- return nil
163- }
164- }
165172 } else {
166173 // Full text replacement.
167174 document. latestLineTable = LineTable ( edit. text)
168- document. latestTokens = DocumentTokens ( )
169- }
170-
171- if let f = updateDocumentTokens {
172- document. latestTokens = f ( document. latestSnapshot)
173175 }
174176 }
175177
176- document. latestVersion = newVersion
177- return document. latestSnapshot
178- }
179- }
180-
181- /// Updates the tokens in a document.
182- ///
183- /// - parameter uri: The URI of the document to be updated
184- /// - parameter tokens: The new tokens for the document
185- @discardableResult
186- public func updateTokens( _ uri: DocumentURI , tokens: DocumentTokens ) throws -> DocumentSnapshot {
187- return try . sync {
188- guard let document = documents [ uri] else {
189- throw Error . missingDocument ( uri)
178+ if newVersion <= document. latestVersion {
179+ log ( " Document version did not increase on edit from \( document. latestVersion) to \( newVersion) " , level: . error)
190180 }
191-
192- document. latestTokens = tokens
193-
194- return document. latestSnapshot
181+ document. latestVersion = newVersion
182+ return ( preEditSnapshot, document. latestSnapshot)
195183 }
196184 }
197185
@@ -230,16 +218,14 @@ extension DocumentManager {
230218 @discardableResult
231219 func edit(
232220 _ note: DidChangeTextDocumentNotification ,
233- willEditDocument: ( ( _ before: DocumentSnapshot , TextDocumentContentChangeEvent ) -> Void ) ? = nil ,
234- updateDocumentTokens: ( ( _ after: DocumentSnapshot ) -> DocumentTokens ) ? = nil
235- ) -> DocumentSnapshot ? {
221+ willEditDocument: ( ( _ before: LineTable , TextDocumentContentChangeEvent ) -> Void ) ? = nil
222+ ) -> ( preEditSnapshot: DocumentSnapshot , postEditSnapshot: DocumentSnapshot ) ? {
236223 return orLog ( " failed to edit document " , level: . error) {
237- try edit (
224+ return try edit (
238225 note. textDocument. uri,
239226 newVersion: note. textDocument. version,
240227 edits: note. contentChanges,
241- willEditDocument: willEditDocument,
242- updateDocumentTokens: updateDocumentTokens
228+ willEditDocument: willEditDocument
243229 )
244230 }
245231 }
0 commit comments