Merge pull request #4376 from 1c-syntax/feat/types-tabular-row-see-ref

feat(types): тип уточняется ссылкой «См.»

Author: nixel2007

build.gradle.kts

@@ -96,7 +96,7 @@ dependencies {
     api("org.springframework.ai:spring-ai-starter-mcp-server-webmvc")
 
     // 1c-syntax
-    api("io.github.1c-syntax:bsl-parser:0.38.0")
+    api("io.github.1c-syntax:bsl-parser:0.39.0")
     api("io.github.1c-syntax:utils:0.10.1")
     api("io.github.1c-syntax:mdclasses:0.19.0.82-SNAPSHOT")
     api("io.github.1c-syntax:bsl-common-library:0.12.4")

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

@@ -358,6 +358,11 @@ private Map<String, String> typesToMap(List<TypeDescription> parameterTypes, int
       } else {
         typeName = "`%s`".formatted(type.name());
       }
+      var hyperlink = type.hyperlink();
+      if (hyperlink != null && !(type instanceof HyperlinkTypeDescription)) {
+        // Тип, уточнённый ссылкой: автор написал обе половины — показываем обе.
+        typeName = "%s: [%s](%s)".formatted(typeName, hyperlink.link(), hyperlink.link());
+      }
 
       types.merge(typeDescription, typeName, "%s | %s"::formatted);
     });

src/main/java/com/github/_1c_syntax/bsl/languageserver/semantictokens/BslDocSemanticTokensSupplier.java

@@ -28,6 +28,7 @@
 import com.github._1c_syntax.bsl.languageserver.utils.DescriptionTypes;
 import com.github._1c_syntax.bsl.parser.description.SourceDefinedSymbolDescription;
 import com.github._1c_syntax.bsl.parser.description.TypeDescription;
+import com.github._1c_syntax.bsl.parser.description.support.SimpleRange;
 import lombok.RequiredArgsConstructor;
 import lombok.Setter;
 import org.eclipse.lsp4j.ClientCapabilities;
@@ -45,6 +46,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.stream.Stream;
 
 /**
  * Сапплаер семантических токенов для BSL документации (описаний методов и переменных).
@@ -305,13 +307,29 @@ private void addTypeTokens(
     var fileType = documentContext.getFileType();
     DescriptionTypes.typesOf(description)
       .filter(type -> !validateTypeResolution || isResolvable(type, fileType))
-      .map(type -> type.element().range())
+      .flatMap(BslDocSemanticTokensSupplier::typeRanges)
       .distinct()
       .forEach(range -> helper.addEntry(semanticElements,
         range.startLine(), range.startCharacter(), range.length(),
         SemanticTokenTypes.Type, SemanticTokenModifiers.Documentation));
   }
 
+  /**
+   * Области типа: его имя и — у типа, уточнённого ссылкой, — сама ссылка. Отдельно
+   * стоящая ссылка подсвечивается как тип, поэтому и уточняющая должна.
+   *
+   * @param type описание типа.
+   * @return области для подсветки.
+   */
+  private static Stream<SimpleRange> typeRanges(TypeDescription type) {
+    var element = Stream.of(type.element().range());
+    var hyperlink = type.hyperlink();
+    if (hyperlink == null || type.variant() != TypeDescription.Variant.SIMPLE) {
+      return element;
+    }
+    return Stream.concat(element, Stream.of(hyperlink.range()));
+  }
+
   /**
    * Резолвится ли тип описания в реальный тип через {@link TypeService}. Имя типа для резолва берётся
    * из семантических аксессоров парсера ({@link DescriptionTypes#resolveName}); гиперссылки {@code См.}

src/main/java/com/github/_1c_syntax/bsl/languageserver/types/index/SymbolTypeIndex.java

@@ -76,6 +76,25 @@ public class SymbolTypeIndex {
   /** Коллекция строк — у дерева значений строки лежат в ней, а не в самом дереве. */
   private static final String ROWS = "Строки";
 
