Fix merge conflicts (Toolchain, SwiftPMWorkspace, SwiftLanguageServer)

Author: josh

Editors/README.md

@@ -68,6 +68,10 @@ You will need the path to the `sourcekit-lsp` executable and the Swift toolchain
 }
 ```
 
+## Emacs
+
+There is an Emacs client for SourceKit-LSP in the [main Emacs LSP repository](https://github.com/emacs-lsp/lsp-sourcekit).
+
 ## Other Editors
 
 SourceKit-LSP should work with any editor that supports the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/)

Editors/vscode/package-lock.json

@@ -31,10 +31,10 @@
         "vscode-languageclient": "^4.0.0"
     },
     "devDependencies": {
+        "@types/node": "^8.10.25",
         "typescript": "^2.6.1",
-        "vscode": "^1.1.21",
-        "vsce": "^1.52.0",
-        "@types/node": "^8.10.25"
+        "vsce": "^1.53.2",
+        "vscode": "^1.1.22"
     },
     "contributes": {
         "configuration": {

Editors/vscode/package.json

@@ -38,6 +38,9 @@ let package = Package(
       .target(
         name: "SKSwiftPMWorkspace",
         dependencies: ["SwiftPM", "SKCore"]),
+      .testTarget(
+        name: "SKSwiftPMWorkspaceTests",
+        dependencies: ["SKSwiftPMWorkspace", "SKTestSupport"]),
 
       // Csourcekitd: C modules wrapper for sourcekitd.
       .target(

Package.resolved

@@ -7,7 +7,7 @@ SourceKit-LSP is an implementation of the [Language Server Protocol](https://mic
 
 SourceKit-LSP is under heavy development! The best way to try it out is to build it from source. You will also need a Swift development toolchain and an editor that supports LSP.
 
-1. Install the `swift-DEVELOPMENT-SNAPSHOT-2018-11-01-a` toolchain snapshot from https://swift.org/download/. Set the environment variable `SOURCEKIT_TOOLCHAIN_PATH` to the absolute path to the toolchain or otherwise configure your editor to use this toolchain. See [Toolchains](#toolchains) for more information.
+1. Install the `swift-DEVELOPMENT-SNAPSHOT-2018-12-02-a` toolchain snapshot from https://swift.org/download/#snapshots. Set the environment variable `SOURCEKIT_TOOLCHAIN_PATH` to the absolute path to the toolchain or otherwise configure your editor to use this toolchain. 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.
 
@@ -45,13 +45,35 @@ $ swift package generate-xcodeproj --xcconfig-overrides overrides.xcconfig
 $ open SourceKitLSP.xcodeproj
 ```
 
+## Debugging
+
+You can attach LLDB to SourceKit-LSP and set breakpoints to debug. You may want to instruct LLDB to wait for the sourcekit-lsp process to launch and then start your editor, which will typically launch
+SourceKit-LSP as soon as you open a Swift file:
+
+
+```sh
+$ lldb -w -n sourcekit-lsp
+```
+
+If you are using the Xcode project, go to Debug, Attach to Process by PID or Name.
+
+### Print SourceKit Logs
+
+You can configure SourceKit-LSP to print log information from SourceKit to stderr by setting the following environment variable:
+
+```sh
+SOURCEKIT_LOGGING="N"
+```
+
+Where "N" configures the log verbosity and is one of the following numbers: 0 (error), 1 (warning), 2 (info), or 3 (debug).
+
 ## Toolchains
 
 SourceKit-LSP depends on tools such as `sourcekitd` and `clangd`, which it loads at runtime from an installed toolchain.
 
 ### Recommended Toolchain
 
-Use the `swift-DEVELOPMENT-SNAPSHOT-2018-11-01-a` toolchain snapshot from https://swift.org/download/#snapshots. It can be found under "Older Snapshots" as "November 1, 2018".  SourceKit-LSP is still early in its development and we are actively adding functionality to the toolchain to support it.
+Use the `swift-DEVELOPMENT-SNAPSHOT-2018-12-02-a` toolchain snapshot from https://swift.org/download/#snapshots. SourceKit-LSP is still early in its development and we are actively adding functionality to the toolchain to support it.
 
 ### Selecting the Toolchain
 
@@ -94,9 +116,6 @@ SourceKit-LSP is still in early development, so you may run into rough edges wit
 
 ### Caveats
 
