File: RunSourcekitdRequestCommand.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (111 lines) | stat: -rw-r--r-- 3,753 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
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

import ArgumentParser
import Foundation
import SKCore
import SKSupport
import SourceKitD

import struct TSCBasic.AbsolutePath

public struct RunSourceKitdRequestCommand: AsyncParsableCommand {
  public 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"
  )
  var sourcekitdRequestPath: String

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

  public init() {}

  public func run() async throws {
    var requestString = try String(contentsOf: URL(fileURLWithPath: sourcekitdRequestPath))

    let installPath = try AbsolutePath(validating: Bundle.main.bundlePath)
    let sourcekitdPath =
      if let sourcekitdPath {
        sourcekitdPath
      } else if let path = await ToolchainRegistry(installPath: installPath).default?.sourcekitd?.pathString {
        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: try! AbsolutePath(validating: sourcekitdPath)
    )

    if let lineColumn = position?.split(separator: ":", maxSplits: 2).map(Int.init),
      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 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(let message):
      print(message)
      throw ExitCode(1)
    case .requestInvalid(let message):
      print(message)
      throw ExitCode(1)
    case .requestCancelled:
      print("request cancelled")
      throw ExitCode(1)
    case .timedOut:
      print("request timed out")
      throw ExitCode(1)
    case .missingRequiredSymbol:
      print("missing required symbol")
      throw ExitCode(1)
    case .connectionInterrupted:
      throw ExitCode(255)
    case nil:
      print(response.description)
    }
  }
}