Package org.graalvm.tools.lsp.server

Class TruffleAdapter

java.lang.Object

org.graalvm.tools.lsp.server.TruffleAdapter

All Implemented Interfaces:

VirtualLanguageServerFileProvider

public final class TruffleAdapter
extends Object
implements VirtualLanguageServerFileProvider

This class delegates LSP requests of LanguageServerImpl to specific implementations of AbstractRequestHandler. It is responsible for wrapping requests into tasks for an instance of ContextAwareExecutor, so that these tasks are executed by a Thread which has entered a Context.

Constructor Summary

Constructors

Constructor	Description
TruffleAdapter(com.oracle.truffle.api.instrumentation.TruffleInstrument.Env mainEnv, boolean developerMode)

Method Summary

Modifier and Type	Method	Description
Future<CompletionList>	completion(URI uri, int line, int column, CompletionContext completionContext)	Provides completions for a specific position in the document.
Future<?>	createExtensionCommand(ExecuteCommandParams params)
void	didClose(URI uri)
Future<List<? extends DocumentHighlight>>	documentHighlight(URI uri, int line, int character)
Future<Coverage>	getCoverage(URI uri)
Collection<String>	getExtensionCommandNames()
com.oracle.truffle.api.TruffleLogger	getLogger()
com.oracle.truffle.api.source.Source	getSource(URI uri)
String	getSourceText(Path path)
boolean	hasCoverageData(URI uri)
Future<Hover>	hover(URI uri, int line, int column)
void	initializeLSPServer(org.graalvm.tools.api.lsp.LSPServerAccessor server)
boolean	isVirtualFile(Path path)
Future<com.oracle.truffle.api.CallTarget>	parse(String text, String langId, URI uri)
protected com.oracle.truffle.api.CallTarget	parseWithEnteredContext(String text, String langId, URI uri)
Future<TextDocumentSurrogate>	processChangesAndParse(List<? extends TextDocumentContentChangeEvent> list, URI uri)
protected TextDocumentSurrogate	processChangesAndParseWithContextEntered(List<? extends TextDocumentContentChangeEvent> list, URI uri)
void	register(com.oracle.truffle.api.instrumentation.TruffleInstrument.Env environment, ContextAwareExecutor executor)
Future<?>	reparse(URI uri)
Future<Boolean>	runCoverageAnalysis(URI uri)
void	setServerCapabilities(String languageId, ServerCapabilities capabilities)
Future<SignatureHelp>	signatureHelp(URI uri, int line, int character)
Function<URI,TextDocumentSurrogate>	surrogateGetter(com.oracle.truffle.api.nodes.LanguageInfo languageInfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TruffleAdapter

public TruffleAdapter(com.oracle.truffle.api.instrumentation.TruffleInstrument.Env mainEnv,
 boolean developerMode)

Method Details

register

public void register(com.oracle.truffle.api.instrumentation.TruffleInstrument.Env environment,
 ContextAwareExecutor executor)

getLogger

public com.oracle.truffle.api.TruffleLogger getLogger()

didClose

public void didClose(URI uri)

parse

public Future<com.oracle.truffle.api.CallTarget> parse(String text,
 String langId,
 URI uri)

parseWithEnteredContext

protected com.oracle.truffle.api.CallTarget parseWithEnteredContext(String text,
 String langId,
 URI uri)
                                                             throws DiagnosticsNotification

Throws:

DiagnosticsNotification

reparse

public Future<?> reparse(URI uri)

processChangesAndParse

public Future<TextDocumentSurrogate> processChangesAndParse(List<? extends TextDocumentContentChangeEvent> list,
 URI uri)

processChangesAndParseWithContextEntered

protected TextDocumentSurrogate processChangesAndParseWithContextEntered(List<? extends TextDocumentContentChangeEvent> list,
 URI uri)
                                                                  throws DiagnosticsNotification

Throws:

DiagnosticsNotification

setServerCapabilities

public void setServerCapabilities(String languageId,
 ServerCapabilities capabilities)

completion

public Future<CompletionList> completion(URI uri,
 int line,
 int column,
 CompletionContext completionContext)

Provides completions for a specific position in the document. If line or column are out of range, items of global scope (top scope) are provided.

Parameters:

uri -

line - 0-based line number

column - 0-based column number (character offset)

completionContext - has kind and completion character if client supports it

Returns:

a Future of CompletionList containing all completions for the cursor position

hover

public Future<Hover> hover(URI uri,
 int line,
 int column)

signatureHelp

public Future<SignatureHelp> signatureHelp(URI uri,
 int line,
 int character)

runCoverageAnalysis

public Future<Boolean> runCoverageAnalysis(URI uri)

getCoverage

public Future<Coverage> getCoverage(URI uri)

documentHighlight

public Future<List<? extends DocumentHighlight>> documentHighlight(URI uri,
 int line,
 int character)

hasCoverageData

public boolean hasCoverageData(URI uri)

getSourceText

public String getSourceText(Path path)

Specified by:

getSourceText in interface VirtualLanguageServerFileProvider

Parameters:

path - A path to a file in the file system.

Returns:

The source code of the file as seen/edited by the user in the source code editor.

getSource

public com.oracle.truffle.api.source.Source getSource(URI uri)

isVirtualFile

public boolean isVirtualFile(Path path)

Specified by:

isVirtualFile in interface VirtualLanguageServerFileProvider

Parameters:

path - A path to a file in the file system.

Returns:

true if the file has been marked as "opened" in our LSP server.

surrogateGetter

public Function<URI,TextDocumentSurrogate> surrogateGetter(com.oracle.truffle.api.nodes.LanguageInfo languageInfo)

initializeLSPServer

public void initializeLSPServer(org.graalvm.tools.api.lsp.LSPServerAccessor server)

getExtensionCommandNames

public Collection<String> getExtensionCommandNames()

createExtensionCommand

public Future<?> createExtensionCommand(ExecuteCommandParams params)