Merge branch 'master' into format

# Conflicts:
#	Package.swift

Author: Trzyipolkostkicukru

Documentation/Development.md

@@ -12,9 +12,9 @@ This document contains notes about development and testing of SourceKit-LSP.
 
 ## Getting Started Developing SourceKit-LSP
 
-SourceKit-LSP is under heavy development, and requires the use of a Swift development toolchain.
+For maximum compatibility with toolchain components such as the Swift Package Manager, the only supported way to develop SourceKit-LSP is with the latest toolchain snapshot. We make an effort to keep the build and tests working with the latest release of Swift, but this is not always possible.
 
-1. Install the latest master toolchain snapshot from https://swift.org/download/#snapshots. **If you're looking for swift-5.1 support**, use the `swift-5.1-branch` of SourceKit-LSP with the latest swift-5.1 toolchain snapshot. See [Toolchains](#toolchains) for more information.
+1. Install the latest master toolchain snapshot from https://swift.org/download/#snapshots. **If you're looking for swift-5.x**, use the `swift-5.x-branch` of SourceKit-LSP with the latest swift-5.x toolchain snapshot. See [Toolchains](#toolchains) for more information.
 
 2. Build the language server executable `sourcekit-lsp` using `swift build`. See [Building](#building-sourcekit-lsp) for more information.
 
@@ -59,7 +59,8 @@ Use the latest toolchain snapshot from https://swift.org/download/#snapshots. So
 | SourceKit-LSP branch | Toolchain |
 |:---------------------|:----------|
 | master               | Trunk Development (master) |
-| swift-5.1-branch     | Swift 5.1 Development |
+| swift-5.2-branch     | Swift 5.2 Development |
+| swift-5.1-branch     | Swift 5.1.1+ |
 
 *Note*: there is no branch of SourceKit-LSP that supports Swift 5.0.
 

Editors/README.md

@@ -2,6 +2,20 @@
 
 This document contains information about how to configure an editor to use SourceKit-LSP. If your editor is not listed below, but it supports the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) (LSP), see [Other Editors](#other-editors).
 
+In general, you will need to know where to find the `sourcekit-lsp` server exectuable. Some examples:
+
+* With Xcode 11.4+
+  * `xcrun sourcekit-lsp` - run the server
+  * `xcrun --find sourcekit-lsp` - get the full path to the server
+* Toolchain from Swift.org
+  * Linux
+    * You will find `sourcekit-lsp` in the `bin` directory of the toolchain.
+  * macOS
+    * `xcrun --toolchain swift sourcekit-lsp` - run the server
+    * `xcrun --toolchain swift --find sourcekit-lsp` - get the full path to the server
+* Built from source
+  * `.build/<platform>/<configuration>/sourcekit-lsp`
+
 ## Visual Studio Code
 
 To use SourceKit-LSP with Visual Studio Code, you will need the [SourceKit-LSP
@@ -29,7 +43,7 @@ You will need the path to the `sourcekit-lsp` executable for the "command" secti
     {
       "enabled": true,
       "command": [
-        "<path to sourcekit-lsp>"
+        "<sourcekit-lsp command>"
       ],
       "env": {
         // To override the toolchain, uncomment the following:

Editors/vscode/README.md

@@ -4,8 +4,8 @@ This extension adds support to Visual Studio Code for using SourceKit-LSP, a
 language server for Swift and C/C++/Objective-C languages.
 
 **Note**: SourceKit-LSP is under heavy development and this should be considered
-a preview. Users will need to separately provide the `sourcekit-lsp` executable
-as well as a Swift toolchain.
+a preview. Users will need to provide the `sourcekit-lsp` executable
+and Swift toolchain.
 
 ## Building and Installing the Extension
 

Package.swift

@@ -209,7 +209,7 @@ if getenv("SWIFTCI_USE_LOCAL_DEPS") == nil {
   package.dependencies += [
     .package(path: "../indexstore-db"),
     .package(path: "../swiftpm"),
-    .package(path: "../swiftpm/TSC"),
     .package(path: "../swift-format"),
+    .package(path: "../swiftpm/swift-tools-support-core"),
   ]
 }

README.md

@@ -4,15 +4,19 @@ SourceKit-LSP is an implementation of the [Language Server Protocol](https://mic
 
 ## Getting Started
 
-SourceKit-LSP is under heavy development! The best way to try it out is to install a recent Swift development toolchain from https://swift.org/download/#snapshots. Make sure you build your package with the same toolchain as you got sourcekit-lsp from to ensure compatibility.
+The SourceKit-LSP server is included with the Swift toolchain. Depending on how you installed Swift, you may already have SourceKit-LSP. Make sure you build your package with the same toolchain as you use sourcekit-lsp from to ensure compatibility.
 
-### Using a Swift Toolchain from Swift.org
+1. Get SourceKit-LSP with a Swift toolchain
 
-1. Install the latest master or 5.1 development toolchain snapshot from https://swift.org/download/#snapshots.
+    1. If you have installed Xcode 11.4+ or the corresponding Command Line Tools package, the SourceKit-LSP server is included and can be run with `xcrun sourcekit-lsp`.
 
-2. Configure your editor to use the `sourcekit-lsp` executable from the toolchain snapshot. See [Editors](Editors) for more information about editor integration.
+    2. If you are using a [toolchain from Swift.org](https://swift.org/download/), the SourceKit-LSP server is included and can be run with `xcrun --toolchain swift sourcekit-lsp` on macOS, or using the full path to the `sourcekit-lsp` executable on Linux.
 
-3. Build the project you are working on with `swift build` using the same toolchain snapshot. The language server depends on the build to provide module dependencies and to update the global index.
+    3. If your toolchain did not come with SourceKit-LSP, see [Development](Documentation/Development.md) for how to build it from source.
+
+2. Configure your editor to use SourceKit-LSP. See [Editors](Editors) for more information about editor integration.
+
+3. Build the project you are working on with `swift build` using the same toolchain as the SourceKit-LSP server. The language server depends on the build to provide module dependencies and to update the global index.
 
 ## Development
 
@@ -35,7 +39,7 @@ SourceKit-LSP is still in early development, so you may run into rough edges wit
 | Code completion | ✅ | |
 | Quick Help (Hover) | ✅ | |
 | Diagnostics | ✅ | |
-| Fix-its | ❌ | |
+| Fix-its | ✅ | |
 | Jump to Definition | ✅ | |
 | Find References | ✅ | |
 | Background Indexing | ❌ | Build project to update the index using [Indexing While Building](#indexing-while-building) |

Sources/LSPLogging/Logging.swift

@@ -37,6 +37,16 @@ public func logAsync(level: LogLevel = .default, messageProducer: @escaping (_ c
   Logger.shared.logAsync(level: level, messageProducer: messageProducer)
 }
 
+/// Log an error and trigger an assertion failure (if compiled with assertions).
+///
+/// If `level >= Logger.shared.currentLevel`, it will be emitted. However, the converse is not necessarily true: on platforms that provide `os_log`, the message may be emitted by `os_log` according to its own rules about log level.
+///
+/// - parameter message: The message to print.
+public func logAssertionFailure(_ message: String, file: StaticString = #file, line: UInt = #line) {
+  Logger.shared.log(message, level: .error)
+  assertionFailure(message, file: file, line: line)
+}
+
 /// Like `try?`, but logs the error on failure.
 public func orLog<R>(
   _ prefix: String = "",

Sources/LanguageServerProtocol/CMakeLists.txt

@@ -6,9 +6,6 @@ add_library(LanguageServerProtocol
   Message.swift
   MessageRegistry.swift
   Messages.swift
-  PositionRange.swift
-  Request.swift
-  RequestID.swift
   Notifications/CancelRequestNotification.swift
   Notifications/ConfigurationNotification.swift
   Notifications/DidChangeWorkspaceFoldersNotification.swift
@@ -18,6 +15,9 @@ add_library(LanguageServerProtocol
   Notifications/PublishDiagnosticsNotification.swift
   Notifications/ShowMessageNotification.swift
   Notifications/TextSynchronizationNotifications.swift
+  PositionRange.swift
+  Request.swift
+  RequestID.swift
   Requests/ApplyEditRequest.swift
   Requests/CodeActionRequest.swift
   Requests/ColorPresentationRequest.swift
@@ -47,11 +47,11 @@ add_library(LanguageServerProtocol
   SupportTypes/Diagnostic.swift
   SupportTypes/DocumentURI.swift
   SupportTypes/FoldingRangeKind.swift
+  SupportTypes/LSPAny.swift
   SupportTypes/Language.swift
   SupportTypes/Location.swift
   SupportTypes/LocationLink.swift
   SupportTypes/LocationsOrLocationLinksResponse.swift
-  SupportTypes/LSPAny.swift
   SupportTypes/MarkupContent.swift
   SupportTypes/Position.swift
   SupportTypes/ServerCapabilities.swift
@@ -66,7 +66,8 @@ add_library(LanguageServerProtocol
   SupportTypes/WindowMessageType.swift
   SupportTypes/WorkspaceEdit.swift
   SupportTypes/WorkspaceFolder.swift
-  SupportTypes/WorkspaceSettings.swift)
+  SupportTypes/WorkspaceSettings.swift
+  )
 set_target_properties(LanguageServerProtocol PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
 if(NOT CMAKE_SYSTEM_NAME STREQUAL Windows)

Sources/LanguageServerProtocol/Notifications/TextSynchronizationNotifications.swift

@@ -74,12 +74,19 @@ public struct DidChangeTextDocumentNotification: NotificationType, Hashable {
   /// Edits to the document.
   public var contentChanges: [TextDocumentContentChangeEvent]
 
+  /// Force the LSP to rebuild its AST for the given file. This is useful for clangd to workaround clangd's assumption that
+  /// missing header files will stay missing.
+  /// **LSP Extension from clangd**.
+  public var forceRebuild: Bool? = nil
+
   public init(
     textDocument: VersionedTextDocumentIdentifier,
-    contentChanges: [TextDocumentContentChangeEvent])
+    contentChanges: [TextDocumentContentChangeEvent],
+    forceRebuild: Bool? = nil)
   {
     self.textDocument = textDocument
     self.contentChanges = contentChanges
+    self.forceRebuild = forceRebuild
   }
 }
 

Sources/LanguageServerProtocol/Requests/CodeActionRequest.swift

@@ -56,17 +56,11 @@ public enum CodeActionRequestResponse: ResponseType, Codable, Equatable {
   case commands([Command])
 
   public init(codeActions: [CodeAction], clientCapabilities: TextDocumentClientCapabilities.CodeAction?) {
-    if let literalSupport = clientCapabilities?.codeActionLiteralSupport {
-      let supportedKinds = literalSupport.codeActionKind.valueSet
-      self = .codeActions(codeActions.filter {
-        if let kind = $0.kind {
-          return supportedKinds.contains(kind)
-        } else {
-          // The client guarantees that unsupported kinds will be treated,
-          // so it's probably safe to include unspecified kinds into the result.
-          return true
-        }
-      })
+    if clientCapabilities?.codeActionLiteralSupport != nil {
+      // The client guarantees that unsupported kinds will be handled, and in
+      // practice some clients use `"codeActionKind":{"valueSet":[]}`, since
+      // they support all kinds anyway.
+      self = .codeActions(codeActions)
     } else {
       self = .commands(codeActions.compactMap { $0.command })
     }
@@ -111,7 +105,7 @@ public struct CodeActionContext: Codable, Hashable {
   }
 }
 
-public struct CodeAction: Codable, Equatable {
+public struct CodeAction: Codable, Hashable {
 
   /// A short, human-readable, title for this code action.
   public var title: String

Sources/LanguageServerProtocol/SupportTypes/ClientCapabilities.swift

@@ -356,8 +356,14 @@ public struct TextDocumentClientCapabilities: Hashable, Codable {
     /// Whether the client accepts diagnostics with related information.
     public var relatedInformation: Bool? = nil
 
-    public init(relatedInformation: Bool? = nil) {
+    /// Requests that SourceKit-LSP send `Diagnostic.codeActions`.
+    /// **LSP Extension from clangd**.
+    public var codeActionsInline: Bool? = nil
+
+    public init(relatedInformation: Bool? = nil,
+                codeActionsInline: Bool? = nil) {
       self.relatedInformation = relatedInformation
+      self.codeActionsInline = codeActionsInline
     }
   }
 

Sources/LanguageServerProtocol/SupportTypes/Diagnostic.swift

@@ -47,20 +47,26 @@ public struct Diagnostic: Codable, Hashable {
   /// Related diagnostic notes.
   public var relatedInformation: [DiagnosticRelatedInformation]?
 
+  /// All the code actions that address this diagnostic.
+  /// **LSP Extension from clangd**.
+  public var codeActions: [CodeAction]?
+
   public init(
     range: Range<Position>,
     severity: DiagnosticSeverity?,
     code: DiagnosticCode? = nil,
     source: String?,
     message: String,
-    relatedInformation: [DiagnosticRelatedInformation]? = nil)
+    relatedInformation: [DiagnosticRelatedInformation]? = nil,
+    codeActions: [CodeAction]? = nil)
   {
     self._range = CustomCodable<PositionRange>(wrappedValue: range)
     self.severity = severity
     self.code = code
     self.source = source
     self.message = message
     self.relatedInformation = relatedInformation
+    self.codeActions = codeActions
   }
 }
 
@@ -71,9 +77,14 @@ public struct DiagnosticRelatedInformation: Codable, Hashable {
 
   public var message: String
 
-  public init(location: Location, message: String) {
+  /// All the code actions that address the parent diagnostic via this note.
+  /// **LSP Extension from clangd**.
+  public var codeActions: [CodeAction]?
+
+  public init(location: Location, message: String, codeActions: [CodeAction]? = nil) {
     self.location = location
     self.message = message
+    self.codeActions = codeActions
   }
 }
 

Sources/LanguageServerProtocol/SupportTypes/DocumentURI.swift

@@ -24,6 +24,11 @@ public struct DocumentURI: Codable, Hashable {
     }
   }
 
+  /// The document's URL scheme, if present.
+  public var scheme: String? {
+    return storage.scheme
+  }
+
   /// 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

Sources/SKCore/BuildServerBuildSystem.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 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
@@ -149,7 +149,7 @@ extension BuildServerBuildSystem: BuildSystem {
 
   /// Register the given file for build-system level change notifications, such as command
   /// line flag changes, dependency changes, etc.
-  public func registerForChangeNotifications(for uri: DocumentURI) {
+  public func registerForChangeNotifications(for uri: DocumentURI, language: Language) {
     let request = RegisterForChanges(uri: uri, action: .register)
     _ = self.buildServer?.send(request, queue: requestQueue, reply: { result in
       if let error = result.failure {
@@ -171,15 +171,14 @@ extension BuildServerBuildSystem: BuildSystem {
 
   public func settings(for uri: DocumentURI, _ language: Language) -> FileBuildSettings? {
     if let response = try? self.buildServer?.sendSync(SourceKitOptions(uri: uri)) {
-      return FileBuildSettings(compilerArguments: response.options, workingDirectory: response.workingDirectory)
+      return FileBuildSettings(
+        compilerArguments: response.options,
+        workingDirectory: response.workingDirectory,
+        language: language)
     }
     return nil
   }
 
-  public func toolchain(for: DocumentURI, _ language: Language) -> Toolchain? {
-    return nil
-  }
-
   public func buildTargets(reply: @escaping (LSPResult<[BuildTarget]>) -> Void) {
     _ = self.buildServer?.send(BuildTargets(), queue: requestQueue) { response in
       switch response {

Sources/SKCore/BuildSystem.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 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
@@ -34,16 +34,13 @@ public protocol BuildSystem: AnyObject {
   /// Returns the settings for the given url and language mode, if known.
   func settings(for: DocumentURI, _ language: Language) -> FileBuildSettings?
 
-  /// Returns the toolchain to use to compile this file
-  func toolchain(for: DocumentURI, _ language: Language) -> Toolchain?
-
   /// Delegate to handle any build system events such as file build settings
   /// changing.
   var delegate: BuildSystemDelegate? { get set }
 
   /// Register the given file for build-system level change notifications, such
   /// as command line flag changes, dependency changes, etc.
-  func registerForChangeNotifications(for: DocumentURI)
+  func registerForChangeNotifications(for: DocumentURI, language: Language)
 
   /// Unregister the given file for build-system level change notifications,
   /// such as command line flag changes, dependency changes, etc.

Sources/SKCore/BuildSystemList.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 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
@@ -47,9 +47,9 @@ extension BuildSystemList: BuildSystem {
 
   /// Register the given file for build-system level change notifications, such as command
   /// line flag changes, dependency changes, etc.
-  public func registerForChangeNotifications(for uri: DocumentURI) {
+  public func registerForChangeNotifications(for uri: DocumentURI, language: Language) {
     // Only register with the primary build system, since we only use its delegate.
-    providers.first?.registerForChangeNotifications(for: uri)
+    providers.first?.registerForChangeNotifications(for: uri, language: language)
   }
 
   /// Unregister the given file for build-system level change notifications, such as command
@@ -59,10 +59,6 @@ extension BuildSystemList: BuildSystem {
     providers.first?.unregisterForChangeNotifications(for: uri)
   }
 
-  public func toolchain(for uri: DocumentURI, _ language: Language) -> Toolchain? {
-    return providers.first?.toolchain(for: uri, language)
-  }
-
   public func buildTargets(reply: @escaping (LSPResult<[BuildTarget]>) -> Void) {
     providers.first?.buildTargets(reply: reply)
   }