Merge pull request #3690 from 1c-syntax/copilot/add-syntax-highlighting-docs

Add BSL doc syntax highlighting for method/variable descriptions

Author: nixel2007

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

@@ -0,0 +1,87 @@
+/*
+ * 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.semantictokens;
+
+import com.github._1c_syntax.bsl.languageserver.context.DocumentContext;
+import com.github._1c_syntax.bsl.languageserver.utils.Ranges;
+import com.github._1c_syntax.bsl.languageserver.utils.Trees;
+import com.github._1c_syntax.bsl.parser.BSLParser;
+import lombok.RequiredArgsConstructor;
+import org.antlr.v4.runtime.ParserRuleContext;
+import org.antlr.v4.runtime.tree.TerminalNode;
+import org.eclipse.lsp4j.SemanticTokenTypes;
+import org.jspecify.annotations.Nullable;
+import org.springframework.stereotype.Component;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Сапплаер семантических токенов для аннотаций и директив компиляции.
+ */
+@Component
+@RequiredArgsConstructor
+public class AnnotationSemanticTokensSupplier implements SemanticTokensSupplier {
+
+  private final SemanticTokensHelper helper;
+
+  @Override
+  public List<SemanticTokenEntry> getSemanticTokens(DocumentContext documentContext) {
+    List<SemanticTokenEntry> entries = new ArrayList<>();
+    var ast = documentContext.getAst();
+
+    // Compiler directives: single Decorator from '&' through directive symbol
+    for (var compilerDirective : Trees.<BSLParser.CompilerDirectiveContext>findAllRuleNodes(ast, BSLParser.RULE_compilerDirective)) {
+      addAmpersandRange(entries, compilerDirective.AMPERSAND(), compilerDirective.compilerDirectiveSymbol());
+    }
+
+    // Annotations: single Decorator from '&' through annotation name; params identifiers as Parameter
+    for (var annotation : Trees.<BSLParser.AnnotationContext>findAllRuleNodes(ast, BSLParser.RULE_annotation)) {
+      addAmpersandRange(entries, annotation.AMPERSAND(), annotation.annotationName());
+
+      var annotationParams = annotation.annotationParams();
+      if (annotationParams == null) {
+        continue;
+      }
+
+      for (var annotationParam : annotationParams.annotationParam()) {
+        var annotationParamName = annotationParam.annotationParamName();
+        if (annotationParamName != null) {
+          helper.addRange(entries, Ranges.create(annotationParamName.IDENTIFIER()), SemanticTokenTypes.Parameter);
+        }
+      }
+    }
+
+    return entries;
+  }
+
+  private void addAmpersandRange(List<SemanticTokenEntry> entries, TerminalNode node, @Nullable ParserRuleContext name) {
+    var ampersand = node.getSymbol(); // '&'
+    if (name != null) {
+      var symbolToken = name.getStart();
+      helper.addRange(entries, Ranges.create(ampersand, symbolToken), SemanticTokenTypes.Decorator);
+    } else {
+      helper.addRange(entries, Ranges.create(ampersand), SemanticTokenTypes.Decorator);
+    }
+  }
+}
+