Class BSLTextDocumentService

java.lang.Object

com.github._1c_syntax.bsl.languageserver.BSLTextDocumentService

All Implemented Interfaces:

ProtocolExtension, TextDocumentService

@Component
public class BSLTextDocumentService
extends Object
implements TextDocumentService, ProtocolExtension

Сервис обработки запросов, связанных с текстовым документом.

Реализует интерфейс TextDocumentService из LSP4J и обрабатывает все запросы, связанные с открытием, изменением, закрытием документов, а также предоставляет функции навигации, редактирования и анализа кода.

Constructor Summary

Constructors

Constructor

Description

BSLTextDocumentService(ServerContext context, LanguageServerConfiguration configuration, DiagnosticProvider diagnosticProvider, CodeActionProvider codeActionProvider, CodeLensProvider codeLensProvider, DocumentLinkProvider documentLinkProvider, DocumentSymbolProvider documentSymbolProvider, FoldingRangeProvider foldingRangeProvider, FormatProvider formatProvider, HoverProvider hoverProvider, ReferencesProvider referencesProvider, DefinitionProvider definitionProvider, CallHierarchyProvider callHierarchyProvider, SelectionRangeProvider selectionRangeProvider, ColorProvider colorProvider, RenameProvider renameProvider, InlayHintProvider inlayHintProvider, ClientCapabilitiesHolder clientCapabilitiesHolder, SemanticTokensProvider semanticTokensProvider)

Method Summary

Modifier and Type	Method	Description
protected static String	applyIncrementalChange(String content, TextDocumentContentChangeEvent change)	Применяет одно инкрементальное изменение к содержимому документа.
protected static String	applyTextDocumentChanges(String content, List<TextDocumentContentChangeEvent> changes)	Применяет список изменений текста к исходному содержимому документа.
CompletableFuture<List<CallHierarchyIncomingCall>>	callHierarchyIncomingCalls(CallHierarchyIncomingCallsParams params)
CompletableFuture<List<CallHierarchyOutgoingCall>>	callHierarchyOutgoingCalls(CallHierarchyOutgoingCallsParams params)
CompletableFuture<List<Either<Command, CodeAction>>>	codeAction(CodeActionParams params)
CompletableFuture<List<? extends CodeLens>>	codeLens(CodeLensParams params)
CompletableFuture<List<ColorPresentation>>	colorPresentation(ColorPresentationParams params)
CompletableFuture<Either<List<? extends Location>, List<? extends LocationLink>>>	definition(DefinitionParams params)
CompletableFuture<DocumentDiagnosticReport>	diagnostic(DocumentDiagnosticParams params)
CompletableFuture<Diagnostics>	diagnostics(DiagnosticParams params)	Запрос на вычисление диагностик для документа (расширение протокола).
void	didChange(DidChangeTextDocumentParams params)
void	didClose(DidCloseTextDocumentParams params)
void	didOpen(DidOpenTextDocumentParams params)
void	didSave(DidSaveTextDocumentParams params)
CompletableFuture<List<ColorInformation>>	documentColor(DocumentColorParams params)
CompletableFuture<List<DocumentLink>>	documentLink(DocumentLinkParams params)
CompletableFuture<List<Either<SymbolInformation, DocumentSymbol>>>	documentSymbol(DocumentSymbolParams params)
CompletableFuture<List<FoldingRange>>	foldingRange(FoldingRangeRequestParams params)
CompletableFuture<List<? extends TextEdit>>	formatting(DocumentFormattingParams params)
protected static int	getOffset(String content, int line, int character)	Вычисляет абсолютную позицию символа в тексте по номеру строки и позиции в строке.
void	handleInitializeEvent(LanguageServerInitializeRequestReceivedEvent ignored)	Обработчик события LanguageServerInitializeRequestReceivedEvent.
CompletableFuture<@Nullable Hover>	hover(HoverParams params)
CompletableFuture<List<InlayHint>>	inlayHint(InlayHintParams params)
CompletableFuture<@Nullable List<CallHierarchyItem>>	prepareCallHierarchy(CallHierarchyPrepareParams params)
CompletableFuture<Either3<Range, PrepareRenameResult, PrepareRenameDefaultBehavior>>	prepareRename(PrepareRenameParams params)
CompletableFuture<List<? extends TextEdit>>	rangeFormatting(DocumentRangeFormattingParams params)
CompletableFuture<List<? extends Location>>	references(ReferenceParams params)
CompletableFuture<WorkspaceEdit>	rename(RenameParams params)
void	reset()
CompletableFuture<CodeLens>	resolveCodeLens(CodeLens unresolved)
CompletableFuture<List<@Nullable SelectionRange>>	selectionRange(SelectionRangeParams params)
CompletableFuture<SemanticTokens>	semanticTokensFull(SemanticTokensParams params)

