Merge pull request #3364 from 1c-syntax/feature/annotation-hover

Всплывающая подсказка и переход к определениям для аннотаций в OneScript

Author: nixel2007

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

@@ -0,0 +1,85 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright (c) 2018-2024
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Fedkin <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.context.symbol;
+
+import com.github._1c_syntax.bsl.languageserver.context.DocumentContext;
+import com.github._1c_syntax.bsl.languageserver.context.symbol.description.MethodDescription;
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Setter;
+import lombok.ToString;
+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;
+import java.util.Optional;
+
+@Value
+@Builder
+@EqualsAndHashCode(onlyExplicitlyIncluded = true)
+@ToString(exclude = {"parent"})
+public class AnnotationSymbol implements SourceDefinedSymbol, Describable {
+
+  String name;
+
+  SymbolKind symbolKind;
+
+  @EqualsAndHashCode.Include
+  DocumentContext owner;
+
+  Range range;
+
+  @EqualsAndHashCode.Include
+  Range selectionRange;
+
+  @Setter
+  @NonFinal
+  @Builder.Default
+  Optional<SourceDefinedSymbol> parent = Optional.empty();
+
+  Optional<MethodDescription> description;
+
+  @Override
+  public List<SourceDefinedSymbol> getChildren() {
+    return Collections.emptyList();
+  }
+
+  @Override
+  public void accept(SymbolTreeVisitor visitor) {
+    // no-op
+  }
+
+  public static AnnotationSymbol from(String name, MethodSymbol methodSymbol) {
+    return AnnotationSymbol.builder()
+      .name(name)
+      .symbolKind(SymbolKind.TypeParameter)
+      .owner(methodSymbol.getOwner())
+      .range(methodSymbol.getRange())
+      .selectionRange(methodSymbol.getSelectionRange())
+      .description(methodSymbol.getDescription())
+      .parent(Optional.of(methodSymbol))
+      .build();
+  }
+}

src/main/java/com/github/_1c_syntax/bsl/languageserver/hover/AnnotationSymbolMarkupContentBuilder.java

@@ -0,0 +1,94 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright (c) 2018-2024
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Fedkin <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.hover;
+
+import com.github._1c_syntax.bsl.languageserver.context.symbol.AnnotationSymbol;
+import com.github._1c_syntax.bsl.languageserver.context.symbol.MethodSymbol;
+import lombok.RequiredArgsConstructor;
+import org.eclipse.lsp4j.MarkupContent;
+import org.eclipse.lsp4j.MarkupKind;
+import org.eclipse.lsp4j.SymbolKind;
+import org.springframework.stereotype.Component;
+
+import java.util.StringJoiner;
+
+/**
+ * Построитель контента для всплывающего окна для {@link AnnotationSymbol}.
+ */
+@Component
+@RequiredArgsConstructor
+public class AnnotationSymbolMarkupContentBuilder implements MarkupContentBuilder<AnnotationSymbol> {
+
+  private final DescriptionFormatter descriptionFormatter;
+
+  @Override
+  public MarkupContent getContent(AnnotationSymbol symbol) {
+    var maybeMethodSymbol = symbol.getParent();
+    if (maybeMethodSymbol.filter(MethodSymbol.class::isInstance).isEmpty()) {
+      return new MarkupContent(MarkupKind.MARKDOWN, "");
+    }
+
+    var markupBuilder = new StringJoiner("\n");
+    var methodSymbol = (MethodSymbol) maybeMethodSymbol.get();
+
+    // сигнатура
+    // местоположение метода
+    // описание метода
+    // параметры
+    // примеры
+    // варианты вызова
+
+    // сигнатура
+    String signature = descriptionFormatter.getSignature(symbol, methodSymbol);
+    descriptionFormatter.addSectionIfNotEmpty(markupBuilder, signature);
+
+    // местоположение метода
+    String methodLocation = descriptionFormatter.getLocation(methodSymbol);
+    descriptionFormatter.addSectionIfNotEmpty(markupBuilder, methodLocation);
+
+    // описание метода
+    String purposeSection = descriptionFormatter.getPurposeSection(methodSymbol);
+    descriptionFormatter.addSectionIfNotEmpty(markupBuilder, purposeSection);
+
+    // параметры
+    String parametersSection = descriptionFormatter.getParametersSection(methodSymbol);
+    descriptionFormatter.addSectionIfNotEmpty(markupBuilder, parametersSection);
+
+    // примеры
+    String examplesSection = descriptionFormatter.getExamplesSection(methodSymbol);
+    descriptionFormatter.addSectionIfNotEmpty(markupBuilder, examplesSection);
+
+    // варианты вызова
+    String callOptionsSection = descriptionFormatter.getCallOptionsSection(methodSymbol);
+    descriptionFormatter.addSectionIfNotEmpty(markupBuilder, callOptionsSection);
+
+    String content = markupBuilder.toString();
+
+    return new MarkupContent(MarkupKind.MARKDOWN, content);
+  }
+
+  @Override
+  public SymbolKind getSymbolKind() {
+    return SymbolKind.TypeParameter;
+  }
+
+}