com.github._1c_syntax.bsl.languageserver.diagnostics.UnusedLocalMethodDiagnostic Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bsl-language-server Show documentation
Language Server Protocol implementation for 1C (BSL) - 1C:Enterprise 8 and OneScript languages.
The newest version!
/*
 * This file is a part of BSL Language Server.
 *
 * Copyright (c) 2018-2024
 * Alexey Sosnoviy , Nikita Fedkin  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.diagnostics;

import com.github._1c_syntax.bsl.languageserver.context.symbol.MethodSymbol;
import com.github._1c_syntax.bsl.languageserver.context.symbol.annotations.Annotation;
import com.github._1c_syntax.bsl.languageserver.context.symbol.annotations.AnnotationKind;
import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticMetadata;
import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticParameter;
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.utils.DiagnosticHelper;
import com.github._1c_syntax.bsl.parser.BSLParser;
import com.github._1c_syntax.bsl.types.ModuleType;
import com.github._1c_syntax.utils.CaseInsensitivePattern;
import org.antlr.v4.runtime.tree.ParseTree;
import org.antlr.v4.runtime.tree.Trees;

import java.util.EnumSet;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;

@DiagnosticMetadata(
  type = DiagnosticType.CODE_SMELL,
  severity = DiagnosticSeverity.MAJOR,
  modules = {
    ModuleType.CommonModule,
    ModuleType.ObjectModule
  },
  minutesToFix = 1,
  tags = {
    DiagnosticTag.STANDARD,
    DiagnosticTag.SUSPICIOUS,
    DiagnosticTag.UNUSED
  }
)
public class UnusedLocalMethodDiagnostic extends AbstractVisitorDiagnostic {

  private static final Pattern HANDLER_PATTERN = CaseInsensitivePattern.compile(
    "(ПриСозданииОбъекта|OnObjectCreate)"
  );

  /**
   * Префиксы подключаемых методов
   */
  private static final String ATTACHABLE_METHOD_PREFIXES = "подключаемый_,attachable_";

  private static final Set EXTENSION_ANNOTATIONS = EnumSet.of(
    AnnotationKind.AFTER,
    AnnotationKind.AROUND,
    AnnotationKind.BEFORE,
    AnnotationKind.CHANGEANDVALIDATE
  );
  private static final boolean CHECK_OBJECT_MODULE = false;

  @DiagnosticParameter(
    type = String.class,
    defaultValue = ATTACHABLE_METHOD_PREFIXES
  )
  private Pattern attachableMethodPrefixes = DiagnosticHelper.createPatternFromString(ATTACHABLE_METHOD_PREFIXES);

  @DiagnosticParameter(
    type = Boolean.class,
    defaultValue = "" + CHECK_OBJECT_MODULE
  )
  private boolean checkObjectModule = CHECK_OBJECT_MODULE;

  @Override
  public void configure(Map configuration) {
    this.attachableMethodPrefixes = DiagnosticHelper.createPatternFromString(
      (String) configuration.getOrDefault("attachableMethodPrefixes", ATTACHABLE_METHOD_PREFIXES));

    this.checkObjectModule = (boolean) configuration.getOrDefault("checkObjectModule", CHECK_OBJECT_MODULE);
  }

  private boolean isAttachable(MethodSymbol methodSymbol) {
    return attachableMethodPrefixes.matcher(methodSymbol.getName()).matches();
  }

  private static boolean isHandler(MethodSymbol methodSymbol) {
    return HANDLER_PATTERN.matcher(methodSymbol.getName()).matches();
  }

  private static boolean isOverride(MethodSymbol method) {
    return method.getAnnotations()
      .stream()
      .map(Annotation::getKind)
      .anyMatch(EXTENSION_ANNOTATIONS::contains);
  }

  @Override
  public ParseTree visitFile(BSLParser.FileContext ctx) {
    var moduleType = documentContext.getModuleType();
    if (!checkObjectModule && moduleType == ModuleType.ObjectModule) {
      return ctx;
    }

    var collect = Trees.findAllRuleNodes(ctx, BSLParser.RULE_globalMethodCall)
      .stream()
      .map(parseTree ->
        ((BSLParser.GlobalMethodCallContext) parseTree).methodName().getText().toLowerCase(Locale.ENGLISH))
      .toList();

    documentContext.getSymbolTree().getMethods()
      .stream()
      .filter(method -> !method.isExport())
      .filter(method -> !isOverride(method))
      .filter(method -> !isAttachable(method))
      .filter(method -> !isHandler(method))
      .filter(method -> !collect.contains(method.getName().toLowerCase(Locale.ENGLISH)))
      .forEach(method -> diagnosticStorage.addDiagnostic(method.getSubNameRange(), info.getMessage(method.getName())));

    return ctx;
  }
}