Merge pull request #3710 from 1c-syntax/feature/optimize-location-range

Refactor Location and Reference classes to use record type and improve range handling methods

Author: nixel2007

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

@@ -53,13 +53,13 @@ public void check() {
     var uri = documentContext.getUri();
 
     referenceIndex.getReferencesFrom(uri, SymbolKind.Method).stream()
-      .filter(reference -> reference.getSymbol().isDeprecated())
-      .filter(reference -> !reference.getFrom().isDeprecated())
+      .filter(reference -> reference.symbol().isDeprecated())
+      .filter(reference -> !reference.from().isDeprecated())
       .forEach((Reference reference) -> {
-        var deprecatedSymbol = reference.getSymbol();
+        var deprecatedSymbol = reference.symbol();
         var deprecationInfo = getDeprecationInfo(deprecatedSymbol);
         var message = info.getMessage(deprecatedSymbol.getName(), deprecationInfo);
-        diagnosticStorage.addDiagnostic(reference.getSelectionRange(), message);
+        diagnosticStorage.addDiagnostic(reference.selectionRange(), message);
       });
   }
 

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

@@ -59,9 +59,9 @@ public class MissedRequiredParameterDiagnostic extends AbstractVisitorDiagnostic
   public ParseTree visitFile(BSLParser.FileContext ctx) {
     super.visitFile(ctx);
     for (var reference : referenceIndex.getReferencesFrom(documentContext.getUri(), SymbolKind.Method)) {
-      var call = calls.get(reference.getSelectionRange());
+      var call = calls.get(reference.selectionRange());
       if (call != null) {
-        checkMethod((MethodSymbol) reference.getSymbol(), call);
+        checkMethod((MethodSymbol) reference.symbol(), call);
       }
     }
     return ctx;

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

@@ -85,13 +85,14 @@ private Optional<CallData> getReferenceToMethodCall(SymbolOccurrence symbolOccur
     // т.к. через refIndex.getReferences нельзя получить приватные методы, приходится обходить символы модуля
     final var methodSymbol = document.get()
       .getSymbolTree().getMethodSymbol(symbol.symbolName());
+    final var location = symbolOccurrence.location();
+    final var locationRange = location.getRange();
     if (methodSymbol.isEmpty()) {
-      final var location = symbolOccurrence.location();
       // Нельзя использовать symbol.getSymbolName(), т.к. имя в нижнем регистре
       return Optional.of(
         new CallData(mdObject.get().getName(),
-          getMethodNameByLocation(documentContext.getAst(), location.getRange()),
-          location.getRange(), false, false));
+          getMethodNameByLocation(documentContext.getAst(), locationRange),
+          locationRange, false, false));
     }
     // вызовы приватных методов внутри самого модуля пропускаем
     if (document.get().getUri().equals(documentContext.getUri())) {
@@ -101,7 +102,7 @@ private Optional<CallData> getReferenceToMethodCall(SymbolOccurrence symbolOccur
       .filter(methodSymbol2 -> !methodSymbol2.isExport())
       .map(methodSymbol1 -> new CallData(mdObject.get().getName(),
         methodSymbol1.getName(),
-        symbolOccurrence.location().getRange(), true, true));
+        locationRange, true, true));
   }
 
   private void fireIssue(CallData callData) {

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

@@ -90,7 +90,7 @@ private Optional<ModuleSymbol> getPrivilegedModuleSymbol(CommonModule mdCommonMo
   }
 
   private boolean isReferenceToModules(Reference reference) {
-    if (!validateNestedCalls && reference.getUri().equals(documentContext.getUri())) {
+    if (!validateNestedCalls && reference.uri().equals(documentContext.getUri())) {
       return false;
     }
     return reference.getSourceDefinedSymbol()
@@ -102,7 +102,7 @@ private boolean isReferenceToModules(Reference reference) {
   }
 
   private void fireIssue(Reference reference) {
-    diagnosticStorage.addDiagnostic(reference.getSelectionRange(),
-      info.getMessage(reference.getSymbol().getName()));
+    diagnosticStorage.addDiagnostic(reference.selectionRange(),
+      info.getMessage(reference.symbol().getName()));
   }
 }

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

@@ -104,7 +104,7 @@ private Optional<Triple<VariableSymbol, Reference, List<Reference>>> isOverwrite
   private List<Reference> getSortedReferencesByLocation(VariableSymbol variable) {
     final var references = referenceIndex.getReferencesTo(variable);
     return references.stream()
-      .sorted((o1, o2) -> compare(o1.getSelectionRange(), o2.getSelectionRange()))
+      .sorted((o1, o2) -> compare(o1.selectionRange(), o2.selectionRange()))
       .collect(Collectors.toList());
   }
 
@@ -127,7 +127,7 @@ public static int compare(Position pos1, Position pos2) {
   }
 
   private Optional<Reference> isOverwrited(List<Reference> references) {
-    if (references.isEmpty() || references.get(0).getOccurrenceType() != OccurrenceType.DEFINITION) {
+    if (references.isEmpty() || references.get(0).occurrenceType() != OccurrenceType.DEFINITION) {
       return Optional.empty();
     }
 
@@ -147,7 +147,7 @@ private Optional<Reference> isOverwrited(List<Reference> references) {
 
   private Optional<RuleNode> getRefContextInsideDefAssign(Reference defRef, Reference nextRef) {
     final var defNode = Trees.findTerminalNodeContainsPosition(documentContext.getAst(),
-      defRef.getSelectionRange().getStart());
+      defRef.selectionRange().getStart());
     final var assignment = defNode
       .map(TerminalNode::getParent)
       .filter(BSLParser.LValueContext.class::isInstance)
@@ -156,7 +156,7 @@ private Optional<RuleNode> getRefContextInsideDefAssign(Reference defRef, Refere
       .map(BSLParser.AssignmentContext.class::cast);
 
     return assignment.flatMap(assignContext ->
-        Trees.findTerminalNodeContainsPosition(assignContext, nextRef.getSelectionRange().getStart()))
+        Trees.findTerminalNodeContainsPosition(assignContext, nextRef.selectionRange().getStart()))
       .map(TerminalNode::getParent);
   }
 
@@ -177,7 +177,7 @@ private void fireIssue(VariableSymbol variable, Reference nodeForIssue, List<Ref
     var refsForIssue = references.stream()
       .map(reference -> RelatedInformation.create(
         documentContext.getUri(),
-        reference.getSelectionRange(),
+        reference.selectionRange(),
         "+1"
       )).toList();
     var resultRefs = new ArrayList<DiagnosticRelatedInformation>();
@@ -187,6 +187,6 @@ private void fireIssue(VariableSymbol variable, Reference nodeForIssue, List<Ref
       "0"));
     resultRefs.addAll(refsForIssue);
 
-    diagnosticStorage.addDiagnostic(nodeForIssue.getSelectionRange(), info.getMessage(variable.getName()), resultRefs);
+    diagnosticStorage.addDiagnostic(nodeForIssue.selectionRange(), info.getMessage(variable.getName()), resultRefs);
   }
 }

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

@@ -181,7 +181,7 @@ private static boolean hasClientCompilerDirective(BSLParser.ModuleVarContext ctx
   private boolean isAssignedParam(MethodSymbol method, ParameterDefinition parameterDefinition) {
     return getVariableByParameter(method, parameterDefinition)
       .noneMatch(variableSymbol -> referenceIndex.getReferencesTo(variableSymbol).stream()
-        .anyMatch(ref -> ref.getOccurrenceType() == OccurrenceType.DEFINITION));
+        .anyMatch(ref -> ref.occurrenceType() == OccurrenceType.DEFINITION));
   }
 
   private static Stream<VariableSymbol> getVariableByParameter(MethodSymbol method,
@@ -198,13 +198,13 @@ private static Stream<VariableSymbol> getVariableByParameter(MethodSymbol method
   private List<Reference> getRefsFromClientCalls(MethodSymbol method) {
     return referenceIndex.getReferencesTo(method).stream()
       // в будущем могут появиться и другие виды ссылок
-      .filter(ref -> ref.getOccurrenceType() == OccurrenceType.REFERENCE)
+      .filter(ref -> ref.occurrenceType() == OccurrenceType.REFERENCE)
       .filter(TransferringParametersBetweenClientAndServerDiagnostic::isClientCall)
       .toList();
   }
 
   private static boolean isClientCall(Reference ref) {
-    return Optional.of(ref.getFrom())
+    return Optional.of(ref.from())
       .filter(MethodSymbol.class::isInstance)
       .map(MethodSymbol.class::cast)
       .filter(TransferringParametersBetweenClientAndServerDiagnostic::isEqualCompilerDirective)
@@ -231,7 +231,7 @@ private static List<ParameterDefinition> getMethodParamsByRef(MethodSymbol metho
 
   private static List<DiagnosticRelatedInformation> getRelatedInformation(List<Reference> references) {
     return references.stream()
-      .map(reference -> RelatedInformation.create(reference.getUri(), reference.getSelectionRange(), "+1"))
+      .map(reference -> RelatedInformation.create(reference.uri(), reference.selectionRange(), "+1"))
       .collect(Collectors.toList());
   }
 

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

@@ -67,7 +67,7 @@ public void check() {
       .filter(variable -> CHECKING_VARIABLE_KINDS.contains(variable.getKind()))
       .filter(variable -> !variable.isExport())
       .filter(variable -> referenceIndex.getReferencesTo(variable).stream()
-        .filter(ref -> ref.getOccurrenceType() == OccurrenceType.REFERENCE).findFirst().isEmpty()
+        .filter(ref -> ref.occurrenceType() == OccurrenceType.REFERENCE).findFirst().isEmpty()
       )
       .forEach(variable -> diagnosticStorage.addDiagnostic(
         variable.getSelectionRange(), info.getMessage(variable.getName()))

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

@@ -69,7 +69,7 @@ public class SourceDefinedMethodCallInlayHintSupplier implements InlayHintSuppli
   public List<InlayHint> getInlayHints(DocumentContext documentContext, InlayHintParams params) {
     var range = params.getRange();
     return referenceIndex.getReferencesFrom(documentContext.getUri(), SymbolKind.Method).stream()
-      .filter(reference -> Ranges.containsPosition(range, reference.getSelectionRange().getStart()))
+      .filter(reference -> Ranges.containsPosition(range, reference.selectionRange().getStart()))
       .filter(Reference::isSourceDefinedSymbolReference)
       .map(this::toInlayHints)
       .flatMap(Collection::stream)
@@ -78,10 +78,10 @@ public List<InlayHint> getInlayHints(DocumentContext documentContext, InlayHintP
 
   private List<InlayHint> toInlayHints(Reference reference) {
 
-    var methodSymbol = (MethodSymbol) reference.getSymbol();
+    var methodSymbol = (MethodSymbol) reference.symbol();
     var parameters = methodSymbol.getParameters();
 
-    var ast = reference.getFrom().getOwner().getAst();
+    var ast = reference.from().getOwner().getAst();
     var doCalls = Trees.findAllRuleNodes(ast, BSLParser.RULE_doCall);
 
     return doCalls.stream()
@@ -185,7 +185,7 @@ private boolean showDefaultValues() {
 
 
   private static boolean isRightMethod(ParserRuleContext doCallParent, Reference reference) {
-    var selectionRange = reference.getSelectionRange();
+    var selectionRange = reference.selectionRange();
 
     if (doCallParent instanceof BSLParser.MethodCallContext methodCallContext) {
       return selectionRange.equals(Ranges.create(methodCallContext.methodName()));

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

@@ -111,8 +111,8 @@ public List<CallHierarchyIncomingCall> incomingCalls(
       .map(referenceIndex::getReferencesTo)
       .flatMap(Collection::stream)
       .collect(groupingBy(
-        Reference::getFrom,
-        mapping(Reference::getSelectionRange, toCollection(ArrayList::new)))
+        Reference::from,
+        mapping(Reference::selectionRange, toCollection(ArrayList::new)))
       )
       .entrySet()
       .stream()
@@ -141,10 +141,10 @@ public List<CallHierarchyOutgoingCall> outgoingCalls(
       .map(referenceIndex::getReferencesFrom)
       .flatMap(Collection::stream)
       .filter(Reference::isSourceDefinedSymbolReference)
-      .filter(reference -> isSymbolSupported(reference.getSymbol()))
+      .filter(reference -> isSymbolSupported(reference.symbol()))
       .collect(groupingBy(
         reference -> reference.getSourceDefinedSymbol().orElseThrow(),
-        mapping(Reference::getSelectionRange, toCollection(ArrayList::new)))
+        mapping(Reference::selectionRange, toCollection(ArrayList::new)))
       )
       .entrySet()
       .stream()

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

@@ -65,13 +65,13 @@ public List<LocationLink> getDefinition(DocumentContext documentContext, Definit
   }
 
   private static LocationLink toLocationLink(Reference reference) {
-    SourceDefinedSymbol symbol = (SourceDefinedSymbol) reference.getSymbol();
+    SourceDefinedSymbol symbol = (SourceDefinedSymbol) reference.symbol();
 
     return new LocationLink(
       symbol.getOwner().getUri().toString(),
       symbol.getRange(),
       symbol.getSelectionRange(),
-      reference.getSelectionRange()
+      reference.selectionRange()
     );
   }
 }