File: RunSourcekitdRequestCommand.swift

package info (click to toggle)
swiftlang 6.1.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,791,604 kB
  • sloc: cpp: 9,901,740; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (121 lines) | stat: -rw-r--r-- 4,064 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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 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
//
//===----------------------------------------------------------------------===//

#if compiler(>=6)
package import ArgumentParser
import Csourcekitd
import Foundation
import SKUtilities
import SwiftExtensions
import SourceKitD
import ToolchainRegistry

import struct TSCBasic.AbsolutePath
#else
import ArgumentParser
import Csourcekitd
import Foundation
import SKUtilities
import SourceKitD
import SwiftExtensions
import ToolchainRegistry

import struct TSCBasic.AbsolutePath
#endif

package struct RunSourceKitdRequestCommand: AsyncParsableCommand {
  package static let configuration = CommandConfiguration(
    commandName: "run-sourcekitd-request",
    abstract: "Run a sourcekitd request and print its result"
  )

  @Option(
    name: .customLong("sourcekitd"),
    help: "Path to sourcekitd.framework/sourcekitd"
  )
  var sourcekitdPath: String?

  @Option(
    name: .customLong("request-file"),
    help:
      "Path to a JSON sourcekitd request. Multiple may be passed to run them in sequence on the same sourcekitd instance"
  )
  var sourcekitdRequestPaths: [String]

  @Option(help: "line:column override for key.offset")
  var position: String?

  package init() {}

  package func run() async throws {
    let sourcekitdPath =
      if let sourcekitdPath {
        URL(fileURLWithPath: sourcekitdPath)
      } else if let path = await ToolchainRegistry(installPath: Bundle.main.bundleURL).default?.sourcekitd {
        path
      } else {
        print("Did not find sourcekitd in the toolchain. Specify path to sourcekitd manually by passing --sourcekitd")
        throw ExitCode(1)
      }
    let sourcekitd = try await DynamicallyLoadedSourceKitD.getOrCreate(
      dylibPath: sourcekitdPath
    )

    var lastResponse: SKDResponse?

    for sourcekitdRequestPath in sourcekitdRequestPaths {
      var requestString = try String(contentsOf: URL(fileURLWithPath: sourcekitdRequestPath), encoding: .utf8)
      if let lineColumn = position?.split(separator: ":", maxSplits: 2).map({ Int($0) }),
        lineColumn.count == 2,
        let line = lineColumn[0],
        let column = lineColumn[1]
      {
        let requestInfo = try RequestInfo(request: requestString)

        let lineTable = LineTable(requestInfo.fileContents)
        let offset = lineTable.utf8OffsetOf(line: line - 1, utf8Column: column - 1)
        print("Adjusting request offset to \(offset)")
        requestString.replace(#/key.offset: [0-9]+/#, with: "key.offset: \(offset)")
      }

      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 GenericError("Failed to parse sourcekitd request from YAML: \(String(cString: error))")
        }
        guard let req else {
          throw GenericError("Failed to parse request from YAML but did not produce error")
        }
        return req
      }
      let response = 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))
        }
      }
      lastResponse = response

      print(response.description)
    }

    switch lastResponse?.error {
    case .requestFailed, .requestInvalid, .requestCancelled, .timedOut, .missingRequiredSymbol:
      throw ExitCode(1)
    case .connectionInterrupted:
      throw ExitCode(255)
    case nil:
      break
    }
  }
}