Methods inherited from class Object

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

Methods inherited from interface TextDocumentService

completion, declaration, documentHighlight, documentLinkResolve, implementation, inlineValue, linkedEditingRange, moniker, onTypeFormatting, prepareTypeHierarchy, resolveCodeAction, resolveCompletionItem, resolveInlayHint, semanticTokensFullDelta, semanticTokensRange, signatureHelp, typeDefinition, typeHierarchySubtypes, typeHierarchySupertypes, willSave, willSaveWaitUntil

Constructor Details

BSLTextDocumentService

@ConstructorProperties({"context","configuration","diagnosticProvider","codeActionProvider","codeLensProvider","documentLinkProvider","documentSymbolProvider","foldingRangeProvider","formatProvider","hoverProvider","referencesProvider","definitionProvider","callHierarchyProvider","selectionRangeProvider","colorProvider","renameProvider","inlayHintProvider","clientCapabilitiesHolder","semanticTokensProvider"})
public BSLTextDocumentService(ServerContext context,
 LanguageServerConfiguration configuration,
 DiagnosticProvider diagnosticProvider,
 CodeActionProvider codeActionProvider,
 CodeLensProvider codeLensProvider,
 DocumentLinkProvider documentLinkProvider,
 DocumentSymbolProvider documentSymbolProvider,
 FoldingRangeProvider foldingRangeProvider,
 FormatProvider formatProvider,
 HoverProvider hoverProvider,
 ReferencesProvider referencesProvider,
 DefinitionProvider definitionProvider,
 CallHierarchyProvider callHierarchyProvider,
 SelectionRangeProvider selectionRangeProvider,
 ColorProvider colorProvider,
 RenameProvider renameProvider,
 InlayHintProvider inlayHintProvider,
 ClientCapabilitiesHolder clientCapabilitiesHolder,
 SemanticTokensProvider semanticTokensProvider)

Method Details

hover

public CompletableFuture<@Nullable Hover> hover(HoverParams params)

Specified by:

hover in interface TextDocumentService

definition

public CompletableFuture<Either<List<? extends Location>, List<? extends LocationLink>>> definition(DefinitionParams params)

Specified by:

definition in interface TextDocumentService

references

public CompletableFuture<List<? extends Location>> references(ReferenceParams params)

Specified by:

references in interface TextDocumentService

documentSymbol

public CompletableFuture<List<Either<SymbolInformation, DocumentSymbol>>> documentSymbol(DocumentSymbolParams params)

Specified by:

documentSymbol in interface TextDocumentService

codeAction

public CompletableFuture<List<Either<Command, CodeAction>>> codeAction(CodeActionParams params)

Specified by:

codeAction in interface TextDocumentService

codeLens

public CompletableFuture<List<? extends CodeLens>> codeLens(CodeLensParams params)

Specified by:

codeLens in interface TextDocumentService

resolveCodeLens

public CompletableFuture<CodeLens> resolveCodeLens(CodeLens unresolved)

Specified by:

resolveCodeLens in interface TextDocumentService

formatting

public CompletableFuture<List<? extends TextEdit>> formatting(DocumentFormattingParams params)

Specified by:

formatting in interface TextDocumentService

rangeFormatting

public CompletableFuture<List<? extends TextEdit>> rangeFormatting(DocumentRangeFormattingParams params)

Specified by:

rangeFormatting in interface TextDocumentService

foldingRange

public CompletableFuture<List<FoldingRange>> foldingRange(FoldingRangeRequestParams params)

Specified by:

foldingRange in interface TextDocumentService

prepareCallHierarchy

public CompletableFuture<@Nullable List<CallHierarchyItem>> prepareCallHierarchy(CallHierarchyPrepareParams params)

Specified by:

prepareCallHierarchy in interface TextDocumentService

semanticTokensFull

