com.github._1c_syntax.bsl.languageserver.providers.CommandProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bsl-language-server Show documentation
Language Server Protocol implementation for 1C (BSL) - 1C:Enterprise 8 and OneScript languages.
The newest version!
/*
 * This file is a part of BSL Language Server.
 *
 * Copyright (c) 2018-2024
 * 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.providers;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.github._1c_syntax.bsl.languageserver.commands.CommandArguments;
import com.github._1c_syntax.bsl.languageserver.commands.CommandSupplier;
import lombok.RequiredArgsConstructor;
import lombok.SneakyThrows;
import org.eclipse.lsp4j.ExecuteCommandParams;
import org.springframework.stereotype.Component;

import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletableFuture;

/**
 * Провайдер, обрабатывающий запросы {@code workspace/executeCommans}.
 *
 * @see Execute a command specification.
 */
@Component
@RequiredArgsConstructor
public class CommandProvider {

  private final Map> commandSuppliersById;
  private final ObjectMapper objectMapper;

  private final CodeLensProvider codeLensProvider;
  private final InlayHintProvider inlayHintProvider;

  /**
   * Выполнить серверную команду.
   *
   * @param arguments Аргументы команды.
   *
   * @return Результат выполнения команды.
   */
  public Object executeCommand(CommandArguments arguments) {
    var commandId = arguments.getId();

    var commandSupplier = commandSuppliersById.get(commandId);
    if (commandSupplier == null) {
      throw new RuntimeException("Unknown command id: " + commandId);
    }

    var result = commandSupplier
      .execute(arguments)
      .orElse(null);

    CompletableFuture.runAsync(() -> {
      if (commandSupplier.needRefreshInlayHintsAfterExecuteCommand()) {
        inlayHintProvider.refreshInlayHints();
      }
      if (commandSupplier.needRefreshCodeLensesAfterExecuteCommand()) {
        codeLensProvider.refreshCodeLenses();
      }
    });

    return result;
  }

  /**
   * Список идентификаторов известных серверных команд.
   *
   * @return Список идентификаторов известных серверных команд.
   */
  public List getCommandIds() {
    return List.copyOf(commandSuppliersById.keySet());
  }

  /**
   * Извлечь аргументы команды из параметров входящего запроса.
   *
   * @param executeCommandParams Параметры запроса workspace/executeCommand.
   * @return Аргументы команды.
   *
   * @throws RuntimeException Выбрасывает исключение, если параметры входящего запроса не содержат
   * данных для вычисления аргументов команды.
   */
  @SneakyThrows
  public CommandArguments extractArguments(ExecuteCommandParams executeCommandParams) {
    var rawArguments = executeCommandParams.getArguments();

    if (rawArguments.isEmpty()) {
      throw new RuntimeException("Command arguments is empty");
    }

    var rawArgument = rawArguments.get(0);

    if (rawArgument instanceof CommandArguments) {
      return (CommandArguments) rawArgument;
    }

    return objectMapper.readValue(rawArgument.toString(), CommandArguments.class);
  }

}