Files
sourcekit-lsp/Sources/SourceKitD/SKDResponseArray.swift
Alex Hoppen f5fb23ad4c Rename sourcekitd_ to sourcekitd_api_ and add nullability annotations to sourcekit_functions.h
Naming types in sourcekitd_functions.h `sourcekit_api_` instead of `sourcekitd_` indicates that these are types to be used with dynamically loaded sourcekitd libraries. It avoids confusion if sourcekitd is also linked, which adds the `sourcekitd_` symbols.

Adding nullability annotations to it is also just nice.

And some improved formatting never hurts.
2024-02-23 09:13:42 -08:00

95 lines
2.7 KiB
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Csourcekitd
#if canImport(Glibc)
import Glibc
#elseif canImport(Musl)
import Musl
#elseif canImport(CRT)
import CRT
#endif
public final class SKDResponseArray {
public let array: sourcekitd_api_variant_t
let resp: SKDResponse
public var sourcekitd: SourceKitD { return resp.sourcekitd }
public init(_ array: sourcekitd_api_variant_t, response: SKDResponse) {
self.array = array
self.resp = response
}
public var count: Int { return sourcekitd.api.variant_array_get_count(array) }
/// If the `applier` returns `false`, iteration terminates.
@discardableResult
public func forEach(_ applier: (Int, SKDResponseDictionary) throws -> Bool) rethrows -> Bool {
for i in 0..<count {
if try !applier(i, SKDResponseDictionary(sourcekitd.api.variant_array_get_value(array, i), response: resp)) {
return false
}
}
return true
}
/// If the `applier` returns `false`, iteration terminates.
@discardableResult
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
}
}
return true
}
public func map<T>(_ transform: (SKDResponseDictionary) throws -> T) rethrows -> [T] {
var result: [T] = []
result.reserveCapacity(self.count)
try self.forEach { _, element in
result.append(try transform(element))
return true
}
return result
}
public func compactMap<T>(_ transform: (SKDResponseDictionary) throws -> T?) rethrows -> [T] {
var result: [T] = []
try self.forEach { _, element in
if let transformed = try transform(element) {
result.append(transformed)
}
return true
}
return result
}
/// Attempt to access the item at `index` as a string.
public subscript(index: Int) -> String? {
if let cstr = sourcekitd.api.variant_array_get_string(array, index) {
return String(cString: cstr)
}
return nil
}
}
extension SKDResponseArray: CustomStringConvertible {
public var description: String {
let ptr = sourcekitd.api.variant_description_copy(array)!
defer { free(ptr) }
return String(cString: ptr)
}
}