au.com.integradev.delphi.checks.MathFunctionSingleOverloadCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of delphi-checks Show documentation
The newest version!
/*
 * Sonar Delphi Plugin
 * Copyright (C) 2019 Integrated Application Development
 *
 * This program 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 of the License, or (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package au.com.integradev.delphi.checks;

import java.util.Set;
import org.sonar.check.Rule;
import org.sonar.plugins.communitydelphi.api.ast.NameReferenceNode;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheck;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheckContext;
import org.sonar.plugins.communitydelphi.api.symbol.declaration.NameDeclaration;
import org.sonar.plugins.communitydelphi.api.symbol.declaration.RoutineNameDeclaration;
import org.sonar.plugins.communitydelphi.api.type.IntrinsicType;
import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;

@DeprecatedRuleKey(ruleKey = "MathFunctionSingleOverloadRule", repositoryKey = "delph")
@Rule(key = "MathFunctionSingleOverload")
public class MathFunctionSingleOverloadCheck extends DelphiCheck {
  private static final String MESSAGE = "Use a different overload of this standard math function.";

  private static final Set MATH_FUNCTIONS =
      Set.of(
          "System.Math.ArcCos",
          "System.Math.ArcSin",
          "System.Math.ArcTan2",
          "System.Math.SinCos",
          "System.Math.Tan",
          "System.Math.Cotan",
          "System.Math.Secant",
          "System.Math.Cosecant",
          "System.Math.Hypot",
          "System.Math.RadToDeg",
          "System.Math.RadToGrad",
          "System.Math.RadToCycle",
          "System.Math.DegToRad",
          "System.Math.DegToGrad",
          "System.Math.DegToCycle",
          "System.Math.DegNormalize",
          "System.Math.GradToRad",
          "System.Math.GradToDeg",
          "System.Math.GradToCycle",
          "System.Math.CycleToRad",
          "System.Math.CycleToDeg",
          "System.Math.CycleToGrad",
          "System.Math.Cot",
          "System.Math.Sec",
          "System.Math.Csc",
          "System.Math.Cosh",
          "System.Math.Sinh",
          "System.Math.Tanh",
          "System.Math.CotH",
          "System.Math.SecH",
          "System.Math.CscH",
          "System.Math.ArcCot",
          "System.Math.ArcSec",
          "System.Math.ArcCsc",
          "System.Math.ArcCosh",
          "System.Math.ArcSinh",
          "System.Math.ArcTanh",
          "System.Math.ArcCotH",
          "System.Math.ArcSecH",
          "System.Math.ArcCscH",
          "System.Math.LnXP1",
          "System.Math.Log10",
          "System.Math.Log2",
          "System.Math.LogN",
          "System.Math.IntPower",
          "System.Math.Power",
          "System.Math.Frexp",
          "System.Math.Ldexp",
          "System.Math.Poly",
          "System.Math.FMod",
          "System.Math.SimpleRoundTo");

  @Override
  public DelphiCheckContext visit(NameReferenceNode reference, DelphiCheckContext context) {
    NameDeclaration declaration = reference.getNameDeclaration();
    if (declaration instanceof RoutineNameDeclaration
        && isMathFunctionSingleOverload((RoutineNameDeclaration) declaration)) {
      reportIssue(context, reference.getIdentifier(), MESSAGE);
    }
    return super.visit(reference, context);
  }

  private static boolean isMathFunctionSingleOverload(RoutineNameDeclaration routine) {
    return MATH_FUNCTIONS.contains(routine.fullyQualifiedName())
        && routine.getParameters().stream()
            .anyMatch(parameter -> parameter.getType().is(IntrinsicType.SINGLE));
  }
}