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

Go to download
/*
 * This file is a part of BSL Language Server.
 *
 * Copyright (c) 2018-2022
 * 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.diagnostics.metadata.DiagnosticMetadata;
import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticScope;
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.Trees;
import com.github._1c_syntax.bsl.parser.BSLParser;
import com.github._1c_syntax.utils.CaseInsensitivePattern;
import org.antlr.v4.runtime.tree.ParseTree;

import java.util.List;
import java.util.Locale;
import java.util.Objects;
import java.util.Optional;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

@DiagnosticMetadata(
  type = DiagnosticType.CODE_SMELL,
  severity = DiagnosticSeverity.MAJOR,
  scope = DiagnosticScope.OS,
  minutesToFix = 5,
  tags = {
    DiagnosticTag.DESIGN,
    DiagnosticTag.UNUSED
  }
)
public class UnusedParametersDiagnostic extends AbstractVisitorDiagnostic {

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

  @Override
  public ParseTree visitSubCodeBlock(BSLParser.SubCodeBlockContext ctx) {

    if (ctx.codeBlock().getChildCount() == 0
      || itsHandler(ctx)) {
      return ctx;
    }

    List paramsNames = Trees.findAllRuleNodes(ctx.getParent(), BSLParser.RULE_param)
      .stream()
      .map(node -> ((BSLParser.ParamContext) node).IDENTIFIER().getText().toLowerCase(Locale.getDefault()))
      .collect(Collectors.toList());

    Trees.findAllTokenNodes(ctx, BSLParser.IDENTIFIER)
      .stream()
      .filter(Objects::nonNull)
      .forEach(node ->
        paramsNames.remove((node.getText().toLowerCase(Locale.getDefault())))
      );

    Trees.findAllRuleNodes(ctx.getParent(), BSLParser.RULE_param)
      .stream()
      .map(param -> ((BSLParser.ParamContext) param).IDENTIFIER())
      .filter(param -> paramsNames.contains(param.getText().toLowerCase(Locale.getDefault())))
      .forEach(param ->
        diagnosticStorage.addDiagnostic(param, info.getMessage(param.getText()))
      );

    return ctx;
  }

  private static boolean itsHandler(BSLParser.SubCodeBlockContext ctx) {

    Optional subNames = Trees.findAllRuleNodes(ctx.getParent(), BSLParser.RULE_subName).stream().findFirst();

    String subName = "";
    if (subNames.isPresent()) {
      subName = subNames.get().getText();
    }

    return HANDLER_PATTERN.matcher(subName).matches();
  }

}