Merge pull request #1318 from 1c-syntax/feature/workspaceSymbol

Реализация workspaceSymbol

Author: nixel2007

src/main/java/com/github/_1c_syntax/bsl/languageserver/BSLLanguageServer.java

@@ -71,6 +71,7 @@ public CompletableFuture<InitializeResult> initialize(InitializeParams params) {
     capabilities.setCodeActionProvider(Boolean.TRUE);
     capabilities.setCodeLensProvider(new CodeLensOptions());
     capabilities.setDocumentLinkProvider(new DocumentLinkOptions());
+    capabilities.setWorkspaceSymbolProvider(Boolean.TRUE);
 
     InitializeResult result = new InitializeResult(capabilities);
 

src/main/java/com/github/_1c_syntax/bsl/languageserver/BSLWorkspaceService.java

@@ -22,6 +22,7 @@
 package com.github._1c_syntax.bsl.languageserver;
 
 import com.github._1c_syntax.bsl.languageserver.configuration.LanguageServerConfiguration;
+import com.github._1c_syntax.bsl.languageserver.providers.SymbolProvider;
 import lombok.RequiredArgsConstructor;
 import org.apache.commons.beanutils.PropertyUtils;
 import org.eclipse.lsp4j.DidChangeConfigurationParams;
@@ -40,10 +41,11 @@
 public class BSLWorkspaceService implements WorkspaceService {
 
   private final LanguageServerConfiguration configuration;
+  private final SymbolProvider symbolProvider;
 
   @Override
   public CompletableFuture<List<? extends SymbolInformation>> symbol(WorkspaceSymbolParams params) {
-    return null;
+    return CompletableFuture.supplyAsync(() -> symbolProvider.getSymbols(params));
   }
 
   @Override

src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/MethodSymbol.java

@@ -31,6 +31,7 @@
 import lombok.Value;
 import lombok.experimental.NonFinal;
 import org.eclipse.lsp4j.Range;
+import org.eclipse.lsp4j.SymbolKind;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -43,6 +44,9 @@
 public class MethodSymbol implements Symbol {
   String name;
 
+  @Builder.Default
+  SymbolKind symbolKind = SymbolKind.Method;
+
   Range range;
   Range subNameRange;
 

src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/RegionSymbol.java

@@ -30,6 +30,7 @@
 import lombok.Value;
 import lombok.experimental.NonFinal;
 import org.eclipse.lsp4j.Range;
+import org.eclipse.lsp4j.SymbolKind;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -42,6 +43,8 @@
 @ToString(exclude = {"children", "parent"})
 public class RegionSymbol implements Symbol {
   String name;
+  @Builder.Default
+  SymbolKind symbolKind = SymbolKind.Namespace;
   Range range;
   Range startRange;
   Range endRange;

src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/Symbol.java

@@ -25,6 +25,7 @@
 import lombok.Getter;
 import lombok.Setter;
 import org.eclipse.lsp4j.Range;
+import org.eclipse.lsp4j.SymbolKind;
 
 import java.util.Collections;
 import java.util.List;
@@ -34,6 +35,8 @@ public interface Symbol {
 
   String getName();
 
+  SymbolKind getSymbolKind();
+
   Range getRange();
 
   Optional<Symbol> getParent();
@@ -42,6 +45,10 @@ public interface Symbol {
 
   List<Symbol> getChildren();
 
+  default boolean isDeprecated() {
+    return false;
+  }
+
   default Optional<Symbol> getRootParent() {
     return getParent().flatMap(Symbol::getRootParent).or(() -> Optional.of(this));
   }
@@ -53,6 +60,8 @@ static Symbol emptySymbol() {
       @Getter
       private final String name = "empty";
       @Getter
+      private final SymbolKind symbolKind = SymbolKind.Null;
+      @Getter
       private final Range range = Ranges.create(-1, 0, -1, 0);
       @Getter
       @Setter

src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/VariableSymbol.java

@@ -31,6 +31,7 @@
 import lombok.Value;
 import lombok.experimental.NonFinal;
 import org.eclipse.lsp4j.Range;
+import org.eclipse.lsp4j.SymbolKind;
 
 import java.util.Collections;
 import java.util.List;
@@ -42,6 +43,8 @@
 @ToString(exclude = {"children", "parent"})
 public class VariableSymbol implements Symbol {
   String name;
+  @Builder.Default
+  SymbolKind symbolKind = SymbolKind.Variable;
   Range range;
   Range variableNameRange;
 

src/main/java/com/github/_1c_syntax/bsl/languageserver/providers/DocumentSymbolProvider.java

@@ -29,23 +29,15 @@
 import org.eclipse.lsp4j.DocumentSymbol;
 import org.eclipse.lsp4j.Range;
 import org.eclipse.lsp4j.SymbolInformation;
-import org.eclipse.lsp4j.SymbolKind;
 import org.eclipse.lsp4j.jsonrpc.messages.Either;
 import org.springframework.stereotype.Component;
 
 import java.util.List;
-import java.util.Map;
 import java.util.stream.Collectors;
 
 @Component
 public final class DocumentSymbolProvider {
 
-  private static final Map<Class<? extends Symbol>, SymbolKind> symbolKinds = Map.of(
-    MethodSymbol.class, SymbolKind.Method,
-    RegionSymbol.class, SymbolKind.Namespace,
-    VariableSymbol.class, SymbolKind.Variable
-  );
-
   public List<Either<SymbolInformation, DocumentSymbol>> getDocumentSymbols(DocumentContext documentContext) {
     return documentContext.getSymbolTree().getChildren().stream()
       .map(DocumentSymbolProvider::toDocumentSymbol)
@@ -56,7 +48,7 @@ public List<Either<SymbolInformation, DocumentSymbol>> getDocumentSymbols(Docume
   private static DocumentSymbol toDocumentSymbol(Symbol symbol) {
     var documentSymbol = new DocumentSymbol(
       symbol.getName(),
-      symbolKinds.get(symbol.getClass()),
+      symbol.getSymbolKind(),
       symbol.getRange(),
       getSelectionRange(symbol)
     );
@@ -65,7 +57,7 @@ private static DocumentSymbol toDocumentSymbol(Symbol symbol) {
       .map(DocumentSymbolProvider::toDocumentSymbol)
       .collect(Collectors.toList());
 
-    documentSymbol.setDeprecated(isDeprecated(symbol));
+    documentSymbol.setDeprecated(symbol.isDeprecated());
     documentSymbol.setChildren(children);
 
     return documentSymbol;
@@ -85,13 +77,4 @@ private static Range getSelectionRange(Symbol symbol) {
     return selectionRange;
   }
 
-  private static boolean isDeprecated(Symbol symbol) {
-    boolean deprecated;
-    if (symbol instanceof MethodSymbol) {
-      deprecated = ((MethodSymbol) symbol).isDeprecated();
-    } else {
-      deprecated = false;
-    }
-    return deprecated;
-  }
 }

src/main/java/com/github/_1c_syntax/bsl/languageserver/providers/SymbolProvider.java

@@ -0,0 +1,102 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright © 2018-2020
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Gryzlov <nixel2007@gmail.com> 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.github._1c_syntax.bsl.languageserver.context.DocumentContext;
+import com.github._1c_syntax.bsl.languageserver.context.ServerContext;
+import com.github._1c_syntax.bsl.languageserver.context.symbol.Symbol;
+import com.github._1c_syntax.bsl.languageserver.context.symbol.VariableSymbol;
+import com.github._1c_syntax.bsl.languageserver.context.symbol.variable.VariableKind;
+import com.github._1c_syntax.utils.CaseInsensitivePattern;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.tuple.Pair;
+import org.eclipse.lsp4j.Location;
+import org.eclipse.lsp4j.SymbolInformation;
+import org.eclipse.lsp4j.WorkspaceSymbolParams;
+import org.springframework.stereotype.Component;
+
+import java.net.URI;
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+import java.util.regex.Pattern;
+import java.util.regex.PatternSyntaxException;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+@Slf4j
+@Component
+@RequiredArgsConstructor
+public class SymbolProvider {
+
+  private final ServerContext context;
+
+  public List<? extends SymbolInformation> getSymbols(WorkspaceSymbolParams params) {
+    var queryString = Optional.ofNullable(params.getQuery())
+      .orElse("");
+
+    Pattern pattern;
+    try {
+      pattern = CaseInsensitivePattern.compile(queryString);
+    } catch (PatternSyntaxException e) {
+      LOGGER.debug(e.getMessage(), e);
+      return Collections.emptyList();
+    }
+
+    return context.getDocuments().values().stream()
+      .flatMap(SymbolProvider::getSymbolPairs)
+      .filter(symbolPair -> queryString.isEmpty() || pattern.matcher(symbolPair.getValue().getName()).find())
+      .map(SymbolProvider::createSymbolInformation)
+      .collect(Collectors.toList());
+  }
+
+  private static Stream<Pair<URI, Symbol>> getSymbolPairs(DocumentContext documentContext) {
+    return documentContext.getSymbolTree().getChildrenFlat().stream()
+      .filter(SymbolProvider::isSupported)
+      .map(symbol -> Pair.of(documentContext.getUri(), symbol));
+  }
+
+  private static boolean isSupported(Symbol symbol) {
+    var symbolKind = symbol.getSymbolKind();
+    switch (symbolKind) {
+      case Method:
+        return true;
+      case Variable:
+        return ((VariableSymbol) symbol).getKind() != VariableKind.LOCAL;
+      default:
+        return false;
+    }
+  }
+
+  private static SymbolInformation createSymbolInformation(Pair<URI, Symbol> symbolPair) {
+    var uri = symbolPair.getKey();
+    var symbol = symbolPair.getValue();
+    var symbolInformation = new SymbolInformation(
+      symbol.getName(),
+      symbol.getSymbolKind(),
+      new Location(uri.toString(), symbol.getRange())
+    );
+    symbolInformation.setDeprecated(symbol.isDeprecated());
+    return symbolInformation;
+  }
+}

src/test/java/com/github/_1c_syntax/bsl/languageserver/providers/CodeActionProviderTest.java

@@ -39,6 +39,7 @@
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.annotation.DirtiesContext;
 
 import java.util.Collections;
 import java.util.List;
@@ -47,6 +48,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 @SpringBootTest
+@DirtiesContext(classMode = DirtiesContext.ClassMode.BEFORE_EACH_TEST_METHOD)
 class CodeActionProviderTest {
 
   @Autowired
@@ -87,11 +89,11 @@ void testGetCodeActions() {
 
     // then
     assertThat(codeActions)
-      .hasSize(3)
       .extracting(Either::getRight)
+      .hasSizeGreaterThanOrEqualTo(3)
       .anyMatch(codeAction -> codeAction.getDiagnostics().contains(diagnostics.get(0)))
       .anyMatch(codeAction -> codeAction.getDiagnostics().contains(diagnostics.get(1)))
-      .allMatch(codeAction -> codeAction.getKind().equals(CodeActionKind.QuickFix))
+      .anyMatch(codeAction -> codeAction.getKind().equals(CodeActionKind.QuickFix))
     ;
   }
 
@@ -117,6 +119,7 @@ void testEmptyDiagnosticList() {
 
     // then
     assertThat(codeActions)
+      .filteredOn(codeAction -> codeAction.getRight().getKind().equals(CodeActionKind.QuickFix))
       .isEmpty();
   }
 }