final class MetalsHttpClient extends DelegatingLanguageClient
Editor client that implement dialogue UIs like window/showMessageRequest.
Goals:
- enable editor plugin authors access all functionality within Metals even if the editor plugin only supports a limited set of LSP endpoints.
Non-goals:
- Pretty UI, the interface only needs to be functional, not look nice. - Become permanent/primary interface for ordinary users. The end goal is to enable users to interact with Metals from their editor, not via a browser.
The most popular LSP clients in editors like Vim currently have
limited support so that endpoints like window/showMessageRequest are ignored,
with no workaround for users to interact with the Metals language server.
This http client allows users in those editors to trigger server commands
and respond to UI dialogues through their browser instead.
- Alphabetic
- By Inheritance
- MetalsHttpClient
- DelegatingLanguageClient
- MetalsLanguageClient
- DecorationClient
- TreeViewClient
- LanguageClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new MetalsHttpClient(workspace: io.AbsolutePath, url: () => String, initial: MetalsLanguageClient, triggerReload: () => Unit, icons: Icons, time: Time, sh: ScheduledExecutorService, clientConfig: ClientConfiguration)(implicit ec: ExecutionContext)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def applyEdit(params: ApplyWorkspaceEditParams): CompletableFuture[ApplyWorkspaceEditResponse]
- Definition Classes
- DelegatingLanguageClient → LanguageClient
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def completeCommand(exchange: HttpServerExchange): Unit
- def configuration(configurationParams: ConfigurationParams): CompletableFuture[java.util.List[AnyRef]]
- Definition Classes
- DelegatingLanguageClient → LanguageClient
- def createProgress(arg0: WorkDoneProgressCreateParams): CompletableFuture[Void]
- Definition Classes
- LanguageClient
- Annotations
- @JsonRequest()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def globalTracePath(protocolName: String, description: String): Option[(String, io.AbsolutePath)]
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def logMessage(message: MessageParams): Unit
- Definition Classes
- MetalsHttpClient → DelegatingLanguageClient → LanguageClient
- def logTrace(arg0: LogTraceParams): Unit
- Definition Classes
- LanguageClient
- Annotations
- @JsonNotification()
- def metalsExecuteClientCommand(params: ExecuteCommandParams): Unit
- Definition Classes
- MetalsHttpClient → DelegatingLanguageClient → MetalsLanguageClient
- final def metalsInputBox(params: MetalsInputBoxParams): CompletableFuture[Option[MetalsInputBoxResult]]
Opens an input box to ask the user for input.
Opens an input box to ask the user for input.
- returns
the user provided input or None if request was cancelled. The future can be cancelled, meaning the input box should be dismissed in the editor.
- Definition Classes
- MetalsLanguageClient
- def metalsPublishDecorations(params: PublishDecorationsParams): Unit
- Definition Classes
- MetalsHttpClient → DelegatingLanguageClient → DecorationClient
- final def metalsQuickPick(params: MetalsQuickPickParams): CompletableFuture[Option[MetalsQuickPickResult]]
Opens an menu to ask the user to pick one of the suggested options.
Opens an menu to ask the user to pick one of the suggested options.
- returns
the user provided pick or None if request was cancelled. The future can be cancelled, meaning the input box should be dismissed in the editor.
- Definition Classes
- MetalsLanguageClient
- def metalsSlowTask(params: MetalsSlowTaskParams): CompletableFuture[MetalsSlowTaskResult]
Starts a long running task with no estimate for how long it will take to complete.
Starts a long running task with no estimate for how long it will take to complete.
- request cancellation from the server indicates that the task has completed - response with cancel=true indicates the client wishes to cancel the slow task
- Definition Classes
- MetalsHttpClient → DelegatingLanguageClient → MetalsLanguageClient
- def metalsStatus(params: MetalsStatusParams): Unit
Display message in the editor "status bar", which should be displayed somewhere alongside the buffer.
Display message in the editor "status bar", which should be displayed somewhere alongside the buffer.
The status bar should always be visible to the user.
- VS Code: https://code.visualstudio.com/docs/extensionAPI/vscode-api#StatusBarItem
- Definition Classes
- MetalsHttpClient → DelegatingLanguageClient → MetalsLanguageClient
- def metalsTreeViewDidChange(params: TreeViewDidChangeParams): Unit
- Definition Classes
- DelegatingLanguageClient → TreeViewClient
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def notifyProgress(arg0: ProgressParams): Unit
- Definition Classes
- LanguageClient
- Annotations
- @JsonNotification()
- def publishDiagnostics(diagnostics: PublishDiagnosticsParams): Unit
- Definition Classes
- DelegatingLanguageClient → LanguageClient
- def rawMetalsInputBox(params: MetalsInputBoxParams): CompletableFuture[RawMetalsInputBoxResult]
Opens an input box to ask the user for input.
Opens an input box to ask the user for input. This method is used to deal with gson and existing extension protocol.
- returns
the user provided input.
- Definition Classes
- DelegatingLanguageClient → MetalsLanguageClient
- def rawMetalsQuickPick(params: MetalsQuickPickParams): CompletableFuture[RawMetalsQuickPickResult]
Opens an menu to ask the user to pick one of the suggested options.
Opens an menu to ask the user to pick one of the suggested options. This method is used to deal with gson and existing extension protocol.
- returns
the user provided pick.
- Definition Classes
- DelegatingLanguageClient → MetalsLanguageClient
- def refreshCodeLenses(): CompletableFuture[Void]
- Definition Classes
- LanguageClient
- Annotations
- @JsonRequest()
- def refreshDiagnostics(): CompletableFuture[Void]
- Definition Classes
- LanguageClient
- Annotations
- @JsonRequest()
- def refreshInlayHints(): CompletableFuture[Void]
- Definition Classes
- LanguageClient
- Annotations
- @JsonRequest()
- def refreshInlineValues(): CompletableFuture[Void]
- Definition Classes
- LanguageClient
- Annotations
- @JsonRequest()
- def refreshModel(): CompletableFuture[Unit]
- Definition Classes
- DelegatingLanguageClient → MetalsLanguageClient
- def refreshSemanticTokens(): CompletableFuture[Void]
- Definition Classes
- LanguageClient
- Annotations
- @JsonRequest()
- def registerCapability(params: RegistrationParams): CompletableFuture[Void]
- Definition Classes
- DelegatingLanguageClient → LanguageClient
- def renderHtml: String
- def showDocument(arg0: ShowDocumentParams): CompletableFuture[ShowDocumentResult]
- Definition Classes
- LanguageClient
- Annotations
- @JsonRequest()
- def showMessage(params: MessageParams): Unit
- Definition Classes
- MetalsHttpClient → DelegatingLanguageClient → LanguageClient
- final def showMessage(messageType: MessageType, message: String): Unit
- Definition Classes
- MetalsLanguageClient
- def showMessageRequest(params: ShowMessageRequestParams): CompletableFuture[MessageActionItem]
- Definition Classes
- MetalsHttpClient → DelegatingLanguageClient → LanguageClient
- def showMessagesFormatted(html: HtmlBuilder): Unit
- def shutdown(): Unit
- Definition Classes
- DelegatingLanguageClient → MetalsLanguageClient
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def telemetryEvent(value: Any): Unit
- Definition Classes
- DelegatingLanguageClient → LanguageClient
- def toString(): String
- Definition Classes
- AnyRef → Any
- def tracePath(protocolName: String, workspace: io.AbsolutePath, description: String): Option[(String, io.AbsolutePath)]
- var underlying: MetalsLanguageClient
- Definition Classes
- DelegatingLanguageClient
- def unregisterCapability(params: UnregistrationParams): CompletableFuture[Void]
- Definition Classes
- DelegatingLanguageClient → LanguageClient
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def workspaceFolders(): CompletableFuture[java.util.List[WorkspaceFolder]]
- Definition Classes
- LanguageClient
- Annotations
- @JsonRequest()
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated