Merge pull request #2342 from rintaro/base-message-protocols

[LSP/BSP] Separate base message protocol for LSP and BSP message types

Author: rintaro

Sources/BuildServerProtocol/CMakeLists.txt

@@ -4,6 +4,7 @@ add_library(BuildServerProtocol STATIC
   Messages/BuildShutdownRequest.swift
   Messages/BuildTargetPrepareRequest.swift
   Messages/BuildTargetSourcesRequest.swift
+  Messages/CancelRequestNotification.swift
   Messages/InitializeBuildRequest.swift
   Messages/OnBuildExitNotification.swift
   Messages/OnBuildInitializedNotification.swift

Sources/BuildServerProtocol/Messages.swift

@@ -12,6 +12,9 @@
 
 public import LanguageServerProtocol
 
+public protocol BSPRequest: RequestType {}
+public protocol BSPNotification: NotificationType {}
+
 private let requestTypes: [_RequestType.Type] = [
   BuildShutdownRequest.self,
   BuildTargetPrepareRequest.self,

Sources/BuildServerProtocol/Messages/BuildShutdownRequest.swift

@@ -17,7 +17,7 @@ public import LanguageServerProtocol
 /// but to not exit (otherwise the response might not be delivered
 /// correctly to the client). There is a separate exit notification
 /// that asks the server to exit.
-public struct BuildShutdownRequest: RequestType {
+public struct BuildShutdownRequest: BSPRequest {
   public static let method: String = "build/shutdown"
   public typealias Response = VoidResponse
 

Sources/BuildServerProtocol/Messages/BuildTargetPrepareRequest.swift

@@ -25,7 +25,7 @@ public typealias OriginId = String
 ///
 /// The server communicates during the initialize handshake whether this method is supported or not by setting
 /// `prepareProvider: true` in `SourceKitInitializeBuildResponseData`.
-public struct BuildTargetPrepareRequest: RequestType, Hashable {
+public struct BuildTargetPrepareRequest: BSPRequest, Hashable {
   public static let method: String = "buildTarget/prepare"
   public typealias Response = VoidResponse
 

Sources/BuildServerProtocol/Messages/BuildTargetSourcesRequest.swift

@@ -16,7 +16,7 @@ public import LanguageServerProtocol
 /// query for the list of text documents and directories that belong to a
 /// build target. The sources response must not include sources that are
 /// external to the workspace.
-public struct BuildTargetSourcesRequest: RequestType, Hashable {
+public struct BuildTargetSourcesRequest: BSPRequest, Hashable {
   public static let method: String = "buildTarget/sources"
   public typealias Response = BuildTargetSourcesResponse
 

Sources/BuildServerProtocol/Messages/CancelRequestNotification.swift

@@ -0,0 +1,15 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+public import LanguageServerProtocol
+
+extension CancelRequestNotification: BSPNotification {}

Sources/BuildServerProtocol/Messages/InitializeBuildRequest.swift

@@ -26,7 +26,7 @@ public import LanguageServerProtocol
 /// Until the server has responded to the initialize request with an
 /// InitializeBuildResult, the client must not send any additional
 /// requests or notifications to the server.
-public struct InitializeBuildRequest: RequestType, Hashable {
+public struct InitializeBuildRequest: BSPRequest, Hashable {
   public static let method: String = "build/initialize"
   public typealias Response = InitializeBuildResponse
 

Sources/BuildServerProtocol/Messages/OnBuildExitNotification.swift

@@ -10,13 +10,11 @@
 //
 //===----------------------------------------------------------------------===//
 
-public import LanguageServerProtocol
-
 /// Like the language server protocol, a notification to ask the
 /// server to exit its process. The server should exit with success
 /// code 0 if the shutdown request has been received before;
 /// otherwise with error code 1.
-public struct OnBuildExitNotification: NotificationType {
+public struct OnBuildExitNotification: BSPNotification {
   public static let method: String = "build/exit"
 
   public init() {}

Sources/BuildServerProtocol/Messages/OnBuildInitializedNotification.swift

@@ -10,10 +10,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-public import LanguageServerProtocol
-
 /// Like the language server protocol, the initialized notification is sent from the client to the server after the client received the result of the initialize request but before the client is sending any other request or notification to the server. The server can use the initialized notification for example to initialize intensive computation such as dependency resolution or compilation. The initialized notification may only be sent once.
-public struct OnBuildInitializedNotification: NotificationType {
+public struct OnBuildInitializedNotification: BSPNotification {
   public static let method: String = "build/initialized"
 
   public init() {}

Sources/BuildServerProtocol/Messages/OnBuildLogMessageNotification.swift

@@ -10,12 +10,10 @@
 //
 //===----------------------------------------------------------------------===//
 
-public import LanguageServerProtocol
-
 /// The log message notification is sent from a server to a client to ask the client to log a particular message in its console.
 ///
 /// A `build/logMessage`` notification is similar to LSP's `window/logMessage``, except for a few additions like id and originId.
-public struct OnBuildLogMessageNotification: NotificationType {
+public struct OnBuildLogMessageNotification: BSPNotification {
   public static let method: String = "build/logMessage"
 
   /// The message type.