WIP5

Signed-off-by: Koichi Shiraishi <[email protected]>

Author: zchee

protocol/base.go

@@ -39,7 +39,7 @@ const (
 	// ContentModifiedLSPErrorCodes 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.
 	ContentModifiedLSPErrorCodes LSPErrorCodes = -32801
 
-	// RequestCancelledLSPErrorCodes the client has canceled a request and a server as detected the cancel.
+	// RequestCancelledLSPErrorCodes the client has canceled a request and a server has detected the cancel.
 	RequestCancelledLSPErrorCodes LSPErrorCodes = -32800
 )
 

protocol/basic.go

@@ -88,6 +88,8 @@ const (
 
 	HandlebarsLanguageKind LanguageKind = "handlebars"
 
+	HaskellLanguageKind LanguageKind = "haskell"
+
 	HTMLLanguageKind LanguageKind = "html"
 
 	IniLanguageKind LanguageKind = "ini"
@@ -256,12 +258,12 @@ type TextDocumentIdentifier struct {
 //
 // @since 3.17.0 - support for negotiated position encoding.
 type Position struct {
-	// Line line position in a document (zero-based). If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document. If a line number is negative, it defaults to .
+	// Line line position in a document (zero-based).
 	//
 	// @since 3.17.0 - support for negotiated position encoding.
 	Line uint32 `json:"line"`
 
-	// Character character offset on a line in a document (zero-based). The meaning of this offset is determined by the negotiated `PositionEncodingKind`. If the character value is greater than the line length it defaults back to the line length.
+	// Character character offset on a line in a document (zero-based). The meaning of this offset is determined by the negotiated `PositionEncodingKind`.
 	//
 	// @since 3.17.0 - support for negotiated position encoding.
 	Character uint32 `json:"character"`
@@ -316,6 +318,38 @@ type OptionalVersionedTextDocumentIdentifier struct {
 	Version int32 `json:"version,omitempty"`
 }
 
+// StringValue a string value used as a snippet is a template which allows to insert text and to control the editor
+// cursor when insertion happens. A snippet can define tab stops and placeholders with `$1`, `$2`
+// and `${3:foo}`. `$0` defines the final tab stop, it defaults to the end of the snippet. Variables are defined with `$name` and `${name:default value}`. 3.18.0 @proposed.
+//
+// @since 3.18.0 proposed
+type StringValue struct {
+	// Value the snippet string.
+	//
+	// @since 3.18.0 proposed
+	Value string `json:"value"`
+}
+
+// SnippetTextEdit an interactive text edit.  3.18.0 @proposed.
+//
+// @since 3.18.0 proposed
+type SnippetTextEdit struct {
+	// Range the range of the text document to be manipulated.
+	//
+	// @since 3.18.0 proposed
+	Range Range `json:"range"`
+
+	// Snippet the snippet to be inserted.
+	//
+	// @since 3.18.0 proposed
+	Snippet StringValue `json:"snippet"`
+
+	// AnnotationID the actual identifier of the snippet edit.
+	//
+	// @since 3.18.0 proposed
+	AnnotationID *ChangeAnnotationIdentifier `json:"annotationId,omitempty"`
+}
+
 // AnnotatedTextEdit a special text edit with an additional change annotation.
 //
 // @since 3.16.0.
@@ -335,7 +369,7 @@ type TextDocumentEdit struct {
 	// TextDocument the text document to change.
 	TextDocument OptionalVersionedTextDocumentIdentifier `json:"textDocument"`
 
-	// Edits the edits to be applied. 3.16.0 - support for AnnotatedTextEdit. This is guarded using a client capability.
+	// Edits the edits to be applied. 3.16.0 - support for AnnotatedTextEdit. This is guarded using a client capability. 3.18.0 - support for SnippetTextEdit. This is guarded using a client capability.
 	Edits TextDocumentEditEdits `json:"edits"`
 }
 
@@ -425,7 +459,7 @@ type Diagnostic struct {
 	// Range the range at which the message applies.
 	Range Range `json:"range"`
 
-	// Severity the diagnostic's severity. Can be omitted. If omitted it is up to the client to interpret diagnostics as error, warning, info or hint.
+	// Severity the diagnostic's severity. To avoid interpretation mismatches when a server is used with different clients it is highly recommended that servers always provide a severity value.
 	Severity DiagnosticSeverity `json:"severity,omitempty"`
 
 	// Code the diagnostic's code, which usually appear in the user interface.
@@ -475,25 +509,64 @@ type VersionedTextDocumentIdentifier struct {
 	Version int32 `json:"version"`
 }
 
-// StringValue a string value used as a snippet is a template which allows to insert text and to control the editor
-// cursor when insertion happens. A snippet can define tab stops and placeholders with `$1`, `$2`
-// and `${3:foo}`. `$0` defines the final tab stop, it defaults to the end of the snippet. Variables are defined with `$name` and `${name:default value}`. 3.18.0 @proposed.
+// TextDocumentContentParams parameters for the `workspace/textDocumentContent` request.  3.18.0 @proposed.
 //
 // @since 3.18.0 proposed
-type StringValue struct {
-	// Value the snippet string.
+type TextDocumentContentParams struct {
+	// URI the uri of the text document.
 	//
 	// @since 3.18.0 proposed
-	Value string `json:"value"`
+	URI DocumentURI `json:"uri"`
 }
 
-// ChangeAnnotationsSupportOptions.
+// TextDocumentContentResult result of the `workspace/textDocumentContent` request.  3.18.0 @proposed.
+//
+// @since 3.18.0 proposed
+type TextDocumentContentResult struct {
+	// Text the text content of the text document. Please note, that the content of any subsequent open notifications for the text document might differ from the returned content due to whitespace and line ending
+	// normalizations done on the client.
+	//
+	// @since 3.18.0 proposed
+	Text string `json:"text"`
+}
+
+// TextDocumentContentOptions text document content provider options.  3.18.0 @proposed.
+//
+// @since 3.18.0 proposed
+type TextDocumentContentOptions struct {
+	// Schemes the schemes for which the server provides content.
+	//
+	// @since 3.18.0 proposed
+	Schemes []string `json:"schemes"`
+}
+
+// TextDocumentContentRegistrationOptions text document content provider registration options.  3.18.0 @proposed.
 //
 // @since 3.18.0 proposed
+type TextDocumentContentRegistrationOptions struct {
+	// extends
+	TextDocumentContentOptions
+	// mixins
+	StaticRegistrationOptions
+}
+
+// TextDocumentContentRefreshParams parameters for the `workspace/textDocumentContent/refresh` request.  3.18.0 @proposed.
+//
+// @since 3.18.0 proposed
+type TextDocumentContentRefreshParams struct {
+	// URI the uri of the text document to refresh.
+	//
+	// @since 3.18.0 proposed
+	URI DocumentURI `json:"uri"`
+}
+
+// ChangeAnnotationsSupportOptions.
+//
+// @since 3.18.0
 type ChangeAnnotationsSupportOptions struct {
 	// GroupsOnLabel whether the client groups edits with equal labels into tree nodes, for instance all edits labelled with "Changes in Strings" would be a tree node.
 	//
-	// @since 3.18.0 proposed
+	// @since 3.18.0
 	GroupsOnLabel bool `json:"groupsOnLabel,omitempty"`
 }
 
@@ -512,6 +585,12 @@ type WorkspaceEditClientCapabilities struct {
 
 	// ChangeAnnotationSupport whether the client in general supports change annotations on text edits, create file, rename file and delete file changes.
 	ChangeAnnotationSupport *ChangeAnnotationsSupportOptions `json:"changeAnnotationSupport,omitempty"`
+
+	// MetadataSupport whether the client supports `WorkspaceEditMetadata` in `WorkspaceEdit`s.  3.18.0 @proposed.
+	MetadataSupport bool `json:"metadataSupport,omitempty"`
+
+	// SnippetEditSupport whether the client supports snippets as text edits.  3.18.0 @proposed.
+	SnippetEditSupport bool `json:"snippetEditSupport,omitempty"`
 }
 
 type WorkDoneProgressBegin struct {

protocol/client.go

@@ -433,6 +433,13 @@ func (c *client) WorkspaceConfiguration(ctx context.Context, params *Configurati
 	return result, nil
 }
 
+func (c *client) refresh(ctx context.Context, method string) (err error) {
+	c.logger.Debug("call " + method)
+	defer c.logger.Debug("end "+method, zap.Error(err))
+
+	return c.Conn.Notify(ctx, method, nil)
+}
+
 func (c *client) WorkspaceDiagnosticRefresh(ctx context.Context) (err error) {
 	return c.refresh(ctx, MethodWorkspaceDiagnosticRefresh)
 }
@@ -453,11 +460,18 @@ func (c *client) WorkspaceSemanticTokensRefresh(ctx context.Context) (err error)
 	return c.refresh(ctx, MethodWorkspaceSemanticTokensRefresh)
 }
 
-func (c *client) refresh(ctx context.Context, method string) (err error) {
-	c.logger.Debug("call " + method)
-	defer c.logger.Debug("end "+method, zap.Error(err))
+// WorkspaceTextDocumentContentRefresh the `workspace/textDocumentContent` request is sent from the server to the client to refresh the content of a specific text document. 3.18.0 @proposed.
+//
+// @since 3.18.0 proposed
+func (c *client) WorkspaceTextDocumentContentRefresh(ctx context.Context, params *TextDocumentContentRefreshParams) (err error) {
+	c.logger.Debug("call " + MethodWorkspaceTextDocumentContentRefresh)
+	defer c.logger.Debug("end "+MethodWorkspaceTextDocumentContentRefresh, zap.Error(err))
 
-	return c.Conn.Notify(ctx, method, nil)
+	if err := Call(ctx, c.Conn, MethodWorkspaceTextDocumentContentRefresh, params, nil); err != nil {
+		return err
+	}
+
+	return nil
 }
 
 // WorkspaceFolders sends the request from the server to the client to fetch the current open list of workspace folders.

protocol/client_interface.go

@@ -10,27 +10,28 @@ import (
 )
 
 const (
-	MethodClientCancelRequest            ClientMethod = "$/cancelRequest"                  // bidirect client notification
-	MethodClientProgress                 ClientMethod = "$/progress"                       // bidirect client notification
-	MethodLogTrace                       ClientMethod = "$/logTrace"                       // client notification
-	MethodTelemetryEvent                 ClientMethod = "telemetry/event"                  // client notification
-	MethodTextDocumentPublishDiagnostics ClientMethod = "textDocument/publishDiagnostics"  // client notification
-	MethodWindowLogMessage               ClientMethod = "window/logMessage"                // client notification
-	MethodWindowShowMessage              ClientMethod = "window/showMessage"               // client notification
-	MethodClientRegisterCapability       ClientMethod = "client/registerCapability"        // client request
-	MethodClientUnregisterCapability     ClientMethod = "client/unregisterCapability"      // client request
-	MethodWindowShowDocument             ClientMethod = "window/showDocument"              // client request
-	MethodWindowShowMessageRequest       ClientMethod = "window/showMessageRequest"        // client request
-	MethodWindowWorkDoneProgressCreate   ClientMethod = "window/workDoneProgress/create"   // client request
-	MethodWorkspaceApplyEdit             ClientMethod = "workspace/applyEdit"              // client request
-	MethodWorkspaceCodeLensRefresh       ClientMethod = "workspace/codeLens/refresh"       // client request
-	MethodWorkspaceConfiguration         ClientMethod = "workspace/configuration"          // client request
-	MethodWorkspaceDiagnosticRefresh     ClientMethod = "workspace/diagnostic/refresh"     // client request
-	MethodWorkspaceFoldingRangeRefresh   ClientMethod = "workspace/foldingRange/refresh"   // client request
-	MethodWorkspaceInlayHintRefresh      ClientMethod = "workspace/inlayHint/refresh"      // client request
-	MethodWorkspaceInlineValueRefresh    ClientMethod = "workspace/inlineValue/refresh"    // client request
-	MethodWorkspaceSemanticTokensRefresh ClientMethod = "workspace/semanticTokens/refresh" // client request
-	MethodWorkspaceWorkspaceFolders      ClientMethod = "workspace/workspaceFolders"       // client request
+	MethodClientCancelRequest                 ClientMethod = "$/cancelRequest"                       // bidirect client notification
+	MethodClientProgress                      ClientMethod = "$/progress"                            // bidirect client notification
+	MethodLogTrace                            ClientMethod = "$/logTrace"                            // client notification
+	MethodTelemetryEvent                      ClientMethod = "telemetry/event"                       // client notification
+	MethodTextDocumentPublishDiagnostics      ClientMethod = "textDocument/publishDiagnostics"       // client notification
+	MethodWindowLogMessage                    ClientMethod = "window/logMessage"                     // client notification
+	MethodWindowShowMessage                   ClientMethod = "window/showMessage"                    // client notification
+	MethodClientRegisterCapability            ClientMethod = "client/registerCapability"             // client request
+	MethodClientUnregisterCapability          ClientMethod = "client/unregisterCapability"           // client request
+	MethodWindowShowDocument                  ClientMethod = "window/showDocument"                   // client request
+	MethodWindowShowMessageRequest            ClientMethod = "window/showMessageRequest"             // client request
+	MethodWindowWorkDoneProgressCreate        ClientMethod = "window/workDoneProgress/create"        // client request
+	MethodWorkspaceApplyEdit                  ClientMethod = "workspace/applyEdit"                   // client request
+	MethodWorkspaceCodeLensRefresh            ClientMethod = "workspace/codeLens/refresh"            // client request
+	MethodWorkspaceConfiguration              ClientMethod = "workspace/configuration"               // client request
+	MethodWorkspaceDiagnosticRefresh          ClientMethod = "workspace/diagnostic/refresh"          // client request
+	MethodWorkspaceFoldingRangeRefresh        ClientMethod = "workspace/foldingRange/refresh"        // client request
+	MethodWorkspaceInlayHintRefresh           ClientMethod = "workspace/inlayHint/refresh"           // client request
+	MethodWorkspaceInlineValueRefresh         ClientMethod = "workspace/inlineValue/refresh"         // client request
+	MethodWorkspaceSemanticTokensRefresh      ClientMethod = "workspace/semanticTokens/refresh"      // client request
+	MethodWorkspaceTextDocumentContentRefresh ClientMethod = "workspace/textDocumentContent/refresh" // client request
+	MethodWorkspaceWorkspaceFolders           ClientMethod = "workspace/workspaceFolders"            // client request
 )
 
 type Client interface {
@@ -105,6 +106,11 @@ type Client interface {
 	// @since 3.16.0
 	WorkspaceSemanticTokensRefresh(ctx context.Context) error
 
+	// WorkspaceTextDocumentContentRefresh the `workspace/textDocumentContent` request is sent from the server to the client to refresh the content of a specific text document. 3.18.0 @proposed.
+	//
+	// @since 3.18.0 proposed
+	WorkspaceTextDocumentContentRefresh(ctx context.Context, params *TextDocumentContentRefreshParams) error
+
 	// WorkspaceWorkspaceFolders the `workspace/workspaceFolders` is sent from the server to the client to fetch the open workspace folders.
 	WorkspaceWorkspaceFolders(ctx context.Context) ([]*WorkspaceFolder, error)
 }
@@ -192,6 +198,10 @@ func (UnimplementedClient) WorkspaceSemanticTokensRefresh(ctx context.Context) e
 	return jsonrpc2.ErrInternal
 }
 
+func (UnimplementedClient) WorkspaceTextDocumentContentRefresh(ctx context.Context, params *TextDocumentContentRefreshParams) error {
+	return jsonrpc2.ErrInternal
+}
+
 func (UnimplementedClient) WorkspaceWorkspaceFolders(ctx context.Context) ([]*WorkspaceFolder, error) {
 	return nil, jsonrpc2.ErrInternal
 }