+  /** Наименьшая ссылка на метаданные: вид объекта, его имя и имя подчинённого. */
+  private static final int MIN_METADATA_SEGMENTS = 3;
+
+  /** Номер части ссылки на метаданные: вид объекта. */
+  private static final int KIND_PART = 0;
+
+  /** Номер части ссылки на метаданные: имя объекта. */
+  private static final int NAME_PART = 1;
+
+  /** Номер части ссылки на метаданные: имя подчинённого — табличной части либо реквизита. */
+  private static final int CHILD_PART = 2;
+
+  /** Номер части ссылки на метаданные: имя реквизита табличной части. */
+  private static final int ATTRIBUTE_PART = 3;
+
+  private static final String OBJECT = "Объект.";
+  private static final String TABULAR_SECTION = "ТабличнаяЧасть.";
+  private static final String TABULAR_SECTION_ROW = "ТабличнаяЧастьСтрока.";
+
   private final TypeRegistry typeRegistry;
 
   private final Map<MethodSymbol, TypeSet> declaredReturnTypes = new ConcurrentHashMap<>();
@@ -358,6 +377,10 @@ private TypeSet resolveSeeReference(
       if (!hyperlinkTypes.isEmpty()) {
         return hyperlinkTypes;
       }
+      var metadataTypes = resolveMetadataPath(link, fileType);
+      if (!metadataTypes.isEmpty()) {
+        return metadataTypes;
+      }
       // Не разрешилось как ссылка на член (Модуль.Метод / Тип.Член) — пробуем
       // трактовать как полное имя типа (например, квалифицированный платформенный
       // тип) через TypeRegistry ниже.
@@ -369,6 +392,84 @@ private TypeSet resolveSeeReference(
     return typeRegistry.resolve(link, fileType).map(TypeSet::of).orElse(TypeSet.EMPTY);
   }
 
+  /**
+   * Тип по ссылке в нотации конфигуратора: {@code Справочник.Товары.ЕдиницыИзмерения} —
+   * табличная часть, {@code Справочник.Товары.ЕдиницыИзмерения.Единица} — её реквизит,
+   * {@code Справочник.Товары.Артикул} — реквизит самого объекта.
+   * <p>
+   * Имена таких типов реестр складывает из того же вида объекта метаданных, что стоит
+   * в начале ссылки, поэтому путь собирается прямо из её частей. Части, оставшиеся
+   * после объекта метаданных, читаются как цепочка членов ({@link #walkMembers}).
+   *
+   * @param link     ссылка целиком.
+   * @param fileType язык, на котором резолвятся имена.
+   * @return тип по ссылке; {@link TypeSet#EMPTY}, если такого пути в метаданных нет.
+   */
+  private TypeSet resolveMetadataPath(String link, FileType fileType) {
+    // Пустые части сохраняются (-1): «Справочник.Товары.ЕдиницыИзмерения.» — не ссылка
+    // на саму табличную часть, а ссылка на её реквизит с пустым именем.
+    var parts = link.split("\\.", -1);
+    if (parts.length < MIN_METADATA_SEGMENTS) {
+      return TypeSet.EMPTY;
+    }
+    var kind = parts[KIND_PART];
+    var mdName = parts[NAME_PART];
+    var childName = parts[CHILD_PART];
+
+    var section = typeRegistry.resolve(kind + TABULAR_SECTION + mdName + "." + childName, fileType);
+    if (section.isPresent()) {
+      if (parts.length == MIN_METADATA_SEGMENTS) {
+        return TypeSet.of(section.get());
+      }
+      // Реквизиты есть у строки табличной части, а не у неё самой.
+      return typeRegistry.resolve(kind + TABULAR_SECTION_ROW + mdName + "." + childName, fileType)
+        .map(rowRef -> walkMembers(rowRef, parts, ATTRIBUTE_PART, fileType))
+        .orElse(TypeSet.EMPTY);
+    }
+    return typeRegistry.resolve(kind + OBJECT + mdName, fileType)
+      .map(objectRef -> walkMembers(objectRef, parts, CHILD_PART, fileType))
+      .orElse(TypeSet.EMPTY);
+  }
+
+  /**
+   * Проход по цепочке членов: каждая следующая часть ссылки берётся как член типа,
+   * полученного на предыдущей.
+   * <p>
+   * Цепочка обрывается, если члена с таким именем нет либо предыдущая часть дала
+   * больше одного типа — продолжать неоднозначный путь не от чего.
+   *
+   * @param ref      тип, от которого идёт проход.
+   * @param parts    части ссылки.
+   * @param from     номер части, с которой начинается проход.
+   * @param fileType язык, на котором ищутся члены.
+   * @return типы последней части; {@link TypeSet#EMPTY}, если цепочка оборвалась.
+   */
+  private TypeSet walkMembers(TypeRef ref, String[] parts, int from, FileType fileType) {
+    var current = memberTypes(ref, parts[from], fileType);
+    for (var i = from + 1; i < parts.length && !current.isEmpty(); i++) {
+      var refs = current.refs();
+      if (refs.size() != 1) {
+        return TypeSet.EMPTY;
+      }
+      current = memberTypes(refs.iterator().next(), parts[i], fileType);
+    }
+    return current;
+  }
+
+  /**
+   * Типы члена по имени.
+   *
+   * @param ref      тип-владелец.
+   * @param name     имя члена.
+   * @param fileType язык, на котором ищется член.
+   * @return типы члена; {@link TypeSet#EMPTY}, если члена с таким именем нет.
+   */
+  private TypeSet memberTypes(TypeRef ref, String name, FileType fileType) {
+    return typeRegistry.findMember(ref, MemberKind.PROPERTY, name, fileType)
+      .map(MemberDescriptor::returnTypes)
+      .orElse(TypeSet.EMPTY);
+  }
+
   /**
    * Возвращаемый тип локальной функции, на которую указывает {@code см.}-ссылка.
    * <p>
@@ -452,7 +553,7 @@ private TypeSet resolveTypeDescription(TypeDescription td, ResolutionContext con
     return switch (td.variant()) {
       case HYPERLINK ->
         resolveSeeReference(td.name(), context.owner(), context.fileType(), context.visited());
-      case SIMPLE -> resolveSimple(td.name());
+      case SIMPLE -> resolveSimple(td, context);
       case COLLECTION -> resolveCollection((CollectionTypeDescription) td, context);
     };
   }
@@ -608,6 +709,46 @@ private Optional<TypeRef> resolveOne(String name) {
    * имя сперва спрашивается у реестра как набор; всё прочее — один тип, а незнакомое
    * имя остаётся пользовательским типом, как и было.
    */
+  /**
+   * Простой тип, возможно уточнённый ссылкой: {@code СтрокаТабличнойЧасти: См. Справочник.Товары.ЕдиницыИзмерения}.
+   * <p>
+   * Голова такой записи говорит, чем значение является, а ссылка указывает на коллекцию,
+   * элементом которой оно служит: строку табличной части, элемент коллекции формы. Поэтому
+   * у коллекции берётся её элемент — вместе с колонками, которые у него уже есть. Ссылка на
+   * тип, коллекцией не являющийся, отдаётся как есть.
+   *
+   * @param td      описание типа.
+   * @param context контекст разрешения.
+   * @return тип; {@link TypeSet#EMPTY}, если не разрешился ни ссылкой, ни именем.
+   */
+  private TypeSet resolveSimple(TypeDescription td, ResolutionContext context) {
+    var hyperlink = td.hyperlink();
+    if (hyperlink == null) {
+      return resolveSimple(td.name());
+    }
+    var linked = resolveSeeReference(hyperlink.link(), context.owner(), context.fileType(), context.visited());
+    if (linked.isEmpty()) {
+      return resolveSimple(td.name());
+    }
+    var element = elementOf(linked);
+    return element.isEmpty() ? linked : element;
+  }
+
+  /**
+   * Элемент коллекции: уточнённый по месту, а если его нет — тип элемента из реестра.
+   *
+   * @param types типы коллекции.
+   * @return типы элемента; {@link TypeSet#EMPTY}, если коллекции среди них нет.
+   */
+  private TypeSet elementOf(TypeSet types) {
+    var result = TypeSet.EMPTY;
+    for (var ref : types.refs()) {
+      var attached = types.getElementTypes(ref);
+      result = result.union(attached.isEmpty() ? typeRegistry.getDefaultElementTypes(ref) : attached);
+    }
+    return result;
+  }
+
   private TypeSet resolveSimple(String name) {
     if (name.isBlank()) {
       return TypeSet.EMPTY;

src/main/java/com/github/_1c_syntax/bsl/languageserver/types/inferencer/ExpressionTypeInferencer.java

@@ -1063,7 +1063,9 @@ private TypeSet declaredTypes(VariableSymbol variable) {
       // один путь до присваивания не дошёл.
       return TypeSet.of(UNDEFINED);
     }
-    return entry;
+    // Объявленному типу-коллекции нужен тип её элемента: «Для Каждого» по параметру,
+    // чей тип объявлен комментарием, иначе не знает, что за строку он перебирает.
+    return attachDefaultElementTypes(entry);
   }
 
   /**
@@ -1147,9 +1149,6 @@ private boolean assignedOnEveryPath(
   ) {
     var graph = controlFlowGraphIndex.graphOf(owner, body, CfgBuildOptions.defaults());
     var entry = graph.getEntryPoint();
-    if (entry == null) {
-      return false;
-    }
     if (assigns(entry, positions)) {
       return true;
     }

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

@@ -180,6 +180,31 @@ void testDeprecatedMethodWithoutInfo() {
     assertThat(content).doesNotContain("**Устарела.** ");
   }
 
+  @Test
+  void testTypeRefinedByHyperlinkShowsBothParts() {
+    // given: тип параметра уточнён ссылкой — автор написал обе половины записи.
+    var documentContext = TestUtils.getDocumentContext("""
+      // Возвращаемое значение:
+      //  Структура:
+      //   * Ссылка - Строка
+      Функция НовыйОбъектДанных() Экспорт
+      	Возврат Новый Структура;
+      КонецФункции
+
+      // Параметры:
+      //  Данные - Структура: См. НовыйОбъектДанных
+      Процедура СоСсылкойНаМетод(Данные) Экспорт
+      КонецПроцедуры
+      """);
+    var methodSymbol = documentContext.getSymbolTree().getMethodSymbol("СоСсылкойНаМетод").orElseThrow();
+
+    // when
+    var content = markupContentBuilder.getContent(referenceTo(documentContext, methodSymbol)).getValue();
+
+    // then: в подсказке видны и голова описания, и ссылка — как в исходной записи.
+    assertThat(content).contains("`Структура`: [НовыйОбъектДанных](НовыйОбъектДанных)");
+  }
+
   @Test
   void testNonDeprecatedMethodHasNoDeprecationBlock() {
     // given

src/test/java/com/github/_1c_syntax/bsl/languageserver/semantictokens/BslDocSemanticTokensSupplierTest.java

@@ -248,6 +248,29 @@ void testElementsInDescriptionStartingAtNonZeroColumn() {
     ));
   }
 
+  @Test
+  void testTypeRefinedByHyperlinkHighlightsBothParts() {
+    // given - тип, уточнённый ссылкой: подсвечиваются и голова описания, и сама ссылка,
+    // ровно как подсвечивается отдельно стоящая ссылка.
+    String bsl = """
+      // Параметры:
+      //  Объект - СтрокаТабличнойЧасти: См. Справочник.Справочник1.ТабличнаяЧасть1
+      Процедура Тест(Объект)
+      КонецПроцедуры
+      """;
+
+    // when
+    var decoded = helper.getDecodedTokens(bsl, supplier);
+
+    // then
+    helper.assertContainsTokens(decoded, List.of(
+      new ExpectedToken(1, 13, 20, SemanticTokenTypes.Type,
+        Set.of(SemanticTokenModifiers.Documentation), "СтрокаТабличнойЧасти"),
+      new ExpectedToken(1, 39, 38, SemanticTokenTypes.Type,
+        Set.of(SemanticTokenModifiers.Documentation), "Справочник.Справочник1.ТабличнаяЧасть1")
+    ));
+  }
+
   @Test
   void testTrailingVariableDescriptionTypeHighlighting() {
     // given - висячий (trailing) комментарий переменной с типом в начале (нотация «тип в начале»).