Define methods on SourceKitD to create arrays and dictionaries instead of using skd postfix syntax

Author: ahoppen

Sources/SourceKitD/SKDRequestArray.swift

@@ -20,11 +20,11 @@ import Musl
 import CRT
 #endif
 
-extension Array<SKDValue> {
-  /// Create an `SKDRequestArray` from this array.
-  public func skd(_ sourcekitd: SourceKitD) -> SKDRequestArray {
-    let result = SKDRequestArray(sourcekitd: sourcekitd)
-    for element in self {
+extension SourceKitD {
+  /// Create a `SKDRequestArray` from the given array.
+  public func array(_ array: [SKDValue]) -> SKDRequestArray {
+    let result = SKDRequestArray(sourcekitd: self)
+    for element in array {
       result.append(element)
     }
     return result
@@ -57,9 +57,9 @@ public final class SKDRequestArray {
     case let newValue as SKDRequestArray:
       sourcekitd.api.request_array_set_value(array, -1, newValue.array)
     case let newValue as Array<SKDValue>:
-      self.append(newValue.skd(sourcekitd))
+      self.append(sourcekitd.array(newValue))
     case let newValue as Dictionary<sourcekitd_uid_t, SKDValue>:
-      self.append(newValue.skd(sourcekitd))
+      self.append(sourcekitd.dictionary(newValue))
     case let newValue as Optional<SKDValue>:
       if let newValue {
         self.append(newValue)

Sources/SourceKitD/SKDRequestDictionary.swift

@@ -38,13 +38,11 @@ extension Array<SKDValue>: SKDValue {}
 extension Dictionary<sourcekitd_uid_t, SKDValue>: SKDValue {}
 extension Optional: SKDValue where Wrapped: SKDValue {}
 
-extension Dictionary<sourcekitd_uid_t, SKDValue> {
-  /// Create an `SKDRequestDictionary` from this dictionary.
-  ///
-  /// If a value is `nil`, the corresponding key will not be added
-  public func skd(_ sourcekitd: SourceKitD) -> SKDRequestDictionary {
-    let result = SKDRequestDictionary(sourcekitd: sourcekitd)
-    for (key, value) in self {
+extension SourceKitD {
+  /// Create a `SKDRequestDictionary` from the given dictionary.
+  public func dictionary(_ dict: [sourcekitd_uid_t: SKDValue]) -> SKDRequestDictionary {
+    let result = SKDRequestDictionary(sourcekitd: self)
+    for (key, value) in dict {
       result.set(key, to: value)
     }
     return result
@@ -77,9 +75,9 @@ public final class SKDRequestDictionary {
     case let newValue as SKDRequestArray:
       sourcekitd.api.request_dictionary_set_value(dict, key, newValue.array)
     case let newValue as Array<SKDValue>:
-      self.set(key, to: newValue.skd(sourcekitd))
+      self.set(key, to: sourcekitd.array(newValue))
     case let newValue as Dictionary<sourcekitd_uid_t, SKDValue>:
-      self.set(key, to: newValue.skd(sourcekitd))
+      self.set(key, to: sourcekitd.dictionary(newValue))
     case let newValue as Optional<SKDValue>:
       if let newValue {
         self.set(key, to: newValue)

Sources/SourceKitLSP/Rename.swift

@@ -383,26 +383,28 @@ extension SwiftLanguageServer {
     oldName: String,
     in snapshot: DocumentSnapshot
   ) async throws -> [SyntacticRenameName] {
-    let locations = renameLocations.map { renameLocation in
-      [
-        keys.line: renameLocation.line,
-        keys.column: renameLocation.utf8Column,
-        keys.nameType: renameLocation.usage.uid(keys: keys),
-      ].skd(sourcekitd)
-    }.skd(sourcekitd)
-    let renameLocation = [
+    let locations = sourcekitd.array(
+      renameLocations.map { renameLocation in
+        sourcekitd.dictionary([
+          keys.line: renameLocation.line,
+          keys.column: renameLocation.utf8Column,
+          keys.nameType: renameLocation.usage.uid(keys: keys),
+        ])
+      }
+    )
+    let renameLocation = sourcekitd.dictionary([
       keys.locations: locations,
       keys.name: oldName,
-    ].skd(sourcekitd)
+    ])
 
-    let skreq = [
+    let skreq = sourcekitd.dictionary([
       keys.request: requests.find_syntactic_rename_ranges,
       keys.sourcefile: snapshot.uri.pseudoPath,
       // find-syntactic-rename-ranges is a syntactic sourcekitd request that doesn't use the in-memory file snapshot.
       // We need to send the source text again.
       keys.sourcetext: snapshot.text,
       keys.renamelocations: [renameLocation],
-    ].skd(sourcekitd)
+    ])
 
     let syntacticRenameRangesResponse = try await sourcekitd.send(skreq, fileContents: snapshot.text)
     guard let categorizedRanges: SKDResponseArray = syntacticRenameRangesResponse[keys.categorizedranges] else {

Sources/SourceKitLSP/Swift/CodeCompletionSession.swift

@@ -191,15 +191,15 @@ class CodeCompletionSession {
       throw ResponseError(code: .invalidRequest, message: "open must use the original snapshot")
     }
 
-    let req = [
+    let req = sourcekitd.dictionary([
       keys.request: sourcekitd.requests.codecomplete_open,
       keys.offset: utf8StartOffset,
       keys.name: uri.pseudoPath,
       keys.sourcefile: uri.pseudoPath,
       keys.sourcetext: snapshot.text,
       keys.codecomplete_options: optionsDictionary(filterText: filterText, options: options),
       keys.compilerargs: compileCommand?.compilerArgs as [SKDValue]?,
-    ].skd(sourcekitd)
+    ])
 
     let dict = try await sourcekitd.send(req, fileContents: snapshot.text)
     self.state = .open
@@ -228,12 +228,12 @@ class CodeCompletionSession {
     // FIXME: Assertion for prefix of snapshot matching what we started with.
 
     logger.info("Updating code completion session: \(self, privacy: .private) filter=\(filterText)")
-    let req = [
+    let req = sourcekitd.dictionary([
       keys.request: sourcekitd.requests.codecomplete_update,
       keys.offset: utf8StartOffset,
       keys.name: uri.pseudoPath,
       keys.codecomplete_options: optionsDictionary(filterText: filterText, options: options),
-    ].skd(sourcekitd)
+    ])
 
     let dict = try await sourcekitd.send(req, fileContents: snapshot.text)
     guard let completions: SKDResponseArray = dict[keys.results] else {
@@ -253,7 +253,7 @@ class CodeCompletionSession {
     filterText: String,
     options: SKCompletionOptions
   ) -> SKDRequestDictionary {
-    let dict = [
+    let dict = sourcekitd.dictionary([
       // Sorting and priority options.
       keys.codecomplete_hideunderscores: 0,
       keys.codecomplete_hidelowpriority: 0,
@@ -264,7 +264,7 @@ class CodeCompletionSession {
       // Filtering options.
       keys.codecomplete_filtertext: filterText,
       keys.codecomplete_requestlimit: options.maxResults,
-    ].skd(sourcekitd)
+    ])
     return dict
   }
 
@@ -274,11 +274,11 @@ class CodeCompletionSession {
       // Already closed, nothing to do.
       break
     case .open:
-      let req = [
+      let req = sourcekitd.dictionary([
         keys.request: sourcekitd.requests.codecomplete_close,
         keys.offset: utf8StartOffset,
         keys.name: snapshot.uri.pseudoPath,
-      ].skd(sourcekitd)
+      ])
       logger.info("Closing code completion session: \(self, privacy: .private)")
       _ = try? await sourcekitd.send(req, fileContents: nil)
       self.state = .closed

Sources/SourceKitLSP/Swift/CursorInfo.swift

@@ -92,14 +92,14 @@ extension SwiftLanguageServer {
 
     let keys = self.keys
 
-    let skreq = [
+    let skreq = sourcekitd.dictionary([
       keys.request: requests.cursorinfo,
       keys.cancelOnSubsequentRequest: 0,
       keys.offset: offsetRange.lowerBound,
       keys.length: offsetRange.upperBound != offsetRange.lowerBound ? offsetRange.count : nil,
       keys.sourcefile: snapshot.uri.pseudoPath,
       keys.compilerargs: await self.buildSettings(for: uri)?.compilerArgs as [SKDValue]?,
-    ].skd(sourcekitd)
+    ])
 
     appendAdditionalParameters?(skreq)
 

Sources/SourceKitLSP/Swift/OpenInterface.swift

@@ -70,14 +70,14 @@ extension SwiftLanguageServer {
     interfaceURI: DocumentURI
   ) async throws -> InterfaceInfo {
     let keys = self.keys
-    let skreq = [
+    let skreq = sourcekitd.dictionary([
       keys.request: requests.editor_open_interface,
       keys.modulename: name,
       keys.groupname: request.groupNames.isEmpty ? nil : request.groupNames as [SKDValue],
       keys.name: interfaceURI.pseudoPath,
       keys.synthesizedextensions: 1,
       keys.compilerargs: await self.buildSettings(for: uri)?.compilerArgs as [SKDValue]?,
-    ].skd(sourcekitd)
+    ])
 
     let dict = try await self.sourcekitd.send(skreq, fileContents: nil)
     return InterfaceInfo(contents: dict[keys.sourcetext] ?? "")
@@ -94,11 +94,11 @@ extension SwiftLanguageServer {
         return InterfaceDetails(uri: uri, position: nil)
       }
       let keys = self.keys
-      let skreq = [
+      let skreq = sourcekitd.dictionary([
         keys.request: requests.find_usr,
         keys.sourcefile: uri.pseudoPath,
         keys.usr: symbol,
-      ].skd(sourcekitd)
+      ])
 
       let dict = try await self.sourcekitd.send(skreq, fileContents: snapshot.text)
       if let offset: Int = dict[keys.offset],

Sources/SourceKitLSP/Swift/RelatedIdentifiers.swift

@@ -66,14 +66,14 @@ extension SwiftLanguageServer {
       throw ResponseError.unknown("invalid position \(position)")
     }
 
-    let skreq = [
+    let skreq = sourcekitd.dictionary([
       keys.request: requests.relatedidents,
       keys.cancelOnSubsequentRequest: 0,
       keys.offset: offset,
       keys.sourcefile: snapshot.uri.pseudoPath,
       keys.includeNonEditableBaseNames: includeNonEditableBaseNames ? 1 : 0,
       keys.compilerargs: await self.buildSettings(for: snapshot.uri)?.compilerArgs as [SKDValue]?,
-    ].skd(sourcekitd)
+    ])
 
     let dict = try await self.sourcekitd.send(skreq, fileContents: snapshot.text)
 

Sources/SourceKitLSP/Swift/SemanticRefactoring.swift

@@ -138,7 +138,7 @@ extension SwiftLanguageServer {
       throw SemanticRefactoringError.invalidRange(refactorCommand.positionRange)
     }
 
-    let skreq = [
+    let skreq = sourcekitd.dictionary([
       keys.request: self.requests.semantic_refactoring,
       // Preferred name for e.g. an extracted variable.
       // Empty string means sourcekitd chooses a name automatically.
@@ -150,7 +150,7 @@ extension SwiftLanguageServer {
       keys.length: offsetRange.count,
       keys.actionuid: self.sourcekitd.api.uid_get_from_cstr(refactorCommand.actionString)!,
       keys.compilerargs: await self.buildSettings(for: snapshot.uri)?.compilerArgs as [SKDValue]?,
-    ].skd(sourcekitd)
+    ])
 
     let dict = try await self.sourcekitd.send(skreq, fileContents: snapshot.text)
     guard let refactor = SemanticRefactoring(refactorCommand.title, dict, snapshot, self.keys) else {

Sources/SourceKitLSP/Swift/SemanticTokens.swift

@@ -24,11 +24,11 @@ extension SwiftLanguageServer {
       return nil
     }
 
-    let skreq = [
+    let skreq = sourcekitd.dictionary([
       keys.request: requests.semantic_tokens,
       keys.sourcefile: snapshot.uri.pseudoPath,
       keys.compilerargs: buildSettings.compilerArgs as [SKDValue],
-    ].skd(sourcekitd)
+    ])
 
     let dict = try await sourcekitd.send(skreq, fileContents: snapshot.text)
 

Sources/SourceKitLSP/Swift/SwiftLanguageServer.swift

@@ -260,9 +260,9 @@ extension SwiftLanguageServer {
 
   /// Tell sourcekitd to crash itself. For testing purposes only.
   public func _crash() async {
-    let req = [
+    let req = sourcekitd.dictionary([
       keys.request: sourcekitd.requests.crash_exit
-    ].skd(sourcekitd)
+    ])
     _ = try? await sourcekitd.send(req, fileContents: nil)
   }
 
@@ -274,18 +274,18 @@ extension SwiftLanguageServer {
     let keys = self.keys
     let path = snapshot.uri.pseudoPath
 
-    let closeReq = [
+    let closeReq = sourcekitd.dictionary([
       keys.request: requests.editor_close,
       keys.name: path,
-    ].skd(sourcekitd)
+    ])
     _ = try? await self.sourcekitd.send(closeReq, fileContents: nil)
 
-    let openReq = [
+    let openReq = sourcekitd.dictionary([
       keys.request: self.requests.editor_open,
       keys.name: path,
       keys.sourcetext: snapshot.text,
       keys.compilerargs: compileCmd?.compilerArgs as [SKDValue]?,
-    ].skd(sourcekitd)
+    ])
 
     _ = try? await self.sourcekitd.send(openReq, fileContents: snapshot.text)
 
@@ -325,13 +325,13 @@ extension SwiftLanguageServer {
       return
     }
 
-    let req = [
+    let req = sourcekitd.dictionary([
       keys.request: self.requests.editor_open,
       keys.name: note.textDocument.uri.pseudoPath,
       keys.sourcetext: snapshot.text,
       keys.syntactic_only: 1,
       keys.compilerargs: await self.buildSettings(for: snapshot.uri)?.compilerArgs as [SKDValue]?,
-    ].skd(sourcekitd)
+    ])
 
     _ = try? await self.sourcekitd.send(req, fileContents: snapshot.text)
     publishDiagnosticsIfNeeded(for: note.textDocument.uri)
@@ -347,10 +347,10 @@ extension SwiftLanguageServer {
 
     let uri = note.textDocument.uri
 
-    let req = [
+    let req = sourcekitd.dictionary([
       keys.request: self.requests.editor_close,
       keys.name: uri.pseudoPath,
-    ].skd(sourcekitd)
+    ])
 
     _ = try? await self.sourcekitd.send(req, fileContents: nil)
   }
@@ -454,14 +454,14 @@ extension SwiftLanguageServer {
       }
     }
     for edit in edits {
-      let req = [
+      let req = sourcekitd.dictionary([
         keys.request: self.requests.editor_replacetext,
         keys.name: note.textDocument.uri.pseudoPath,
         keys.syntactic_only: 1,
         keys.offset: edit.offset,
         keys.length: edit.length,
         keys.sourcetext: edit.replacement,
-      ].skd(sourcekitd)
+      ])
       do {
         _ = try await self.sourcekitd.send(req, fileContents: nil)
       } catch {
@@ -826,11 +826,11 @@ extension SwiftLanguageServer {
 
     let keys = self.keys
 
-    let skreq = [
+    let skreq = sourcekitd.dictionary([
       keys.request: requests.diagnostics,
       keys.sourcefile: snapshot.uri.pseudoPath,
       keys.compilerargs: buildSettings.compilerArgs as [SKDValue],
-    ].skd(sourcekitd)
+    ])
 
     let dict = try await self.sourcekitd.send(skreq, fileContents: snapshot.text)
 

Sources/SourceKitLSP/Swift/VariableTypeInfo.swift

@@ -87,11 +87,11 @@ extension SwiftLanguageServer {
   ) async throws -> [VariableTypeInfo] {
     let snapshot = try documentManager.latestSnapshot(uri)
 
-    let skreq = [
+    let skreq = sourcekitd.dictionary([
       keys.request: requests.variable_type,
       keys.sourcefile: snapshot.uri.pseudoPath,
       keys.compilerargs: await self.buildSettings(for: uri)?.compilerArgs as [SKDValue]?,
-    ].skd(sourcekitd)
+    ])
 
     if let range = range,
       let start = snapshot.utf8Offset(of: range.lowerBound),

Tests/SourceKitDTests/SourceKitDTests.swift

@@ -80,23 +80,23 @@ final class SourceKitDTests: XCTestCase {
     }
     args.append(path)
 
-    let req = [
+    let req = sourcekitd.dictionary([
       keys.request: sourcekitd.requests.editor_open,
       keys.name: path,
       keys.sourcetext: """
       func foo() {}
       """,
       keys.compilerargs: args,
-    ].skd(sourcekitd)
+    ])
 
     _ = try await sourcekitd.send(req, fileContents: nil)
 
     try await fulfillmentOfOrThrow([expectation1, expectation2])
 
-    let close = [
+    let close = sourcekitd.dictionary([
       keys.request: sourcekitd.requests.editor_close,
       keys.name: path,
-    ].skd(sourcekitd)
+    ])
     _ = try await sourcekitd.send(close, fileContents: nil)
   }
 }