File: SKDRequestArrayReader.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (69 lines) | stat: -rw-r--r-- 2,273 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2024 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
import SourceKitD

/// Provide getters to get values for a sourcekitd request array.
///
/// This is not part of the `SourceKitD` module because it uses `SourceKitD.servicePluginAPI` which must not be accessed
/// outside of the service plugin.
final class SKDRequestArrayReader: Sendable {
  nonisolated(unsafe) let array: sourcekitd_api_object_t
  private let sourcekitd: SourceKitD

  /// Creates an `SKDRequestArray` that essentially provides a view into the given opaque `sourcekitd_api_object_t`.
  init(_ array: sourcekitd_api_object_t, sourcekitd: SourceKitD) {
    self.array = array
    self.sourcekitd = sourcekitd
    _ = sourcekitd.api.request_retain(array)
  }

  deinit {
    _ = sourcekitd.api.request_release(array)
  }

  var count: Int { return sourcekitd.servicePluginApi.request_array_get_count(array) }

  /// If the `applier` returns `false`, iteration terminates.
  @discardableResult
  func forEach(_ applier: (Int, SKDRequestDictionaryReader) throws -> Bool) rethrows -> Bool {
    for i in 0..<count {
      let value = sourcekitd.servicePluginApi.request_array_get_value(array, i)!
      guard let dict = SKDRequestDictionaryReader(value, sourcekitd: sourcekitd) else {
        continue
      }
      if try !applier(i, dict) {
        return false
      }
    }
    return true
  }

  /// Attempt to access the item at `index` as a string.
  subscript(index: Int) -> String? {
    if let cstr = sourcekitd.servicePluginApi.request_array_get_string(array, index) {
      return String(cString: cstr)
    }
    return nil
  }

  var asStringArray: [String] {
    var result: [String] = []
    for i in 0..<count {
      if let string = self[i] {
        result.append(string)
      }
    }
    return result
  }
}