All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.github._1c_syntax.bsl.languageserver.BSLLanguageServer Maven / Gradle / Ivy

/*
 * This file is a part of BSL Language Server.
 *
 * Copyright (c) 2018-2022
 * Alexey Sosnoviy , Nikita Fedkin  and contributors
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later
 *
 * BSL Language Server is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3.0 of the License, or (at your option) any later version.
 *
 * BSL Language Server is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with BSL Language Server.
 */
package com.github._1c_syntax.bsl.languageserver;

import com.github._1c_syntax.bsl.languageserver.configuration.LanguageServerConfiguration;
import com.github._1c_syntax.bsl.languageserver.context.ServerContext;
import com.github._1c_syntax.bsl.languageserver.jsonrpc.DiagnosticParams;
import com.github._1c_syntax.bsl.languageserver.jsonrpc.Diagnostics;
import com.github._1c_syntax.bsl.languageserver.jsonrpc.ProtocolExtension;
import com.github._1c_syntax.bsl.languageserver.providers.DocumentSymbolProvider;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.eclipse.lsp4j.CallHierarchyRegistrationOptions;
import org.eclipse.lsp4j.ClientCapabilities;
import org.eclipse.lsp4j.CodeActionKind;
import org.eclipse.lsp4j.CodeActionOptions;
import org.eclipse.lsp4j.CodeLensOptions;
import org.eclipse.lsp4j.ColorProviderOptions;
import org.eclipse.lsp4j.DefinitionOptions;
import org.eclipse.lsp4j.DocumentFormattingOptions;
import org.eclipse.lsp4j.DocumentLinkOptions;
import org.eclipse.lsp4j.DocumentRangeFormattingOptions;
import org.eclipse.lsp4j.DocumentSymbolOptions;
import org.eclipse.lsp4j.FoldingRangeProviderOptions;
import org.eclipse.lsp4j.HoverOptions;
import org.eclipse.lsp4j.InitializeParams;
import org.eclipse.lsp4j.InitializeResult;
import org.eclipse.lsp4j.ReferenceOptions;
import org.eclipse.lsp4j.RenameCapabilities;
import org.eclipse.lsp4j.RenameOptions;
import org.eclipse.lsp4j.SaveOptions;
import org.eclipse.lsp4j.SelectionRangeRegistrationOptions;
import org.eclipse.lsp4j.ServerCapabilities;
import org.eclipse.lsp4j.ServerInfo;
import org.eclipse.lsp4j.TextDocumentClientCapabilities;
import org.eclipse.lsp4j.TextDocumentSyncKind;
import org.eclipse.lsp4j.TextDocumentSyncOptions;
import org.eclipse.lsp4j.WorkspaceSymbolOptions;
import org.eclipse.lsp4j.jsonrpc.messages.Either;
import org.eclipse.lsp4j.services.LanguageServer;
import org.eclipse.lsp4j.services.TextDocumentService;
import org.eclipse.lsp4j.services.WorkspaceService;
import org.springframework.stereotype.Component;

import java.io.File;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.file.Path;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;

@Slf4j
@Component
@RequiredArgsConstructor
public class BSLLanguageServer implements LanguageServer, ProtocolExtension {

  private final LanguageServerConfiguration configuration;
  private final BSLTextDocumentService textDocumentService;
  private final BSLWorkspaceService workspaceService;
  private final ClientCapabilitiesHolder clientCapabilitiesHolder;
  private final ServerContext context;
  private final ServerInfo serverInfo;
  private boolean shutdownWasCalled;

  @Override
  public CompletableFuture initialize(InitializeParams params) {

    clientCapabilitiesHolder.setCapabilities(params.getCapabilities());
    
    setConfigurationRoot(params);
    CompletableFuture.runAsync(context::populateContext);

    var capabilities = new ServerCapabilities();
    capabilities.setTextDocumentSync(getTextDocumentSyncOptions());
    capabilities.setDocumentRangeFormattingProvider(getDocumentRangeFormattingProvider());
    capabilities.setDocumentFormattingProvider(getDocumentFormattingProvider());
    capabilities.setFoldingRangeProvider(getFoldingRangeProvider());
    capabilities.setDocumentSymbolProvider(getDocumentSymbolProvider());
    capabilities.setCodeActionProvider(getCodeActionProvider());
    capabilities.setCodeLensProvider(getCodeLensProvider());
    capabilities.setDocumentLinkProvider(getDocumentLinkProvider());
    capabilities.setWorkspaceSymbolProvider(getWorkspaceProvider());
    capabilities.setHoverProvider(getHoverProvider());
    capabilities.setReferencesProvider(getReferencesProvider());
    capabilities.setDefinitionProvider(getDefinitionProvider());
    capabilities.setCallHierarchyProvider(getCallHierarchyProvider());
    capabilities.setSelectionRangeProvider(getSelectionRangeProvider());
    capabilities.setColorProvider(getColorProvider());
    capabilities.setRenameProvider(getRenameProvider(params));

    var result = new InitializeResult(capabilities, serverInfo);

    return CompletableFuture.completedFuture(result);
  }

  private void setConfigurationRoot(InitializeParams params) {
    var workspaceFolders = params.getWorkspaceFolders();
    if (workspaceFolders == null || workspaceFolders.isEmpty()) {
      return;
    }

    String rootUri = workspaceFolders.get(0).getUri();
    Path rootPath;
    try {
      rootPath = new File(new URI(rootUri).getPath()).getCanonicalFile().toPath();
    } catch (URISyntaxException | IOException e) {
      LOGGER.error("Can't read root URI from initialization params.", e);
      return;
    }

    Path configurationRoot = LanguageServerConfiguration.getCustomConfigurationRoot(
      configuration,
      rootPath);
    context.setConfigurationRoot(configurationRoot);
  }

