Update request and notification definitions to LSP 3.17

Author: ahoppen

Sources/LanguageServerProtocol/Error.swift

@@ -22,19 +22,68 @@ public struct ErrorCode: RawRepresentable, Codable, Hashable {
     self.rawValue = rawValue
   }
 
-  // JSON RPC
+  // MARK: JSON RPC
   public static let parseError: ErrorCode = ErrorCode(rawValue: -32700)
   public static let invalidRequest: ErrorCode = ErrorCode(rawValue: -32600)
   public static let methodNotFound: ErrorCode = ErrorCode(rawValue: -32601)
   public static let invalidParams: ErrorCode = ErrorCode(rawValue: -32602)
   public static let internalError: ErrorCode = ErrorCode(rawValue: -32603)
-  public static let serverErrorStart: ErrorCode = ErrorCode(rawValue: -32099)
-  public static let serverErrorEnd: ErrorCode = ErrorCode(rawValue: -32000)
-  public static let workspaceNotOpen: ErrorCode = ErrorCode(rawValue: -32003)
-  public static let unknownErrorCode: ErrorCode = ErrorCode(rawValue: -32001)
 
-  // LSP
+
+  /// This is the start range of JSON-RPC reserved error codes.
+  /// It doesn't denote a real error code. No LSP error codes should
+  /// be defined between the start and end range. For backwards
+  /// compatibility the `ServerNotInitialized` and the `UnknownErrorCode`
+  /// are left in the range.
+  public static let jsonrpcReservedErrorRangeStart = ErrorCode(rawValue: -32099)
+  public static let serverErrorStart: ErrorCode = jsonrpcReservedErrorRangeStart
+
+  /// Error code indicating that a server received a notification or
+  /// request before the server has received the `initialize` request.
+  public static let serverNotInitialized = ErrorCode(rawValue: -32002)
+  public static let unknownErrorCode = ErrorCode(rawValue: -32001)
+
+  /// This is the end range of JSON-RPC reserved error codes.
+  /// It doesn't denote a real error code.
+  public static let jsonrpcReservedErrorRangeEnd = ErrorCode(rawValue: -32000)
+  /// Deprecated, use jsonrpcReservedErrorRangeEnd
+  public static let serverErrorEnd = jsonrpcReservedErrorRangeEnd
+
+  /// This is the start range of LSP reserved error codes.
+  /// It doesn't denote a real error code.
+  public static let lspReservedErrorRangeStart = ErrorCode(rawValue: -32899)
+
+  /// A request failed but it was syntactically correct, e.g the
+  /// method name was known and the parameters were valid. The error
+  /// message should contain human readable information about why
+  /// the request failed.
+  public static let RequestFailed = ErrorCode(rawValue: -32803)
+
+  /// The server cancelled the request. This error code should
+  /// only be used for requests that explicitly support being
+  /// server cancellable.
+  public static let ServerCancelled = ErrorCode(rawValue: -32802)
+
+  /// The server detected that the content of a document got
+  /// modified outside normal conditions. A server should
+  /// NOT send this error code if it detects a content change
+  /// in it unprocessed messages. The result even computed
+  /// on an older state might still be useful for the client.
+  ///
+  /// If a client decides that a result is not of any use anymore
+  /// the client should cancel the request.
+  public static let ContentModified = ErrorCode(rawValue: -32801)
+
+  /// The client has canceled a request and a server as detected
+  /// the cancel.
   public static let cancelled: ErrorCode = ErrorCode(rawValue: -32800)
+
+  /// This is the end range of LSP reserved error codes.
+  /// It doesn't denote a real error code.
+  public static let lspReservedErrorRangeEnd = ErrorCode(rawValue: -32800)
+
+  // MARK: SourceKit-LSP specifiic eror codes
+  public static let workspaceNotOpen: ErrorCode = ErrorCode(rawValue: -32003)
 }
 
 /// An error response represented by a code and message.

Sources/LanguageServerProtocol/Notifications/DidChangeFileNotifications.swift

@@ -0,0 +1,45 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2022 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 struct DidCreateFilesNotification: NotificationType {
+  public static var method: String = "workspace/didCreateFiles"
+
+  /// An array of all files/folders created in this operation.
+  public var files: [FileDelete]
+
+  public init(files: [FileDelete]) {
+    self.files = files
+  }
+}
+
+public struct DidRenameFilesNotification: NotificationType {
+  public static var method: String = "workspace/didRenameFiles"
+
+  /// An array of all files/folders renamed in this operation. When a folder
+  /// is renamed, only the folder will be included, and not its children.
+  public var files: [FileRename]
+
+  public init(files: [FileRename]) {
+    self.files = files
+  }
+}
+
+public struct DidDeleteFilesNotification: NotificationType {
+  public static var method: String = "workspace/didDeleteFiles"
+
+  /// An array of all files/folders created in this operation.
+  public var files: [FileDelete]
+
+  public init(files: [FileDelete]) {
+    self.files = files
+  }
+}

Sources/LanguageServerProtocol/Notifications/LogTraceNotification.swift

@@ -0,0 +1,30 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2022 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
+//
+//===----------------------------------------------------------------------===//
+
+/// A notification to log the trace of the server’s execution. The amount and content of these notifications depends on the current trace configuration. If trace is 'off', the server should not send any logTrace notification. If trace is 'messages', the server should not add the 'verbose' field in the LogTraceParams.
+///
+/// $/logTrace should be used for systematic trace reporting. For single debugging messages, the server should send window/logMessage notifications.
+public struct LogTraceNotification: NotificationType, Hashable, Codable {
+  public static let method: String = "$/logTrace"
+
+  /// The message to be logged.
+  public var message: String
+
+  /// Additional information that can be computed if the `trace` configuration
+  /// is set to `'verbose'`
+  public var verbose: String
+
+  public init(message: String, verbose: String) {
+    self.message = message
+    self.verbose = verbose
+  }
+}

