Add beta support for dynamic text document content

Author: pisv

org.eclipse.lsp4j/src/main/java/org/eclipse/lsp4j/Protocol.xtend

@@ -407,6 +407,14 @@ class WorkspaceClientCapabilities {
 	@Draft
 	FoldingRangeWorkspaceCapabilities foldingRange
 
+	/**
+	 * Client capabilities for a text document content provider.
+	 * <p>
+	 * Since 3.18.0
+	 */
+	@Draft
+	TextDocumentContentCapabilities textDocumentContent
+
 	new() {
 	}
 }
@@ -6503,6 +6511,14 @@ class WorkspaceServerCapabilities {
 	 */
 	FileOperationsServerCapabilities fileOperations
 
+	/**
+	 * Text document content provider options.
+	 * <p>
+	 * Since 3.18.0
+	 */
+	@Draft
+	TextDocumentContentRegistrationOptions textDocumentContent
+
 	new() {
 	}
 
@@ -11935,3 +11951,114 @@ class SnippetTextEdit {
 		this.annotationId = annotationId
 	}
 }
+
+/**
+ * Client capabilities for a text document content provider.
+ * <p>
+ * Since 3.18.0
+ */
+@Draft
+@JsonRpcData
+class TextDocumentContentCapabilities extends DynamicRegistrationCapabilities {
+	new() {
+	}
+
+	new(Boolean dynamicRegistration) {
+		super(dynamicRegistration)
+	}
+}
+
+/**
+ * Text document content provider registration options.
+ * <p>
+ * Since 3.18.0
+ */
+@Draft
+@JsonRpcData
+class TextDocumentContentRegistrationOptions {
+	/**
+	 * The id used to register the request. The id can be used to deregister
+	 * the request again. See also {@link Registration#id}.
+	 */
+	String id
+
+	@NonNull
+	List<String> schemes
+
+	new() {
+		this.schemes = new ArrayList
+	}
+
+	new(@NonNull List<String> schemes) {
+		this.schemes = Preconditions.checkNotNull(schemes, 'schemes')
+	}
+}
+
+/**
+ * Parameters for the {@code workspace/textDocumentContent} request.
+ * <p>
+ * Since 3.18.0
+ */
+@Draft
+@JsonRpcData
+class TextDocumentContentParams {
+	/**
+	 * The uri of the text document.
+	 */
+	@NonNull
+	String uri
+
+	new() {
+	}
+
+	new(@NonNull String uri) {
+		this.uri = Preconditions.checkNotNull(uri, 'uri')
+	}
+}
+
+/**
+ * Result of the {@code workspace/textDocumentContent} request.
+ * <p>
+ * Since 3.18.0
+ */
+@Draft
+@JsonRpcData
+class TextDocumentContentResult {
+	/**
+	 * 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.
+	 */
+	@NonNull
+	String text
+
+	new() {
+	}
+
+	new(@NonNull String text) {
+		this.text = Preconditions.checkNotNull(text, 'text')
+	}
+}
+
+/**
+ * Parameters for the {@code workspace/textDocumentContent/refresh} request.
+ * <p>
+ * Since 3.18.0
+ */
+@Draft
+@JsonRpcData
+class TextDocumentContentRefreshParams {
+	/**
+	 * The uri of the text document to refresh.
+	 */
+	@NonNull
+	String uri
+
+	new() {
+	}
+
+	new(@NonNull String uri) {
+		this.uri = Preconditions.checkNotNull(uri, 'uri')
+	}
+}

org.eclipse.lsp4j/src/main/java/org/eclipse/lsp4j/services/LanguageClient.java

@@ -26,6 +26,7 @@
 import org.eclipse.lsp4j.ShowDocumentParams;
 import org.eclipse.lsp4j.ShowDocumentResult;
 import org.eclipse.lsp4j.ShowMessageRequestParams;
+import org.eclipse.lsp4j.TextDocumentContentRefreshParams;
 import org.eclipse.lsp4j.UnregistrationParams;
 import org.eclipse.lsp4j.WorkDoneProgressCreateParams;
 import org.eclipse.lsp4j.WorkspaceFolder;
@@ -267,4 +268,16 @@ default CompletableFuture<Void> refreshDiagnostics() {
 	default CompletableFuture<Void> refreshFoldingRanges() {
 		throw new UnsupportedOperationException();
 	}
+
+	/**
+	 * The {@code workspace/textDocumentContent/refresh} request is sent from the server to the client
+	 * to refresh the content of a specific text document.
+	 * <p>
+	 * Since 3.18.0
+	 */
+	@Draft
+	@JsonRequest("workspace/textDocumentContent/refresh")
+	default CompletableFuture<Void> refreshTextDocumentContent(TextDocumentContentRefreshParams params) {
+		throw new UnsupportedOperationException();
+	}
 }

org.eclipse.lsp4j/src/main/java/org/eclipse/lsp4j/services/WorkspaceService.java

@@ -22,12 +22,15 @@
 import org.eclipse.lsp4j.ExecuteCommandParams;
 import org.eclipse.lsp4j.RenameFilesParams;
 import org.eclipse.lsp4j.SymbolInformation;
+import org.eclipse.lsp4j.TextDocumentContentParams;
+import org.eclipse.lsp4j.TextDocumentContentResult;
 import org.eclipse.lsp4j.WorkspaceDiagnosticParams;
 import org.eclipse.lsp4j.WorkspaceDiagnosticReport;
 import org.eclipse.lsp4j.WorkspaceEdit;
 import org.eclipse.lsp4j.WorkspaceSymbol;
 import org.eclipse.lsp4j.WorkspaceSymbolParams;
 import org.eclipse.lsp4j.adapters.WorkspaceSymbolResponseAdapter;
+import org.eclipse.lsp4j.jsonrpc.Draft;
 import org.eclipse.lsp4j.jsonrpc.json.ResponseJsonAdapter;
 import org.eclipse.lsp4j.jsonrpc.messages.Either;
 import org.eclipse.lsp4j.jsonrpc.services.JsonNotification;
@@ -193,4 +196,18 @@ default void didDeleteFiles(DeleteFilesParams params) {
 	default CompletableFuture<WorkspaceDiagnosticReport> diagnostic(WorkspaceDiagnosticParams params) {
 		throw new UnsupportedOperationException();
 	}
+
+	/**
+	 * The {@code workspace/textDocumentContent} request is sent from the client to the server to dynamically fetch
+	 * the content of a text document. Clients should treat the content returned from this request as read-only.
+	 * <p>
+	 * Registration Options: {@link org.eclipse.lsp4j.TextDocumentContentRegistrationOptions}
+	 * <p>
+	 * Since 3.18.0
+	 */
+	@Draft
+	@JsonRequest
+	default CompletableFuture<TextDocumentContentResult> textDocumentContent(TextDocumentContentParams params) {
+		throw new UnsupportedOperationException();
+	}
 }