public CompletableFuture<SemanticTokens> semanticTokensFull(SemanticTokensParams params)

Specified by:

semanticTokensFull in interface TextDocumentService

callHierarchyIncomingCalls

public CompletableFuture<List<CallHierarchyIncomingCall>> callHierarchyIncomingCalls(CallHierarchyIncomingCallsParams params)

Specified by:

callHierarchyIncomingCalls in interface TextDocumentService

callHierarchyOutgoingCalls

public CompletableFuture<List<CallHierarchyOutgoingCall>> callHierarchyOutgoingCalls(CallHierarchyOutgoingCallsParams params)

Specified by:

callHierarchyOutgoingCalls in interface TextDocumentService

selectionRange

public CompletableFuture<List<@Nullable SelectionRange>> selectionRange(SelectionRangeParams params)

Specified by:

selectionRange in interface TextDocumentService

documentColor

public CompletableFuture<List<ColorInformation>> documentColor(DocumentColorParams params)

Specified by:

documentColor in interface TextDocumentService

colorPresentation

public CompletableFuture<List<ColorPresentation>> colorPresentation(ColorPresentationParams params)

Specified by:

colorPresentation in interface TextDocumentService

inlayHint

public CompletableFuture<List<InlayHint>> inlayHint(InlayHintParams params)

Specified by:

inlayHint in interface TextDocumentService

didOpen

public void didOpen(DidOpenTextDocumentParams params)

Specified by:

didOpen in interface TextDocumentService

didChange

public void didChange(DidChangeTextDocumentParams params)

Specified by:

didChange in interface TextDocumentService

didClose

public void didClose(DidCloseTextDocumentParams params)

Specified by:

didClose in interface TextDocumentService

didSave

public void didSave(DidSaveTextDocumentParams params)

Specified by:

didSave in interface TextDocumentService

documentLink

public CompletableFuture<List<DocumentLink>> documentLink(DocumentLinkParams params)

Specified by:

documentLink in interface TextDocumentService

diagnostics

public CompletableFuture<Diagnostics> diagnostics(DiagnosticParams params)

Description copied from interface: ProtocolExtension

Запрос на вычисление диагностик для документа (расширение протокола).

Specified by:

diagnostics in interface ProtocolExtension

Parameters:

params - Параметры запроса.

Returns:

Список рассчитанных диагностик.

diagnostic

public CompletableFuture<DocumentDiagnosticReport> diagnostic(DocumentDiagnosticParams params)

Specified by:

diagnostic in interface TextDocumentService

prepareRename

public CompletableFuture<Either3<Range, PrepareRenameResult, PrepareRenameDefaultBehavior>> prepareRename(PrepareRenameParams params)

Specified by:

prepareRename in interface TextDocumentService

rename

public CompletableFuture<WorkspaceEdit> rename(RenameParams params)

Specified by:

rename in interface TextDocumentService

reset

public void reset()

handleInitializeEvent

@EventListener
public void handleInitializeEvent(LanguageServerInitializeRequestReceivedEvent ignored)

Обработчик события LanguageServerInitializeRequestReceivedEvent.

Проверяет поддержку клиентом pull-модели диагностик.

Parameters:

ignored - Событие

applyTextDocumentChanges

protected static String applyTextDocumentChanges(String content,
 List<TextDocumentContentChangeEvent> changes)

Применяет список изменений текста к исходному содержимому документа. Поддерживает как полные обновления (без range), так и инкрементальные изменения (с range).

Parameters:

content - текущее содержимое документа

changes - список изменений для применения

Returns:

обновленное содержимое документа

applyIncrementalChange

protected static String applyIncrementalChange(String content,
 TextDocumentContentChangeEvent change)

Применяет одно инкрементальное изменение к содержимому документа. Использует прямую замену по позициям символов для оптимизации и сохранения оригинальных переносов строк.

Parameters:

content - текущее содержимое документа

change - изменение для применения

Returns:

обновленное содержимое документа

getOffset

protected static int getOffset(String content,
 int line,
 int character)

Вычисляет абсолютную позицию символа в тексте по номеру строки и позиции в строке. Использует indexOf для быстрого поиска переносов строк.

Parameters:

content - содержимое документа

line - номер строки (0-based)

character - позиция символа в строке (0-based)

Returns:

абсолютная позиция символа в тексте