Sources/LanguageServerProtocol/Notifications/SetTraceNotification.swift

@@ -0,0 +1,23 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2022 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
+//
+//===----------------------------------------------------------------------===//
+
+/// A notification that should be used by the client to modify the trace setting of the server.
+public struct SetTraceNotification: NotificationType, Hashable, Codable {
+  public static let method: String = "$/setTrace"
+
+  /// The new value that should be assigned to the trace setting.
+  public var value: Tracing
+
+  public init(value: Tracing) {
+    self.value = value
+  }
+}

Sources/LanguageServerProtocol/Notifications/TextSynchronizationNotifications.swift

@@ -68,10 +68,24 @@ public struct DidCloseTextDocumentNotification: NotificationType, Hashable {
 public struct DidChangeTextDocumentNotification: NotificationType, Hashable {
   public static let method: String = "textDocument/didChange"
 
-  /// The document to change and its current version identifier.
+  /// The document that did change. The version number points
+  /// to the version after all provided content changes have
+  /// been applied.
   public var textDocument: VersionedTextDocumentIdentifier
 
-  /// Edits to the document.
+  /// The actual content changes. The content changes describe single state
+  /// changes to the document. So if there are two content changes c1 (at
+  /// array index 0) and c2 (at array index 1) for a document in state S then
+  /// c1 moves the document from S to S' and c2 from S' to S''. So c1 is
+  /// computed on the state S and c2 is computed on the state S'.
+  ///
+  /// To mirror the content of a document using change events use the following
+  /// approach:
+  /// - start with the same initial content
+  /// - apply the 'textDocument/didChange' notifications in the order you
+  ///   receive them.
+  /// - apply the `TextDocumentContentChangeEvent`s in a single notification
+  ///   in the order you receive them.
   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
@@ -125,3 +139,76 @@ public struct DidSaveTextDocumentNotification: TextDocumentNotification, Hashabl
   /// Only provided if the server specified `includeText == true`.
   public var text: String?
 }
+
+/// The open notification is sent from the client to the server when a notebook document is opened. It is only sent by a client if the server requested the synchronization mode `notebook` in its `notebookDocumentSync` capability.
+public struct DidOpenNotebookDocumentNotification: NotificationType, Hashable {
+  public static let method: String = "notebookDocument/didOpen"
+
+  /// The notebook document that got opened.
+  public var notebookDocument: NotebookDocument
+
+  /// The text documents that represent the content
+  /// of a notebook cell.
+  public var cellTextDocuments: [TextDocumentItem]
+
+  public init(notebookDocument: NotebookDocument, cellTextDocuments: [TextDocumentItem]) {
+    self.notebookDocument = notebookDocument
+    self.cellTextDocuments = cellTextDocuments
+  }
+}
+
+/// The change notification is sent from the client to the server when a notebook document changes. It is only sent by a client if the server requested the synchronization mode `notebook` in its `notebookDocumentSync` capability.
+public struct DidChangeNotebookDocumentNotification: NotificationType, Hashable {
+  public static var method: String = "notebookDocument/didChange"
+  
+  /// The notebook document that did change. The version number points
+  /// to the version after all provided changes have been applied.
+  public var notebookDocument: VersionedNotebookDocumentIdentifier
+
+  /// The actual changes to the notebook document.
+  ///
+  /// The change describes single state change to the notebook document.
+  /// So it moves a notebook document, its cells and its cell text document
+  /// contents from state S to S'.
+  ///
+  /// To mirror the content of a notebook using change events use the
+  /// following approach:
+  /// - start with the same initial content
+  /// - apply the 'notebookDocument/didChange' notifications in the order
+  ///   you receive them.
+  public var change: NotebookDocumentChangeEvent
+
+  public init(notebookDocument: VersionedNotebookDocumentIdentifier, change: NotebookDocumentChangeEvent) {
+    self.notebookDocument = notebookDocument
+    self.change = change
+  }
+}
+
+/// The save notification is sent from the client to the server when a notebook document is saved. It is only sent by a client if the server requested the synchronization mode `notebook` in its `notebookDocumentSync` capability.
+public struct DidSaveNotebookDocumentNotification: NotificationType {
+  public static var method: String = "notebookDocument/didSave"
+
+  /// The notebook document that got saved.
+  public var notebookDocument: NotebookDocumentIdentifier
+
+  public init(notebookDocument: NotebookDocumentIdentifier) {
+    self.notebookDocument = notebookDocument
+  }
+}
+
+/// The close notification is sent from the client to the server when a notebook document is closed. It is only sent by a client if the server requested the synchronization mode `notebook` in its `notebookDocumentSync` capability.
+public struct DidCloseNotebookDocumentNotification: NotificationType {
+  public static var method: String = "notebookDocument/didClose"
+
+  /// The notebook document that got closed.
+  public var notebookDocument: NotebookDocumentIdentifier
+
+  /// The text documents that represent the content
+  /// of a notebook cell that got closed.
+  public var cellTextDocuments: [TextDocumentIdentifier]
+
+  public init(notebookDocument: NotebookDocumentIdentifier, cellTextDocuments: [TextDocumentIdentifier]) {
+    self.notebookDocument = notebookDocument
+    self.cellTextDocuments = cellTextDocuments
+  }
+}