Upgrade SwiftPM dependency to master branch

We are tied to using a SwiftPM that matches the toolchain, so upgrade
from 0.3.0 to .branch("master") and add a pins file to manage updating
that dependency.

This was driven by changes that broke loading packages being developed
with newer version of SwiftPM when using the 0.3.0 tag of libSwiftPM.
However, the changes seem to work when going in the other direction, so
using the newer libSwiftPM hasn't caused any known regressions for using
older toolchain versions (not guarantteed and not tested extensively
though).

This fixes using the latest (November 13) toolchain snapshot on macOS.
On Linux there are other issues not specific to LSP.

Author: benlangmuir

.gitignore

@@ -1,6 +1,5 @@
 .DS_Store
 default.profraw
-Package.resolved
 /.build
 /Packages
 /*.xcodeproj

Package.resolved

@@ -7,7 +7,7 @@ let package = Package(
     products: [
     ],
     dependencies: [
-      .package(url: "https://github.com/apple/swift-package-manager.git", "0.3.0"..<"0.4.0"),
+      .package(url: "https://github.com/apple/swift-package-manager.git", .branch("master")),
       .package(url: "https://github.com/apple/indexstore-db.git", .branch("master")),
     ],
     targets: [

Package.swift

@@ -25,7 +25,7 @@ public enum DiagnosticCode: Hashable {
 public struct Diagnostic: Codable, Hashable {
 
   /// The primary position/range of the diagnostic.
-  public var range: Range<Position>
+  public var range: PositionRange
 
   /// Whether this is a warning, error, etc.
   public var severity: DiagnosticSeverity?
@@ -43,7 +43,7 @@ public struct Diagnostic: Codable, Hashable {
   public var relatedInformation: [DiagnosticRelatedInformation]?
 
   public init(range: Range<Position>, severity: DiagnosticSeverity?, code: DiagnosticCode? = nil, source: String?, message: String, relatedInformation: [DiagnosticRelatedInformation]? = nil) {
-    self.range = range
+    self.range = PositionRange(range)
     self.severity = severity
     self.code = code
     self.source = source

Sources/LanguageServerProtocol/Diagnostic.swift

@@ -19,13 +19,13 @@ public enum DocumentHighlightKind: Int, Codable, Hashable {
 public struct DocumentHighlight: ResponseType, Hashable {
 
   /// The location of the highlight.
-  public var range: Range<Position>
+  public var range: PositionRange
 
   /// What kind of reference this is. Default is `.text`.
   public var kind: DocumentHighlightKind?
 
   public init(range: Range<Position>, kind: DocumentHighlightKind?) {
-    self.range = range
+    self.range = PositionRange(range)
     self.kind = kind
   }
 }

Sources/LanguageServerProtocol/DocumentHighlight.swift

@@ -13,21 +13,18 @@
 /// Range within a particular document.
 ///
 /// For a location where the document is implied, use `Position` or `Range<Position>`.
-public struct Location {
+public struct Location: Hashable {
 
   public var url: URL
 
-  public var range: Range<Position>
+  public var range: PositionRange
 
   public init(url: URL, range: Range<Position>) {
     self.url = url
-    self.range = range
+    self.range = PositionRange(range)
   }
 }
 
-extension Location: Equatable {}
-extension Location: Hashable {}
-
 // Encode using the key "uri" to match LSP.
 extension Location: Codable {
   private enum CodingKeys: String, CodingKey {

Sources/LanguageServerProtocol/Location.swift

@@ -309,7 +309,7 @@ public struct HoverResponse: ResponseType, Hashable {
 
   public var contents: MarkupContent
 
-  public var range: Range<Position>?
+  public var range: PositionRange?
 
   /// Extension!
   public var usr: String?
@@ -319,7 +319,7 @@ public struct HoverResponse: ResponseType, Hashable {
 
   public init(contents: MarkupContent, range: Range<Position>?, usr: String?, definition: Location?) {
     self.contents = contents
-    self.range = range
+    self.range = range.map { PositionRange($0) }
     self.usr = usr
     self.definition = definition
   }
@@ -378,7 +378,7 @@ public struct DocumentRangeFormatting: TextDocumentRequest, Hashable {
 
   public var textDocument: TextDocumentIdentifier
 
-  public var range: Range<Position>
+  public var range: PositionRange
 
   public var options: FormattingOptions
 }

Sources/LanguageServerProtocol/Messages.swift

@@ -11,7 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 /// Position within a text document, expressed as a zero-based line and column (utf-16 code unit offset).
-public struct Position {
+public struct Position: Hashable {
 
   /// Line number within a document (zero-based).
   public var line: Int
@@ -25,8 +25,6 @@ public struct Position {
   }
 }
 
-extension Position: Equatable {}
-extension Position: Hashable {}
 extension Position: Codable {
   private enum CodingKeys: String, CodingKey {
     case line
@@ -39,29 +37,3 @@ extension Position: Comparable {
     return (lhs.line, lhs.utf16index) < (rhs.line, rhs.utf16index)
   }
 }
-
-// Encode Range<Position> using the keys "start" and "end" to match the LSP protocol for "Range".
-extension Range: Codable where Bound == Position {
-  private enum CodingKeys: String, CodingKey {
-    case lowerBound = "start"
-    case upperBound = "end"
-  }
-
-  /// Create a range for a single position.
-  public init(_ pos: Position) {
-    self = pos ..< pos
-  }
-
-  public init(from decoder: Decoder) throws {
-    let values = try decoder.container(keyedBy: CodingKeys.self)
-    let lowerBound = try values.decode(Position.self, forKey: .lowerBound)
-    let upperBound = try values.decode(Position.self, forKey: .upperBound)
-    self = lowerBound ..< upperBound
-  }
-
-  public func encode(to encoder: Encoder) throws {
-    var container = encoder.container(keyedBy: CodingKeys.self)
-    try container.encode(lowerBound, forKey: .lowerBound)
-    try container.encode(upperBound, forKey: .upperBound)
-  }
-}

Sources/LanguageServerProtocol/Position.swift

@@ -0,0 +1,47 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2018 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
+//
+//===----------------------------------------------------------------------===//
+
+/// Half-open range of Positions `[start, end)` within a text document, for use in LSP messages.
+///
+/// It is generally preferred to work with Range<Position> directly, but when passing values in LSP
+/// messages, use PositionRange to provide the correct (de)serialization.
+public struct PositionRange: Hashable {
+
+  /// The `lowerBound` of the range (inclusive).
+  public var lowerBound: Position
+
+  /// The `upperBound` of the range (exclusive).
+  public var upperBound: Position
+
+  /// The equivalent range expressed as a `Swift.Range`.
+  public var asRange: Range<Position> { return lowerBound..<upperBound}
+
+  public init(_ range: Range<Position>) {
+    self.lowerBound = range.lowerBound
+    self.upperBound = range.upperBound
+  }
+}
+
+extension PositionRange: Codable {
+  private enum CodingKeys: String, CodingKey {
+    case lowerBound = "start"
+    case upperBound = "end"
+  }
+}
+
+extension Range where Bound == Position {
+
+  /// Create a range for a single position.
+  public init(_ pos: Position) {
+    self = pos ..< pos
+  }
+}

Sources/LanguageServerProtocol/PositionRange.swift

@@ -17,14 +17,14 @@
 /// The `range.end` and `rangeLength` are potentially redundant. Based on https://github.com/Microsoft/language-server-protocol/issues/9, servers should be lenient and accept either.
 public struct TextDocumentContentChangeEvent: Codable, Hashable {
 
-  public var range: Range<Position>?
+  public var range: PositionRange?
 
   public var rangeLength: Int?
 
   public var text: String
 
   public init(range: Range<Position>? = nil, rangeLength: Int? = nil, text: String) {
-    self.range = range
+    self.range = range.map { PositionRange($0) }
     self.rangeLength = rangeLength
     self.text = text
   }

Sources/LanguageServerProtocol/TextDocumentContentChangeEvent.swift

@@ -14,13 +14,13 @@
 public struct TextEdit: Codable, Hashable {
 
   /// The range of text to be replaced.
-  var range: Range<Position>
+  var range: PositionRange
 
   /// The new text.
   var newText: String
 
   public init(range: Range<Position>, newText: String) {
-    self.range = range
+    self.range = PositionRange(range)
     self.newText = newText
   }
 }

Sources/LanguageServerProtocol/TextEdit.swift

@@ -16,7 +16,7 @@ import SKSupport
 struct MessageHeader: Hashable {
   static let contentLengthKey: [UInt8] = [UInt8]("Content-Length".utf8)
   static let separator: [UInt8] = [UInt8]("\r\n".utf8)
-  static let colon: UInt8 = ":".utf8.only!
+  static let colon: UInt8 = ":".utf8.spm_only!
   static let invalidKeyBytes: [UInt8] = [colon] + separator
 
   var contentLength: Int? = nil

Sources/LanguageServerProtocolJSONRPC/MessageSplitting.swift

@@ -19,7 +19,7 @@ public final class FallbackBuildSettingsProvider: BuildSettingsProvider {
 
   lazy var sdkpath: AbsolutePath? = {
     if case .darwin? = Platform.currentPlatform {
-      if let str = try? Process.checkNonZeroExit(args: "/usr/bin/xcrun", "--show-sdk-path", "--sdk", "macosx"), let path = try? AbsolutePath(validating: str.chomp()) {
+      if let str = try? Process.checkNonZeroExit(args: "/usr/bin/xcrun", "--show-sdk-path", "--sdk", "macosx"), let path = try? AbsolutePath(validating: str.spm_chomp()) {
         return path
       }
     }

Sources/SKCore/FallbackBuildSettingsProvider.swift

@@ -141,7 +141,7 @@ extension ToolchainRegistry {
     ]
 
   var currentXcodeDeveloperPath: AbsolutePath? {
-    if let str = try? Process.checkNonZeroExit(args: "/usr/bin/xcode-select", "-p"), let path = try? AbsolutePath(validating: str.chomp()) {
+    if let str = try? Process.checkNonZeroExit(args: "/usr/bin/xcode-select", "-p"), let path = try? AbsolutePath(validating: str.spm_chomp()) {
       return path
     }
     return nil

Sources/SKCore/ToolchainRegistry.swift

@@ -34,18 +34,3 @@ extension Result {
     }
   }
 }
-
-extension Result: Equatable where Value: Equatable, ErrorType: Equatable {
-
-  @inlinable
-  public static func ==(lhs: Result, rhs: Result) -> Bool {
-    switch (lhs, rhs) {
-    case (.success(let lhs), .success(let rhs)):
-      return lhs == rhs
-    case (.failure(let lhs), .failure(let rhs)):
-      return lhs == rhs
-    default:
-      return false
-    }
-  }
-}

Sources/SKSupport/Result.swift

@@ -37,8 +37,8 @@ public final class SwiftPMWorkspace {
   let toolchainRegistry: ToolchainRegistry
   let fs: FileSystem
 
-  var fileToTarget: [AbsolutePath: TargetDescription] = [:]
-  var sourceDirToTarget: [AbsolutePath: TargetDescription] = [:]
+  var fileToTarget: [AbsolutePath: TargetBuildDescription] = [:]
+  var sourceDirToTarget: [AbsolutePath: TargetBuildDescription] = [:]
 
   /// Creates a `BuildSettingsProvider` using the Swift Package Manager, if this workspace is part of a package.
   ///
@@ -77,10 +77,10 @@ public final class SwiftPMWorkspace {
     let target: Triple = Triple.hostTriple
     if case .darwin? = Platform.currentPlatform {
       if let path = try? Process.checkNonZeroExit(args: "/usr/bin/xcrun", "--show-sdk-path", "--sdk", "macosx") {
-        sdkpath = try? AbsolutePath(validating: path.chomp())
+        sdkpath = try? AbsolutePath(validating: path.spm_chomp())
       }
       if let path = try? Process.checkNonZeroExit(args: "/usr/bin/xcrun", "--show-sdk-platform-path", "--sdk", "macosx") {
-        platformPath = try? AbsolutePath(validating: path.chomp())
+        platformPath = try? AbsolutePath(validating: path.spm_chomp())
       }
     }
 
@@ -113,7 +113,7 @@ public final class SwiftPMWorkspace {
       dataPath: packageRoot.appending(component: ".build"),
       editablesPath: packageRoot.appending(component: "Packages"),
       pinsFile: packageRoot.appending(component: "Package.resolved"),
-      manifestLoader: ManifestLoader(resources: swiftpmToolchain),
+      manifestLoader: ManifestLoader(manifestResources: swiftpmToolchain),
       delegate: BuildSettingProviderWorkspaceDelegate(),
       fileSystem: fs,
       skipUpdate: true
@@ -137,7 +137,7 @@ public final class SwiftPMWorkspace {
 
     let plan = try BuildPlan(buildParameters: buildParameters, graph: packageGraph, diagnostics: diags, fileSystem: self.fs)
 
-    self.fileToTarget = [AbsolutePath: TargetDescription](
+    self.fileToTarget = [AbsolutePath: TargetBuildDescription](
       packageGraph.allTargets.flatMap { target in
         return target.sources.paths.compactMap {
           guard let td = plan.targetMap[target] else {
@@ -150,7 +150,7 @@ public final class SwiftPMWorkspace {
         return td
     })
 
-    self.sourceDirToTarget = [AbsolutePath: TargetDescription](
+    self.sourceDirToTarget = [AbsolutePath: TargetBuildDescription](
       packageGraph.allTargets.compactMap { target in
         guard let td = plan.targetMap[target] else {
           return nil
@@ -204,7 +204,11 @@ extension SwiftPMWorkspace {
 
   // MARK: Implementation details
 
-  public func settings(for path: AbsolutePath, language: Language, targetDescription td: TargetDescription) -> FileBuildSettings? {
+  public func settings(
+    for path: AbsolutePath,
+    language: Language,
+    targetDescription td: TargetBuildDescription
+  ) -> FileBuildSettings? {
 
     let buildPath = self.buildPath
 
@@ -300,12 +304,12 @@ extension SwiftPMWorkspace {
   }
 
   func packageDescriptionSettings(_ path: AbsolutePath) -> FileBuildSettings? {
-
     for package in packageGraph.packages {
       if path == package.manifest.path {
         return FileBuildSettings(
           preferredToolchain: nil,
-          compilerArguments: package.manifest.interpreterFlags + [path.asString])
+          compilerArguments:
+            workspace.interpreterFlags(for: package.path) + [path.asString])
       }
     }
     return nil
@@ -332,6 +336,8 @@ private struct SwiftPMToolchain: Build.Toolchain, ManifestResourceProvider {
   var extraSwiftCFlags: [String]
   var extraCPPFlags: [String]
   var dynamicLibraryExtension: String
+
+  func getClangCompiler() throws -> AbsolutePath { return clangCompiler }
 }
 
 extension ToolchainRegistry {