Merge pull request #3420 from 1c-syntax/feature/parameter-annotation

Добавлено хранение информации об аннотации параметров методов.

src/main/java/com/github/_1c_syntax/bsl/languageserver/context/computer/MethodSymbolComputer.java

@@ -245,6 +245,7 @@ private static List<ParameterDefinition> createParameters(
           .name(parameterName)
           .byValue(param.VAL_KEYWORD() != null)
           .defaultValue(getDefaultValue(param))
+          .annotations(createAnnotations(param.annotation()))
           .range(getParameterRange(param))
           .description(getParameterDescription(parameterName, description))
           .build();

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

@@ -38,6 +38,7 @@
 import org.eclipse.lsp4j.SymbolKind;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
 
@@ -87,12 +88,12 @@ public class MethodSymbol implements SourceDefinedSymbol, Exportable, Describabl
   boolean deprecated;
 
   @Builder.Default
-  List<ParameterDefinition> parameters = new ArrayList<>();
+  List<ParameterDefinition> parameters = Collections.emptyList();
 
   @Builder.Default
   Optional<CompilerDirectiveKind> compilerDirectiveKind = Optional.empty();
   @Builder.Default
-  List<Annotation> annotations = new ArrayList<>();
+  List<Annotation> annotations = Collections.emptyList();
 
   @Override
   public Range getRange() {

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

@@ -21,6 +21,7 @@
  */
 package com.github._1c_syntax.bsl.languageserver.context.symbol;
 
+import com.github._1c_syntax.bsl.languageserver.context.symbol.annotations.Annotation;
 import com.github._1c_syntax.bsl.languageserver.context.symbol.description.ParameterDescription;
 import com.github._1c_syntax.bsl.languageserver.utils.Ranges;
 import lombok.AccessLevel;
@@ -29,6 +30,8 @@
 import lombok.Value;
 import org.eclipse.lsp4j.Range;
 
+import java.util.Collections;
+import java.util.List;
 import java.util.Optional;
 
 /**
@@ -58,6 +61,9 @@ public class ParameterDefinition {
    */
   DefaultValue defaultValue;
 
+  @Builder.Default
+  List<Annotation> annotations = Collections.emptyList();
+
   @Getter(AccessLevel.NONE)
   int startLine;
   @Getter(AccessLevel.NONE)
@@ -92,12 +98,8 @@ public enum ParameterType {
     EMPTY
   }
 
-  @Value
-  public static class DefaultValue {
-    public static final DefaultValue EMPTY = new DefaultValue(ParameterType.EMPTY, "");
-
-    ParameterType type;
-    String value;
+  public record DefaultValue(ParameterType type, String value) {
+      public static final DefaultValue EMPTY = new DefaultValue(ParameterType.EMPTY, "");
   }
 
   public static class ParameterDefinitionBuilder {

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

@@ -24,7 +24,7 @@
 import lombok.Builder;
 import lombok.Value;
 
-import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 
 /**
@@ -38,5 +38,5 @@ public class Annotation {
   AnnotationKind kind;
 
   @Builder.Default
-  List<AnnotationParameterDefinition> parameters = new ArrayList<>();
+  List<AnnotationParameterDefinition> parameters = Collections.emptyList();
 }

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

@@ -25,6 +25,7 @@
 import com.github._1c_syntax.bsl.languageserver.context.symbol.MethodSymbol;
 import com.github._1c_syntax.bsl.languageserver.context.symbol.ParameterDefinition;
 import com.github._1c_syntax.bsl.languageserver.context.symbol.VariableSymbol;
+import com.github._1c_syntax.bsl.languageserver.context.symbol.annotations.Annotation;
 import com.github._1c_syntax.bsl.languageserver.context.symbol.description.MethodDescription;
 import com.github._1c_syntax.bsl.languageserver.context.symbol.description.ParameterDescription;
 import com.github._1c_syntax.bsl.languageserver.context.symbol.description.TypeDescription;
@@ -180,7 +181,7 @@ public String getSignature(MethodSymbol methodSymbol) {
     }
     String methodName = methodSymbol.getName();
 
-    var parameters = getParametersDescriptionPart(methodSymbol);
+    var parameters = getParametersSignatureDescription(methodSymbol);
     var returnedValueType = getReturnedValueTypeDescriptionPart(methodSymbol);
     String export = methodSymbol.isExport() ? (" " + getResourceString(EXPORT_KEY)) : "";
 
@@ -200,7 +201,7 @@ public String getSignature(AnnotationSymbol symbol, MethodSymbol methodSymbol) {
     var annotationKind = getResourceString(ANNOTATION_KEY);
     var annotationName = symbol.getName();
 
-    var parameters = getParametersDescriptionPart(methodSymbol);
+    var parameters = getParametersSignatureDescription(methodSymbol);
 
     return String.format(
       signatureTemplate,
@@ -225,37 +226,47 @@ public String getSignature(VariableSymbol symbol) {
     );
   }
 
-  private String getParametersDescriptionPart(MethodSymbol methodSymbol) {
+  public String getParametersSignatureDescription(MethodSymbol methodSymbol) {
     var parametersDescription = new StringJoiner(", ");
     methodSymbol.getParameters().forEach((ParameterDefinition parameterDefinition) -> {
-      var parameter = "";
+      StringBuilder parameter = new StringBuilder();
+      parameter.append(getAnnotationsDescriptionPart(parameterDefinition));
       var parameterName = parameterDefinition.getName();
 
       if (parameterDefinition.isByValue()) {
-        parameter = parameter + getResourceString(VAL_KEY) + " ";
+        parameter.append(getResourceString(VAL_KEY)).append(" ");
       }
-      parameter += parameterName;
+      parameter.append(parameterName);
 
       var parameterTypes = parameterDefinition.getDescription()
         .map(ParameterDescription::getTypes)
         .map(DescriptionFormatter::getTypes)
         .orElse("");
 
       if (!parameterTypes.isEmpty()) {
-        parameter += ": " + parameterTypes;
+        parameter.append(": ").append(parameterTypes);
       }
 
       if (parameterDefinition.isOptional()) {
-        parameter += " = ";
-        parameter += parameterDefinition.getDefaultValue().getValue();
+        parameter.append(" = ");
+        parameter.append(parameterDefinition.getDefaultValue().value());
       }
 
-      parametersDescription.add(parameter);
+      parametersDescription.add(parameter.toString());
     });
 
     return parametersDescription.toString();
   }
 
+  private static String getAnnotationsDescriptionPart(ParameterDefinition parameterDefinition) {
+    var description = new StringBuilder();
+    for (Annotation annotation : parameterDefinition.getAnnotations()) {
+      description.append("&").append(annotation.getName()).append(" ");
+    }
+
+    return description.toString();
+  }
+
   private static String getReturnedValueTypeDescriptionPart(MethodSymbol methodSymbol) {
     String returnedValueType = methodSymbol.getDescription()
       .map(MethodDescription::getReturnedValue)
@@ -275,18 +286,17 @@ private static String getTypes(List<TypeDescription> typeDescriptions) {
       .collect(Collectors.joining(" | "));
   }
 
-
-  public String parameterToString(ParameterDescription parameter, int level) {
+  public String parameterToString(ParameterDescription parameterDescription, int level) {
     var result = new StringJoiner("  \n"); // два пробела
-    Map<String, String> typesMap = typesToMap(parameter.getTypes(), level);
+    Map<String, String> typesMap = typesToMap(parameterDescription.getTypes(), level);
     var parameterTemplate = "  ".repeat(level) + PARAMETER_TEMPLATE;
 
     if (typesMap.size() == 1) {
       result.add(String.format(parameterTemplate,
-        parameter.getName(),
+        parameterDescription.getName(),
         typesMapToString(typesMap, 0)));
     } else {
-      result.add(String.format(parameterTemplate, parameter.getName(), ""));
+      result.add(String.format(parameterTemplate, parameterDescription.getName(), ""));
       result.add(typesMapToString(typesMap, level + 1));
     }
     return result.toString();
@@ -299,7 +309,11 @@ public String parameterToString(ParameterDefinition parameterDefinition) {
       return parameterToString(parameterDescription.get(), level);
     }
 
-    return String.format(PARAMETER_TEMPLATE, parameterDefinition.getName(), "");
+    return String.format(
+      PARAMETER_TEMPLATE,
+      parameterDefinition.getName(),
+      ""
+    );
   }
 
   private Map<String, String> typesToMap(List<TypeDescription> parameterTypes, int level) {

src/main/java/com/github/_1c_syntax/bsl/languageserver/inlayhints/SourceDefinedMethodCallInlayHintSupplier.java

@@ -149,7 +149,7 @@ private void setLabelAndPadding(
       && !defaultValue.equals(ParameterDefinition.DefaultValue.EMPTY)
     ) {
       labelBuilder.append(" (");
-      labelBuilder.append(defaultValue.getValue());
+      labelBuilder.append(defaultValue.value());
       labelBuilder.append(")");
     } else {
       labelBuilder.append(":");

src/test/java/com/github/_1c_syntax/bsl/languageserver/context/computer/MethodSymbolComputerTest.java

@@ -57,7 +57,7 @@ void testMethodSymbolComputer() {
     var documentContext = TestUtils.getDocumentContextFromFile("./src/test/resources/context/computer/MethodSymbolComputerTest.bsl");
     List<MethodSymbol> methods = documentContext.getSymbolTree().getMethods();
 
-    assertThat(methods.size()).isEqualTo(24);
+    assertThat(methods.size()).isEqualTo(25);
 
     assertThat(methods.get(0).getName()).isEqualTo("Один");
     assertThat(methods.get(0).getDescription()).isNotPresent();
@@ -215,13 +215,13 @@ void testParameters() {
     assertThat(parameters.get(2).getName()).isEqualTo("Парам3");
     assertThat(parameters.get(2).isByValue()).isFalse();
     assertThat(parameters.get(2).isOptional()).isTrue();
-    assertThat(parameters.get(2).getDefaultValue().getValue()).isEqualTo("0");
+    assertThat(parameters.get(2).getDefaultValue().value()).isEqualTo("0");
     assertThat(parameters.get(2).getRange()).isEqualTo(Ranges.create(14, 32, 38));
 
     assertThat(parameters.get(3).getName()).isEqualTo("Парам4");
     assertThat(parameters.get(3).isByValue()).isTrue();
     assertThat(parameters.get(3).isOptional()).isTrue();
-    assertThat(parameters.get(3).getDefaultValue().getValue()).isEqualTo("0");
+    assertThat(parameters.get(3).getDefaultValue().value()).isEqualTo("0");
     assertThat(parameters.get(3).getRange()).isEqualTo(Ranges.create(14, 49, 55));
 
     parameters = methods.get(23).getParameters();
@@ -232,6 +232,22 @@ void testParameters() {
     assertThat(parameters.get(2).getName()).isEqualTo("Парам3");
     assertThat(parameters.get(2).getDescription()).isPresent();
 
+    parameters = methods.get(24).getParameters();
+    assertThat(parameters.get(0).getName()).isEqualTo("Парам1");
+    assertThat(parameters.get(0).getAnnotations()).hasSize(1);
+    assertThat(parameters.get(0).getAnnotations().get(0).getName()).isEqualTo("Повторяемый");
+    assertThat(parameters.get(0).getAnnotations().get(0).getKind()).isEqualTo(AnnotationKind.CUSTOM);
+    assertThat(parameters.get(0).getAnnotations().get(0).getParameters()).isEmpty();
+    assertThat(parameters.get(1).getName()).isEqualTo("Парам2");
+    assertThat(parameters.get(1).getAnnotations()).hasSize(1);
+    assertThat(parameters.get(1).getAnnotations().get(0).getName()).isEqualTo("ДругаяАннотация");
+    assertThat(parameters.get(1).getAnnotations().get(0).getKind()).isEqualTo(AnnotationKind.CUSTOM);
+    assertThat(parameters.get(1).getAnnotations().get(0).getParameters()).hasSize(1);
+    assertThat(parameters.get(1).getAnnotations().get(0).getParameters().get(0).getName()).isEqualTo("");
+    assertThat(parameters.get(1).getAnnotations().get(0).getParameters().get(0).getValue()).isEqualTo("СПараметром");
+    assertThat(parameters.get(2).getName()).isEqualTo("Парам3");
+    assertThat(parameters.get(2).getAnnotations()).isEmpty();
+
   }
 
   @Test

src/test/java/com/github/_1c_syntax/bsl/languageserver/hover/DescriptionFormatterTest.java

@@ -0,0 +1,51 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright (c) 2018-2025
+ * Alexey Sosnoviy <[email protected]>, Nikita Fedkin <[email protected]> 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.util.TestUtils;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.*;
+
+@SpringBootTest
+class DescriptionFormatterTest {
+
+  @Autowired
+  private DescriptionFormatter descriptionFormatter;
+
+  @Test
+  void whenParameterOfMethodHasAnnotations_thenAnnotationIsAddedToParameterSignatureDescription() {
+    // given
+    var documentContext = TestUtils.getDocumentContextFromFile("./src/test/resources/hover/DescriptionFormatter.bsl");
+    var methodSymbol = documentContext.getSymbolTree().getMethodSymbol("МетодСАннотациямиПараметров").orElseThrow();
+
+    // when
+    var description = descriptionFormatter.getParametersSignatureDescription(methodSymbol);
+
+    // then
+    assertThat(description).isEqualTo("&Повторяемый Парам1, Парам2");
+  }
+
+}

src/test/resources/context/computer/MethodSymbolComputerTest.bsl

@@ -115,5 +115,8 @@
 // Параметры:
 //  Парам1 - Строка - Парам
 //  Парам3 - Строка - Парам
-Процедура Метод25(Парам1, Парам2, Парам3)
-КонецПроцедуры
+Процедура Метод24(Парам1, Парам2, Парам3)
+КонецПроцедуры
+
+Процедура Метод25(&Повторяемый Парам1, &ДругаяАннотация("СПараметром") Парам2, Парам3)
+КонецПроцедуры

src/test/resources/hover/DescriptionFormatter.bsl

@@ -0,0 +1,3 @@
+Процедура МетодСАннотациямиПараметров(&Повторяемый Парам1, Парам2) Экспорт
+
+КонецПроцедуры