Merge pull request #1056 from ahoppen/ahoppen/sourcekitd-functions

Rename `sourcekitd_` to `sourcekitd_api_` and add nullability annotations to sourcekit_functions.h

Author: ahoppen

Sources/Csourcekitd/include/sourcekitd_functions.h

@@ -18,17 +18,16 @@ extension SourceKitD {
   public func run(requestYaml: String) async throws -> SKDResponse {
     let request = try requestYaml.cString(using: .utf8)?.withUnsafeBufferPointer { buffer in
       var error: UnsafeMutablePointer<CChar>?
-      let req = api.request_create_from_yaml(buffer.baseAddress, &error)
+      let req = api.request_create_from_yaml(buffer.baseAddress!, &error)
       if let error {
         throw ReductionError("Failed to parse sourcekitd request from YAML: \(String(cString: error))")
       }
-      precondition(req != nil)
       return req
     }
     return await withCheckedContinuation { continuation in
-      var handle: sourcekitd_request_handle_t? = nil
-      api.send_request(request, &handle) { resp in
-        continuation.resume(returning: SKDResponse(resp, sourcekitd: self))
+      var handle: sourcekitd_api_request_handle_t? = nil
+      api.send_request(request!, &handle) { response in
+        continuation.resume(returning: SKDResponse(response!, sourcekitd: self))
       }
     }
   }

Sources/Diagnose/SourceKitD+RunWithYaml.swift

@@ -39,8 +39,25 @@ public struct SourceKitdRequestCommand: AsyncParsableCommand {
 
   public func run() async throws {
     let requestString = try String(contentsOf: URL(fileURLWithPath: sourcekitdRequestPath))
-    let sourcekitd = try SourceKitDImpl.getOrCreate(dylibPath: try! AbsolutePath(validating: sourcekitdPath))
-    let response = try await sourcekitd.run(requestYaml: requestString)
+
+    let sourcekitd = try SourceKitDImpl.getOrCreate(
+      dylibPath: try! AbsolutePath(validating: sourcekitdPath)
+    )
+
+    let request = try requestString.cString(using: .utf8)!.withUnsafeBufferPointer { buffer in
+      var error: UnsafeMutablePointer<CChar>?
+      let req = sourcekitd.api.request_create_from_yaml(buffer.baseAddress!, &error)!
+      if let error {
+        throw ReductionError("Failed to parse sourcekitd request from JSON: \(String(cString: error))")
+      }
+      return req
+    }
+    let response: SKDResponse = await withCheckedContinuation { continuation in
+      var handle: sourcekitd_api_request_handle_t? = nil
+      sourcekitd.api.send_request(request, &handle) { resp in
+        continuation.resume(returning: SKDResponse(resp!, sourcekitd: sourcekitd))
+      }
+    }
 
     switch response.error {
     case .requestFailed, .requestInvalid, .requestCancelled, .missingRequiredSymbol:

Sources/Diagnose/SourcekitdRequestCommand.swift

@@ -32,11 +32,11 @@ extension SourceKitD {
 }
 
 public final class SKDRequestArray {
-  public let array: sourcekitd_object_t?
+  public let array: sourcekitd_api_object_t
   public let sourcekitd: SourceKitD
 
-  public init(_ array: sourcekitd_object_t? = nil, sourcekitd: SourceKitD) {
-    self.array = array ?? sourcekitd.api.request_array_create(nil, 0)
+  public init(_ array: sourcekitd_api_object_t? = nil, sourcekitd: SourceKitD) {
+    self.array = array ?? sourcekitd.api.request_array_create(nil, 0)!
     self.sourcekitd = sourcekitd
   }
 
@@ -50,15 +50,15 @@ public final class SKDRequestArray {
       sourcekitd.api.request_array_set_string(array, -1, newValue)
     case let newValue as Int:
       sourcekitd.api.request_array_set_int64(array, -1, Int64(newValue))
-    case let newValue as sourcekitd_uid_t:
+    case let newValue as sourcekitd_api_uid_t:
       sourcekitd.api.request_array_set_uid(array, -1, newValue)
     case let newValue as SKDRequestDictionary:
       sourcekitd.api.request_array_set_value(array, -1, newValue.dict)
     case let newValue as SKDRequestArray:
       sourcekitd.api.request_array_set_value(array, -1, newValue.array)
     case let newValue as Array<SKDRequestValue>:
       self.append(sourcekitd.array(newValue))
-    case let newValue as Dictionary<sourcekitd_uid_t, SKDRequestValue>:
+    case let newValue as Dictionary<sourcekitd_api_uid_t, SKDRequestValue>:
       self.append(sourcekitd.dictionary(newValue))
     case let newValue as Optional<SKDRequestValue>:
       if let newValue {

Sources/SourceKitD/SKDRequestArray.swift

@@ -31,16 +31,16 @@ public protocol SKDRequestValue {}
 
 extension String: SKDRequestValue {}
 extension Int: SKDRequestValue {}
-extension sourcekitd_uid_t: SKDRequestValue {}
+extension sourcekitd_api_uid_t: SKDRequestValue {}
 extension SKDRequestDictionary: SKDRequestValue {}
 extension SKDRequestArray: SKDRequestValue {}
 extension Array<SKDRequestValue>: SKDRequestValue {}
-extension Dictionary<sourcekitd_uid_t, SKDRequestValue>: SKDRequestValue {}
+extension Dictionary<sourcekitd_api_uid_t, SKDRequestValue>: SKDRequestValue {}
 extension Optional: SKDRequestValue where Wrapped: SKDRequestValue {}
 
 extension SourceKitD {
   /// Create a `SKDRequestDictionary` from the given dictionary.
-  public func dictionary(_ dict: [sourcekitd_uid_t: SKDRequestValue]) -> SKDRequestDictionary {
+  public func dictionary(_ dict: [sourcekitd_api_uid_t: SKDRequestValue]) -> SKDRequestDictionary {
     let result = SKDRequestDictionary(sourcekitd: self)
     for (key, value) in dict {
       result.set(key, to: value)
@@ -50,33 +50,33 @@ extension SourceKitD {
 }
 
 public final class SKDRequestDictionary {
-  public let dict: sourcekitd_object_t?
+  public let dict: sourcekitd_api_object_t
   public let sourcekitd: SourceKitD
 
-  public init(_ dict: sourcekitd_object_t? = nil, sourcekitd: SourceKitD) {
-    self.dict = dict ?? sourcekitd.api.request_dictionary_create(nil, nil, 0)
+  public init(_ dict: sourcekitd_api_object_t? = nil, sourcekitd: SourceKitD) {
+    self.dict = dict ?? sourcekitd.api.request_dictionary_create(nil, nil, 0)!
     self.sourcekitd = sourcekitd
   }
 
   deinit {
     sourcekitd.api.request_release(dict)
   }
 
-  public func set(_ key: sourcekitd_uid_t, to newValue: SKDRequestValue) {
+  public func set(_ key: sourcekitd_api_uid_t, to newValue: SKDRequestValue) {
     switch newValue {
     case let newValue as String:
       sourcekitd.api.request_dictionary_set_string(dict, key, newValue)
     case let newValue as Int:
       sourcekitd.api.request_dictionary_set_int64(dict, key, Int64(newValue))
-    case let newValue as sourcekitd_uid_t:
+    case let newValue as sourcekitd_api_uid_t:
       sourcekitd.api.request_dictionary_set_uid(dict, key, newValue)
     case let newValue as SKDRequestDictionary:
       sourcekitd.api.request_dictionary_set_value(dict, key, newValue.dict)
     case let newValue as SKDRequestArray:
       sourcekitd.api.request_dictionary_set_value(dict, key, newValue.array)
     case let newValue as Array<SKDRequestValue>:
       self.set(key, to: sourcekitd.array(newValue))
-    case let newValue as Dictionary<sourcekitd_uid_t, SKDRequestValue>:
+    case let newValue as Dictionary<sourcekitd_api_uid_t, SKDRequestValue>:
       self.set(key, to: sourcekitd.dictionary(newValue))
     case let newValue as Optional<SKDRequestValue>:
       if let newValue {

Sources/SourceKitD/SKDRequestDictionary.swift

@@ -22,10 +22,10 @@ import CRT
 #endif
 
 public final class SKDResponse {
-  public let response: sourcekitd_response_t?
+  public let response: sourcekitd_api_response_t
   public let sourcekitd: SourceKitD
 
-  public init(_ response: sourcekitd_response_t?, sourcekitd: SourceKitD) {
+  public init(_ response: sourcekitd_api_response_t, sourcekitd: SourceKitD) {
     self.response = response
     self.sourcekitd = sourcekitd
   }
@@ -39,10 +39,10 @@ public final class SKDResponse {
       return nil
     }
     switch sourcekitd.api.response_error_get_kind(response) {
-    case SOURCEKITD_ERROR_CONNECTION_INTERRUPTED: return .connectionInterrupted
-    case SOURCEKITD_ERROR_REQUEST_INVALID: return .requestInvalid(description)
-    case SOURCEKITD_ERROR_REQUEST_FAILED: return .requestFailed(description)
-    case SOURCEKITD_ERROR_REQUEST_CANCELLED: return .requestCancelled
+    case SOURCEKITD_API_ERROR_CONNECTION_INTERRUPTED: return .connectionInterrupted
+    case SOURCEKITD_API_ERROR_REQUEST_INVALID: return .requestInvalid(description)
+    case SOURCEKITD_API_ERROR_REQUEST_FAILED: return .requestFailed(description)
+    case SOURCEKITD_API_ERROR_REQUEST_CANCELLED: return .requestCancelled
     default: return .requestFailed(description)
     }
   }

Sources/SourceKitD/SKDResponse.swift

@@ -21,12 +21,12 @@ import CRT
 #endif
 
 public final class SKDResponseArray {
-  public let array: sourcekitd_variant_t
+  public let array: sourcekitd_api_variant_t
   let resp: SKDResponse
 
   public var sourcekitd: SourceKitD { return resp.sourcekitd }
 
-  public init(_ array: sourcekitd_variant_t, response: SKDResponse) {
+  public init(_ array: sourcekitd_api_variant_t, response: SKDResponse) {
     self.array = array
     self.resp = response
   }
@@ -46,7 +46,7 @@ public final class SKDResponseArray {
 
   /// If the `applier` returns `false`, iteration terminates.
   @discardableResult
-  public func forEachUID(_ applier: (Int, sourcekitd_uid_t) throws -> Bool) rethrows -> Bool {
+  public func forEachUID(_ applier: (Int, sourcekitd_api_uid_t) throws -> Bool) rethrows -> Bool {
     for i in 0..<count {
       if let uid = sourcekitd.api.variant_array_get_uid(array, i), try !applier(i, uid) {
         return false

Sources/SourceKitD/SKDResponseArray.swift

@@ -21,41 +21,41 @@ import CRT
 #endif
 
 public final class SKDResponseDictionary {
-  public let dict: sourcekitd_variant_t
+  public let dict: sourcekitd_api_variant_t
   let resp: SKDResponse
 
   public var sourcekitd: SourceKitD { return resp.sourcekitd }
 
-  public init(_ dict: sourcekitd_variant_t, response: SKDResponse) {
+  public init(_ dict: sourcekitd_api_variant_t, response: SKDResponse) {
     self.dict = dict
     self.resp = response
   }
 
-  public subscript(key: sourcekitd_uid_t?) -> String? {
+  public subscript(key: sourcekitd_api_uid_t) -> String? {
     return sourcekitd.api.variant_dictionary_get_string(dict, key).map(String.init(cString:))
   }
-  public subscript(key: sourcekitd_uid_t?) -> Int? {
+  public subscript(key: sourcekitd_api_uid_t) -> Int? {
     let value = sourcekitd.api.variant_dictionary_get_value(dict, key)
-    if sourcekitd.api.variant_get_type(value) == SOURCEKITD_VARIANT_TYPE_INT64 {
+    if sourcekitd.api.variant_get_type(value) == SOURCEKITD_API_VARIANT_TYPE_INT64 {
       return Int(sourcekitd.api.variant_int64_get_value(value))
     } else {
       return nil
     }
   }
-  public subscript(key: sourcekitd_uid_t?) -> Bool? {
+  public subscript(key: sourcekitd_api_uid_t) -> Bool? {
     let value = sourcekitd.api.variant_dictionary_get_value(dict, key)
-    if sourcekitd.api.variant_get_type(value) == SOURCEKITD_VARIANT_TYPE_BOOL {
+    if sourcekitd.api.variant_get_type(value) == SOURCEKITD_API_VARIANT_TYPE_BOOL {
       return sourcekitd.api.variant_bool_get_value(value)
     } else {
       return nil
     }
   }
-  public subscript(key: sourcekitd_uid_t?) -> sourcekitd_uid_t? {
+  public subscript(key: sourcekitd_api_uid_t) -> sourcekitd_api_uid_t? {
     return sourcekitd.api.variant_dictionary_get_uid(dict, key)
   }
-  public subscript(key: sourcekitd_uid_t?) -> SKDResponseArray? {
+  public subscript(key: sourcekitd_api_uid_t) -> SKDResponseArray? {
     let value = sourcekitd.api.variant_dictionary_get_value(dict, key)
-    if sourcekitd.api.variant_get_type(value) == SOURCEKITD_VARIANT_TYPE_ARRAY {
+    if sourcekitd.api.variant_get_type(value) == SOURCEKITD_API_VARIANT_TYPE_ARRAY {
       return SKDResponseArray(value, response: resp)
     } else {
       return nil

Sources/SourceKitD/SKDResponseDictionary.swift

@@ -26,16 +26,16 @@ import SKSupport
 /// `deinit` or by wrapping an existing sourcekitd session that outlives this object.
 public protocol SourceKitD: AnyObject {
   /// The sourcekitd API functions.
-  var api: sourcekitd_functions_t { get }
+  var api: sourcekitd_api_functions_t { get }
 
   /// Convenience for accessing known keys.
-  var keys: sourcekitd_keys { get }
+  var keys: sourcekitd_api_keys { get }
 
   /// Convenience for accessing known keys.
-  var requests: sourcekitd_requests { get }
+  var requests: sourcekitd_api_requests { get }
 
   /// Convenience for accessing known keys.
-  var values: sourcekitd_values { get }
+  var values: sourcekitd_api_values { get }
 
   /// Adds a new notification handler, which will be weakly referenced.
   func addNotificationHandler(_ handler: SKDNotificationHandler)
@@ -77,9 +77,9 @@ extension SourceKitD {
     let signposterState = signposter.beginInterval("sourcekitd-request", id: signpostID, "Start")
 
     let sourcekitdResponse: SKDResponse = try await withCancellableCheckedThrowingContinuation { continuation in
-      var handle: sourcekitd_request_handle_t? = nil
-      api.send_request(req.dict, &handle) { _resp in
-        continuation.resume(returning: SKDResponse(_resp, sourcekitd: self))
+      var handle: sourcekitd_api_request_handle_t? = nil
+      api.send_request(req.dict, &handle) { response in
+        continuation.resume(returning: SKDResponse(response!, sourcekitd: self))
       }
       return handle
     } cancel: { handle in

Sources/SourceKitD/SourceKitD.swift

@@ -29,29 +29,23 @@ public final class SourceKitDImpl: SourceKitD {
   let dylib: DLHandle
 
   /// The sourcekitd API functions.
-  public let api: sourcekitd_functions_t
+  public let api: sourcekitd_api_functions_t
 
   /// Convenience for accessing known keys.
-  public let keys: sourcekitd_keys
+  public let keys: sourcekitd_api_keys
 
   /// Convenience for accessing known keys.
-  public let requests: sourcekitd_requests
+  public let requests: sourcekitd_api_requests
 
   /// Convenience for accessing known keys.
-  public let values: sourcekitd_values
+  public let values: sourcekitd_api_values
 
   /// Lock protecting private state.
   let lock: NSLock = NSLock()
 
   /// List of notification handlers that will be called for each notification.
   private var _notificationHandlers: [WeakSKDNotificationHandler] = []
 
-  var notificationHandlers: [SKDNotificationHandler] {
-    lock.withLock {
-      _notificationHandlers.compactMap { $0.value }
-    }
-  }
-
   public static func getOrCreate(dylibPath: AbsolutePath) throws -> SourceKitD {
     try SourceKitDRegistry.shared
       .getOrAdd(dylibPath, create: { try SourceKitDImpl(dylib: dylibPath) })
@@ -64,14 +58,14 @@ public final class SourceKitDImpl: SourceKitD {
     #else
     self.dylib = try dlopen(path.pathString, mode: [.lazy, .local, .first])
     #endif
-    self.api = try sourcekitd_functions_t(self.dylib)
-    self.keys = sourcekitd_keys(api: self.api)
-    self.requests = sourcekitd_requests(api: self.api)
-    self.values = sourcekitd_values(api: self.api)
+    self.api = try sourcekitd_api_functions_t(self.dylib)
+    self.keys = sourcekitd_api_keys(api: self.api)
+    self.requests = sourcekitd_api_requests(api: self.api)
+    self.values = sourcekitd_api_values(api: self.api)
 
     self.api.initialize()
     self.api.set_notification_handler { [weak self] rawResponse in
-      guard let self = self else { return }
+      guard let self, let rawResponse else { return }
       let handlers = self.lock.withLock { self._notificationHandlers.compactMap(\.value) }
 
       let response = SKDResponse(rawResponse, sourcekitd: self)