quarkdown-lsp/com.quarkdown.lsp/QuarkdownLanguageServer

QuarkdownLanguageServer

class QuarkdownLanguageServer(quarkdownDirectory: File?, executor: Executor = ForkJoinPool.commonPool(), onExit: () -> Unit = { exitProcess(0) }) : LanguageServer, LanguageClientAware

Quarkdown Language Server implementation.

Parameters

quarkdownDirectory

the directory containing the Quarkdown distribution, if available

executor

executor used to dispatch background work (catalogue warm-up, diagnostics, completion)

onExit

hook invoked when the client sends the LSP exit notification. Defaults to terminating the JVM, which is appropriate for stdio mode

Constructors

QuarkdownLanguageServer

constructor(quarkdownDirectory: File?, executor: Executor = ForkJoinPool.commonPool(), onExit: () -> Unit = { exitProcess(0) })

Properties

docsIndexSource

val docsIndexSource: DocsIndexSource?

The source of the documentation index, if available, backed by docsDirectory.

notebookDocumentService

@get:ProtocolSince(value = "3.17.0")

open val notebookDocumentService: NotebookDocumentService?

textDocumentService

open override val textDocumentService: TextDocumentService

workspaceService

open override val workspaceService: WorkspaceService

Functions

cancelProgress

@ProtocolSince(value = "3.15.0")

open fun cancelProgress(params: WorkDoneProgressCancelParams?)

connect

open override fun connect(client: LanguageClient?)

docsIndexSourceOrThrow

fun docsIndexSourceOrThrow(): DocsIndexSource

exit

open override fun exit()

getTextDocumentService

open override fun getTextDocumentService(): TextDocumentService

getWorkspaceService

open override fun getWorkspaceService(): WorkspaceService

initialize

open override fun initialize(params: InitializeParams?): CompletableFuture<InitializeResult?>?

initialized

@ProtocolDeprecated

open fun initialized()

open fun initialized(params: InitializedParams?)

log

fun log(message: String)

Logs a message to the client.

publishDiagnostics

fun publishDiagnostics(uri: String, diagnostics: List<Diagnostic>)

Publishes diagnostics to the client.

setTrace

@ProtocolSince(value = "3.16.0")

open fun setTrace(params: SetTraceParams?)

shutdown

open override fun shutdown(): CompletableFuture<in Any>?