-* Indexing does not work on Linux (jump-to-definition, find references)
-	* Should be fixed in the next Swift snapshot by [swift-clang#219](https://github.com/apple/swift-clang/pull/219)
-
 * SwiftPM build settings are not updated automatically after files are added/removed.
 	* **Workaround**: close and reopen the project after adding/removing files
 

Package.swift

@@ -18,6 +18,7 @@ import Basic
 public let builtinRequests: [_RequestType.Type] = [
   InitializeRequest.self,
   Shutdown.self,
+  WorkspaceFoldersRequest.self,
   CompletionRequest.self,
   HoverRequest.self,
   DefinitionRequest.self,
@@ -37,6 +38,7 @@ public let builtinNotifications: [NotificationType.Type] = [
   CancelRequest.self,
   LogMessage.self,
   DidChangeConfiguration.self,
+  DidChangeWorkspaceFolders.self,
   DidOpenTextDocument.self,
   DidCloseTextDocument.self,
   DidChangeTextDocument.self,
@@ -172,6 +174,12 @@ public struct LogMessage: NotificationType, Hashable {
 
 // MARK: - Workspace -
 
+public struct WorkspaceFoldersRequest: RequestType, Hashable {
+    public static let method: String = "workspace/workspaceFolders"
+
+    public typealias Response = [WorkspaceFolder]
+}
+
 public struct DidChangeConfiguration: NotificationType {
   public static let method: String = "workspace/didChangeConfiguration"
 
@@ -182,6 +190,16 @@ public struct DidChangeConfiguration: NotificationType {
   }
 }
 
+public struct DidChangeWorkspaceFolders: NotificationType {
+    public static let method: String = "workspace/didChangeWorkspaceFolders"
+
+    public var event: WorkspaceFoldersChangeEvent
+
+    public init(event: WorkspaceFoldersChangeEvent) {
+        self.event = event
+    }
+}
+
 // MARK: - Text synchronization -
 
 public struct DidOpenTextDocument: NotificationType, Hashable {

README.md

@@ -30,6 +30,7 @@ public struct WorkspaceFolder {
 
 extension WorkspaceFolder: Equatable {}
 extension WorkspaceFolder: Hashable {}
+extension WorkspaceFolder: ResponseType {}
 
 // Encode using the key "uri" to match LSP.
 extension WorkspaceFolder: Codable {

Sources/LanguageServerProtocol/Messages.swift

@@ -0,0 +1,26 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+/// The workspace folder change event.
+public struct WorkspaceFoldersChangeEvent: Codable, Hashable {
+
+    /// The array of added workspace folders
+    public var added: [WorkspaceFolder]?
+
+    /// The array of the removed workspace folders
+    public var removed: [WorkspaceFolder]?
+
+    public init(added: [WorkspaceFolder]? = nil, removed: [WorkspaceFolder]? = nil) {
+        self.added = added
+        self.removed = removed
+    }
+}

Sources/LanguageServerProtocol/WorkspaceFolder.swift

@@ -11,35 +11,26 @@
 //===----------------------------------------------------------------------===//
 
 import LanguageServerProtocol
+import Basic
 
-/// Provider of build settings.
-public protocol BuildSettingsProvider {
+/// Provider of FileBuildSettings and other build-related information.
+///
+/// The primary role of the build system is to answer queries for FileBuildSettings and (TODO) to
+/// notify clients when they change. The BuildSystem is also the source of related informatino,
+/// such as where the index datastore is located.
+///
+/// For example, a SwiftPMWorkspace provides compiler arguments for the files contained in a
+/// SwiftPM package root directory.
+public protocol BuildSystem {
 
-  /// Returns the settings for the given url and language mode, if known.
-  func settings(for: URL, language: Language) -> FileBuildSettings?
-
-  // TODO: notifications when settings change.
-}
+  /// The path to the raw index store data, if any.
+  var indexStorePath: AbsolutePath? { get }
 
-/// Build settings for a single file.
-public struct FileBuildSettings {
+  /// The path to put the index database, if any.
+  var indexDatabasePath: AbsolutePath? { get }
 
-  /// The identifier of the toolchain that is preferred for compiling this file, if any.
-  public var preferredToolchain: String? = nil
-
-  /// The compiler arguments to use for this file.
-  public var compilerArguments: [String]
-
-  /// The working directory to resolve any relative paths in `compilerArguments`.
-  public var workingDirectory: String? = nil
+  /// Returns the settings for the given url and language mode, if known.
+  func settings(for: URL, _ language: Language) -> FileBuildSettings?
 
-  public init(
-    preferredToolchain: String? = nil,
-    compilerArguments: [String],
-    workingDirectory: String? = nil
-  ) {
-    self.preferredToolchain = preferredToolchain
-    self.compilerArguments = compilerArguments
-    self.workingDirectory = workingDirectory
-  }
+  // TODO: notifications when settings change.
 }