  @Override
  public CompletableFuture shutdown() {
    shutdownWasCalled = true;
    textDocumentService.reset();
    context.clear();
    return CompletableFuture.completedFuture(Boolean.TRUE);
  }

  @Override
  public void exit() {
    int status = shutdownWasCalled ? 0 : 1;
    System.exit(status);
  }

  /**
   * {@inheritDoc}
   * 

* См. {@link BSLTextDocumentService#diagnostics(DiagnosticParams)} */ @Override public CompletableFuture diagnostics(DiagnosticParams params) { return textDocumentService.diagnostics(params); } @Override public TextDocumentService getTextDocumentService() { return textDocumentService; } @Override public WorkspaceService getWorkspaceService() { return workspaceService; } private static TextDocumentSyncOptions getTextDocumentSyncOptions() { var textDocumentSync = new TextDocumentSyncOptions(); textDocumentSync.setOpenClose(Boolean.TRUE); textDocumentSync.setChange(TextDocumentSyncKind.Full); textDocumentSync.setWillSave(Boolean.FALSE); textDocumentSync.setWillSaveWaitUntil(Boolean.FALSE); var save = new SaveOptions(); save.setIncludeText(Boolean.FALSE); textDocumentSync.setSave(save); return textDocumentSync; } private static CodeActionOptions getCodeActionProvider() { var codeActionOptions = new CodeActionOptions(); codeActionOptions.setWorkDoneProgress(Boolean.FALSE); codeActionOptions.setResolveProvider(Boolean.FALSE); var codeActionKinds = List.of( CodeActionKind.QuickFix, CodeActionKind.Refactor ); codeActionOptions.setCodeActionKinds(codeActionKinds); return codeActionOptions; } private static DocumentSymbolOptions getDocumentSymbolProvider() { var documentSymbolOptions = new DocumentSymbolOptions(); documentSymbolOptions.setWorkDoneProgress(Boolean.FALSE); documentSymbolOptions.setLabel(DocumentSymbolProvider.LABEL); return documentSymbolOptions; } private static FoldingRangeProviderOptions getFoldingRangeProvider() { var foldingRangeProviderOptions = new FoldingRangeProviderOptions(); foldingRangeProviderOptions.setWorkDoneProgress(Boolean.FALSE); return foldingRangeProviderOptions; } private static DocumentFormattingOptions getDocumentFormattingProvider() { var documentFormattingOptions = new DocumentFormattingOptions(); documentFormattingOptions.setWorkDoneProgress(Boolean.FALSE); return documentFormattingOptions; } private static DocumentRangeFormattingOptions getDocumentRangeFormattingProvider() { var documentRangeFormattingOptions = new DocumentRangeFormattingOptions(); documentRangeFormattingOptions.setWorkDoneProgress(Boolean.FALSE); return documentRangeFormattingOptions; } private static CodeLensOptions getCodeLensProvider() { var codeLensOptions = new CodeLensOptions(); codeLensOptions.setResolveProvider(Boolean.TRUE); codeLensOptions.setWorkDoneProgress(Boolean.FALSE); return codeLensOptions; } private static DocumentLinkOptions getDocumentLinkProvider() { var documentLinkOptions = new DocumentLinkOptions(); documentLinkOptions.setResolveProvider(Boolean.FALSE); return documentLinkOptions; } private static HoverOptions getHoverProvider() { var hoverOptions = new HoverOptions(); hoverOptions.setWorkDoneProgress(Boolean.FALSE); return hoverOptions; } private static DefinitionOptions getDefinitionProvider() { var definitionOptions = new DefinitionOptions(); definitionOptions.setWorkDoneProgress(Boolean.FALSE); return definitionOptions; } private static ReferenceOptions getReferencesProvider() { var referenceOptions = new ReferenceOptions(); referenceOptions.setWorkDoneProgress(Boolean.FALSE); return referenceOptions; } private static CallHierarchyRegistrationOptions getCallHierarchyProvider() { var callHierarchyRegistrationOptions = new CallHierarchyRegistrationOptions(); callHierarchyRegistrationOptions.setWorkDoneProgress(Boolean.FALSE); return callHierarchyRegistrationOptions; } private static WorkspaceSymbolOptions getWorkspaceProvider() { var workspaceSymbolOptions = new WorkspaceSymbolOptions(); workspaceSymbolOptions.setWorkDoneProgress(Boolean.FALSE); return workspaceSymbolOptions; } private static SelectionRangeRegistrationOptions getSelectionRangeProvider() { var selectionRangeRegistrationOptions = new SelectionRangeRegistrationOptions(); selectionRangeRegistrationOptions.setWorkDoneProgress(Boolean.FALSE); return selectionRangeRegistrationOptions; } private static ColorProviderOptions getColorProvider() { var colorProviderOptions = new ColorProviderOptions(); colorProviderOptions.setWorkDoneProgress(Boolean.FALSE); return colorProviderOptions; } private static Either getRenameProvider(InitializeParams params) { if (Boolean.TRUE.equals(getRenamePrepareSupport(params))) { var renameOptions = new RenameOptions(); renameOptions.setWorkDoneProgress(Boolean.FALSE); renameOptions.setPrepareProvider(Boolean.TRUE); return Either.forRight(renameOptions); } else { return Either.forLeft(Boolean.TRUE); } } private static Boolean getRenamePrepareSupport(InitializeParams params) { return Optional.of(params) .map(InitializeParams::getCapabilities) .map(ClientCapabilities::getTextDocument) .map(TextDocumentClientCapabilities::getRename) .map(RenameCapabilities::getPrepareSupport) .orElse(false); } }