fix(diagnostics): не считать счетчик цикла неиспользуемым

src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/UnusedLocalVariableDiagnostic.java

@@ -21,19 +21,34 @@
  */
 package com.github._1c_syntax.bsl.languageserver.diagnostics;
 
+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.bsl.languageserver.diagnostics.metadata.DiagnosticMetadata;
 import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticSeverity;
 import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticTag;
 import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticType;
 import com.github._1c_syntax.bsl.languageserver.references.ReferenceIndex;
 import com.github._1c_syntax.bsl.languageserver.references.model.OccurrenceType;
+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 com.github._1c_syntax.bsl.types.ModuleType;
 import lombok.RequiredArgsConstructor;
+import org.eclipse.lsp4j.Range;
 
+import java.util.Collection;
 import java.util.EnumSet;
+import java.util.Objects;
 import java.util.Set;
+import java.util.stream.Collectors;
 
+/**
+ * Диагностика неиспользуемых локальных и модульных переменных.
+ * 
+ * Срабатывает, если переменная объявлена, но к ней нет обращений по ссылке.
+ * Счётчик цикла {@code Для} не считается неиспользуемым, даже если он не
+ * упоминается в теле цикла.
+ */
 @DiagnosticMetadata(
   type = DiagnosticType.CODE_SMELL,
   severity = DiagnosticSeverity.MAJOR,
@@ -61,16 +76,49 @@ public class UnusedLocalVariableDiagnostic extends AbstractDiagnostic {
     VariableKind.DYNAMIC
   );
 
+  /**
+   * Ищет объявленные, но неиспользуемые переменные модуля и метода.
+   */
   @Override
   public void check() {
+    Set<Range> forLoopCounterRanges = getForLoopCounterRanges();
     documentContext.getSymbolTree().getVariables().stream()
       .filter(variable -> CHECKING_VARIABLE_KINDS.contains(variable.getKind()))
       .filter(variable -> !variable.isExport())
+      .filter(variable -> !isForLoopCounter(variable, forLoopCounterRanges))
       .filter(variable -> referenceIndex.getReferencesTo(variable).stream()
         .filter(ref -> ref.occurrenceType() == OccurrenceType.REFERENCE).findFirst().isEmpty()
       )
       .forEach(variable -> diagnosticStorage.addDiagnostic(
         variable.getSelectionRange(), info.getMessage(variable.getName()))
       );
   }
+
+  /**
+   * Возвращает диапазоны имён переменных-счётчиков в конструкциях {@code Для ... По ... Цикл}.
+   *
+   * @return множество диапазонов идентификаторов счётчиков цикла в текущем модуле
+   */
+  private Set<Range> getForLoopCounterRanges() {
+    return Trees.findAllRuleNodes(documentContext.getAst(), BSLParser.RULE_forStatement).stream()
+      .map(BSLParser.ForStatementContext.class::cast)
+      .map(BSLParser.ForStatementContext::IDENTIFIER)
+      .filter(Objects::nonNull)
+      .map(Ranges::create)
+      .collect(Collectors.toSet());
+  }
+
+  /**
+   * Проверяет, что переменная объявлена как счётчик цикла {@code Для}.
+   *
+   * @param variable               проверяемая переменная
+   * @param forLoopCounterRanges   диапазоны имён счётчиков цикла
+   * @return {@code true}, если переменная определена в заголовке цикла {@code Для}
+   */
+  private boolean isForLoopCounter(VariableSymbol variable,
+                                   Collection<Range> forLoopCounterRanges) {
+    return referenceIndex.getReferencesTo(variable).stream()
+      .filter(ref -> ref.occurrenceType() == OccurrenceType.DEFINITION)
+      .anyMatch(ref -> forLoopCounterRanges.contains(ref.selectionRange()));
+  }
 }

src/test/resources/diagnostics/UnusedLocalVariableDiagnostic.bsl

@@ -99,3 +99,11 @@
 
 Сообщить(Комментарий);
 
+Процедура ТестСчетчикаЦикла(КоличествоПопыток)
+
+    Для НомерПопытки = 1 По КоличествоПопыток Цикл
+        ВыполнитьДействие();
+    КонецЦикла;
+
+КонецПроцедуры
+