Merge pull request #1092 from ahoppen/ahoppen/diagnose-improvements

Improvements to the diagnose subcommands

Author: ahoppen

Sources/Diagnose/RequestInfo.swift

@@ -70,11 +70,16 @@ public struct RequestInfo {
       "key.offset: "
       Capture(ZeroOrMore(.digit))
     }
-    guard let offsetMatch = requestTemplate.matches(of: offsetRegex).only else {
-      throw ReductionError("Failed to find key.offset in the request")
+    if let offsetMatch = requestTemplate.matches(of: offsetRegex).only {
+      offset = Int(offsetMatch.1)!
+      requestTemplate.replace(offsetRegex, with: "key.offset: $OFFSET")
+    } else {
+      offset = 0
     }
-    offset = Int(offsetMatch.1)!
-    requestTemplate.replace(offsetRegex, with: "key.offset: $OFFSET")
+
+    // If the request contained source text, remove it. We want to pick it up from the file on disk and most (possibly
+    // all) sourcekitd requests use key.sourcefile if key.sourcetext is missing.
+    requestTemplate.replace(#/ *key.sourcetext: .*\n/#, with: "")
 
     // Extract source file
     let sourceFileRegex = Regex {

Sources/Diagnose/SourcekitdRequestCommand.swift

@@ -12,6 +12,7 @@
 
 import ArgumentParser
 import Foundation
+import SKSupport
 import SourceKitD
 
 import struct TSCBasic.AbsolutePath
@@ -35,15 +36,32 @@ public struct SourceKitdRequestCommand: AsyncParsableCommand {
   )
   var sourcekitdRequestPath: String
 
+  @Option(help: "line:column override for key.offset")
+  var position: String?
+
   public init() {}
 
   public func run() async throws {
-    let requestString = try String(contentsOf: URL(fileURLWithPath: sourcekitdRequestPath))
+    var requestString = try String(contentsOf: URL(fileURLWithPath: sourcekitdRequestPath))
 
     let sourcekitd = try 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)
+      if 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)!
@@ -60,7 +78,17 @@ public struct SourceKitdRequestCommand: AsyncParsableCommand {
     }
 
     switch response.error {
-    case .requestFailed, .requestInvalid, .requestCancelled, .missingRequiredSymbol:
+    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 .missingRequiredSymbol:
+      print("missing required symbol")
       throw ExitCode(1)
     case .connectionInterrupted:
       throw ExitCode(255)

Sources/SKSupport/LineTable.swift

@@ -147,10 +147,14 @@ extension LineTable {
   /// - parameter utf8Column: UTF-8 column offset (zero-based).
   @inlinable
   public func stringIndexOf(line: Int, utf8Column: Int) -> String.Index? {
-    guard line < count else {
+    guard 0 <= line, line < count else {
       // Line out of range.
       return nil
     }
+    guard 0 <= utf8Column else {
+      // Column out of range.
+      return nil
+    }
     let lineSlice = self[line]
     return content.utf8.index(lineSlice.startIndex, offsetBy: utf8Column, limitedBy: lineSlice.endIndex)
   }