Merge pull request swiftlang#193 from ahoppen/document-uri

Add support for non-URL URIs

Author: benlangmuir

Package.swift

@@ -40,6 +40,7 @@ let package = Package(
           "LSPTestSupport",
           "SourceKit",
           "tibs", // Never imported, needed at runtime
+          "TSCUtility",
         ]
       ),
       .testTarget(

Sources/BuildServerProtocol/BuildTargets.swift

@@ -11,6 +11,8 @@
 //===----------------------------------------------------------------------===//
 import LanguageServerProtocol
 
+public typealias URI = DocumentURI
+
 /// The workspace build targets request is sent from the client to the server to
 /// ask for the list of all available build targets in the workspace.
 public struct BuildTargets: RequestType, Hashable {
@@ -38,7 +40,7 @@ public struct BuildTarget: Codable, Hashable {
   /// allowed to map to the same base directory, and a build target is not
   /// required to have a base directory. A base directory does not determine the
   /// sources of a target, see buildTarget/sources.
-  public var baseDirectory: URL?
+  public var baseDirectory: URI?
 
   /// Free-form string tags to categorize or label this build target.
   /// For example, can be used by the client to:
@@ -62,7 +64,7 @@ public struct BuildTarget: Codable, Hashable {
 
   public init(id: BuildTargetIdentifier,
               displayName: String?,
-              baseDirectory: URL?,
+              baseDirectory: URI?,
               tags: [BuildTargetTag],
               capabilities: BuildTargetCapabilities,
               languageIds: [Language],
@@ -78,9 +80,9 @@ public struct BuildTarget: Codable, Hashable {
 }
 
 public struct BuildTargetIdentifier: Codable, Hashable {
-  public var uri: URL
+  public var uri: URI
 
-  public init(uri: URL) {
+  public init(uri: URI) {
     self.uri = uri
   }
 }
@@ -166,7 +168,7 @@ public struct SourceItem: Codable, Hashable {
   /// Either a text document or a directory. A directory entry must end with a
   /// forward slash "/" and a directory entry implies that every nested text
   /// document within the directory belongs to this source item.
-  public var uri: URL
+  public var uri: URI
 
   /// Type of file of the source item, such as whether it is file or directory.
   public var kind: SourceItemKind
@@ -205,7 +207,7 @@ public struct OutputsItem: Codable, Hashable {
   public var target: BuildTargetIdentifier
 
   /// The output paths for sources that belong to this build target.
-  public var outputPaths: [URL]
+  public var outputPaths: [URI]
 }
 
 /// The build target changed notification is sent from the server to the client

Sources/BuildServerProtocol/FileOptions.swift

@@ -17,10 +17,10 @@ public struct SourceKitOptions: RequestType, Hashable {
   public static let method: String = "textDocument/sourceKitOptions"
   public typealias Response = SourceKitOptionsResult
 
-  /// The URL of the document to get options for
-  public var uri: URL
+  /// The URI of the document to get options for
+  public var uri: URI
 
-  public init(uri: URL) {
+  public init(uri: URI) {
     self.uri = uri
   }
 }

Sources/BuildServerProtocol/InitializeBuild.swift

@@ -39,12 +39,12 @@ public struct InitializeBuild: RequestType, Hashable {
   public var bspVersion: String
 
   /// The rootUri of the workspace
-  public var rootUri: URL
+  public var rootUri: URI
 
   /// The capabilities of the client
   public var capabilities: BuildClientCapabilities
 
-  public init(displayName: String, version: String, bspVersion: String, rootUri: URL, capabilities: BuildClientCapabilities) {
+  public init(displayName: String, version: String, bspVersion: String, rootUri: URI, capabilities: BuildClientCapabilities) {
     self.displayName = displayName
     self.version = version
     self.bspVersion = bspVersion

Sources/BuildServerProtocol/RegisterForChangeNotifications.swift

@@ -20,13 +20,13 @@ public struct RegisterForChanges: RequestType {
   public static let method: String = "textDocument/registerForChanges"
   public typealias Response = VoidResponse
 
-  /// The URL of the document to get options for.
-  public var uri: URL
+  /// The URI of the document to get options for.
+  public var uri: URI
 
   /// Whether to register or unregister for the file.
   public var action: RegisterAction
 
-  public init(uri: URL, action: RegisterAction) {
+  public init(uri: URI, action: RegisterAction) {
     self.uri = uri
     self.action = action
   }
@@ -43,8 +43,8 @@ public enum RegisterAction: String, Hashable, Codable {
 public struct FileOptionsChangedNotification: NotificationType {
   public static let method: String = "build/sourceKitOptionsChanged"
 
-  /// The URL of the document that has changed settings.
-  public var uri: URL
+  /// The URI of the document that has changed settings.
+  public var uri: URI
 
   /// The updated options for the registered file.
   public var updatedOptions: SourceKitOptionsResult

Sources/LanguageServerProtocol/DocumentURI.swift

@@ -0,0 +1,66 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2019 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 Foundation
+
+public struct DocumentURI: Codable, Hashable {
+  /// The URL that store the URIs value
+  private let storage: URL
+
+  public var fileURL: URL? {
+    if storage.isFileURL {
+      return storage
+    } else {
+      return nil
+    }
+  }
+
+  /// Returns a filepath if the URI is a URL. If the URI is not a URL, returns
+  /// the full URI as a fallback.
+  /// This value is intended to be used when interacting with sourcekitd which
+  /// expects a file path but is able to handle arbitrary strings as well in a
+  /// fallback mode that drops semantic functionality.
+  public var pseudoPath: String {
+    if storage.isFileURL {
+      return storage.path
+    } else {
+      return storage.absoluteString
+    }
+  }
+
+  /// Returns the URI as a string.
+  public var stringValue: String {
+    return storage.absoluteString
+  }
+
+  /// Construct a DocumentURI from the given URI string, automatically parsing
+  ///  it either as a URL or an opaque URI.
+  public init(string: String) {
+    guard let url = URL(string: string) else {
+      fatalError("Failed to construct DocumentURI from '\(string)'")
+    }
+    self.init(url)
+  }
+
+  public init(_ url: URL) {
+    self.storage = url
+    assert(self.storage.scheme != nil, "Received invalid URI without a scheme '\(self.storage.absoluteString)'")
+  }
+
+  public init(from decoder: Decoder) throws {
+    self.init(string: try decoder.singleValueContainer().decode(String.self))
+  }
+
+  public func encode(to encoder: Encoder) throws {
+    try storage.absoluteString.encode(to: encoder)
+  }
+}

Sources/LanguageServerProtocol/InitializeRequest.swift

@@ -19,7 +19,7 @@
 ///
 /// - Parameters:
 ///   - processId: The process identifier (pid) of the client process.
-///   - rootURL: The workspace URL, or nil if no workspace is open.
+///   - rootURI: The workspace URI, or nil if no workspace is open.
 ///   - initializationOptions: User-provided options.
 ///   - capabilities: The capabilities provided by the client editor.
 ///   - trace: Whether to enable tracing.
@@ -39,13 +39,13 @@ public struct InitializeRequest: RequestType, Hashable {
 
   /// The workspace path, or nil if no workspace is open.
   ///
-  /// - Note: deprecated in favour of `rootURL`.
+  /// - Note: deprecated in favour of `rootURI`.
   public var rootPath: String? = nil
 
-  /// The workspace URL, or nil if no workspace is open.
+  /// The workspace URI, or nil if no workspace is open.
   ///
   /// Takes precedence over the deprecated `rootPath`.
-  public var rootURL: URL?
+  public var rootURI: DocumentURI?
 
   /// User-provided options.
   public var initializationOptions: LSPAny? = nil
@@ -68,15 +68,15 @@ public struct InitializeRequest: RequestType, Hashable {
   public init(
     processId: Int? = nil,
     rootPath: String? = nil,
-    rootURL: URL?,
+    rootURI: DocumentURI?,
     initializationOptions: LSPAny? = nil,
     capabilities: ClientCapabilities,
     trace: Tracing = .off,
     workspaceFolders: [WorkspaceFolder]?)
   {
     self.processId = processId
     self.rootPath = rootPath
-    self.rootURL = rootURL
+    self.rootURI = rootURI
     self.initializationOptions = initializationOptions
     self.capabilities = capabilities
     self.trace = trace
@@ -88,7 +88,7 @@ extension InitializeRequest: Codable {
   private enum CodingKeys: String, CodingKey {
     case processId
     case rootPath
-    case rootURL = "rootUri"
+    case rootURI = "rootUri"
     case initializationOptions
     case capabilities
     case trace

Sources/LanguageServerProtocol/Location.swift

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

Sources/LanguageServerProtocol/PublishDiagnostics.swift

@@ -22,26 +22,19 @@
 /// to coalesce the notification across multiple changes in a short period of time.
 ///
 /// - Parameters:
-///   - url: The document in which the diagnostics should be shown.
+///   - uri: The document in which the diagnostics should be shown.
 ///   - diagnostics: The complete list of diagnostics in the document, if any.
-public struct PublishDiagnostics: NotificationType, Hashable {
+public struct PublishDiagnostics: NotificationType, Hashable, Codable {
   public static let method: String = "textDocument/publishDiagnostics"
 
   /// The document in which the diagnostics should be shown.
-  public var url: URL
+  public var uri: DocumentURI
 
   /// The complete list of diagnostics in the document, if any.
   public var diagnostics: [Diagnostic]
 
-  public init(url: URL, diagnostics: [Diagnostic]) {
-    self.url = url
+  public init(uri: DocumentURI, diagnostics: [Diagnostic]) {
+    self.uri = uri
     self.diagnostics = diagnostics
   }
 }
-
-extension PublishDiagnostics: Codable {
-  private enum CodingKeys: String, CodingKey {
-    case url = "uri"
-    case diagnostics
-  }
-}

Sources/LanguageServerProtocol/TextDocumentIdentifier.swift

@@ -10,43 +10,28 @@
 //
 //===----------------------------------------------------------------------===//
 
-import struct Foundation.URL
-
-/// Convenience alias so that you don't need to add Foundation import to use.
-public typealias URL = Foundation.URL
-
 /// Unique identifier for a document.
-public struct TextDocumentIdentifier: Hashable {
+public struct TextDocumentIdentifier: Hashable, Codable {
 
-  /// A URL that uniquely identifies the document.
-  public var url: URL
+  /// A URI that uniquely identifies the document.
+  public var uri: DocumentURI
 
-  public init(_ url: URL) {
-    self.url = url
-  }
-}
-
-// Encode using the key "uri" to match LSP.
-extension TextDocumentIdentifier: Codable {
-  private enum CodingKeys: String, CodingKey {
-    case url = "uri"
+  public init(_ uri: DocumentURI) {
+    self.uri = uri
   }
 }
 
 extension TextDocumentIdentifier: LSPAnyCodable {
   public init?(fromLSPDictionary dictionary: [String : LSPAny]) {
-    guard case .string(let urlString)? = dictionary[CodingKeys.url.stringValue] else {
-      return nil
-    }
-    guard let url = URL(string: urlString) else {
+    guard case .string(let uriString)? = dictionary[CodingKeys.uri.stringValue] else {
       return nil
     }
-    self.url = url
+    self.uri = DocumentURI(string: uriString)
   }
 
   public func encodeToLSPAny() -> LSPAny {
     return .dictionary([
-      CodingKeys.url.stringValue: .string(url.absoluteString)
+      CodingKeys.uri.stringValue: .string(uri.stringValue)
     ])
   }
 }