au.com.integradev.delphi.checks.RedundantBooleanCheck 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
There is a newer version: 1.12.1
/*
 * 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 org.sonar.check.Rule;
import org.sonar.plugins.communitydelphi.api.ast.BinaryExpressionNode;
import org.sonar.plugins.communitydelphi.api.ast.Node;
import org.sonar.plugins.communitydelphi.api.ast.PrimaryExpressionNode;
import org.sonar.plugins.communitydelphi.api.ast.UnaryExpressionNode;
import org.sonar.plugins.communitydelphi.api.ast.utils.ExpressionNodeUtils;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheck;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheckContext;
import org.sonar.plugins.communitydelphi.api.operator.BinaryOperator;
import org.sonar.plugins.communitydelphi.api.operator.UnaryOperator;
import org.sonar.plugins.communitydelphi.api.type.Type;
import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;

@DeprecatedRuleKey(ruleKey = "RedundantBooleanRule", repositoryKey = "delph")
@Rule(key = "RedundantBoolean")
public class RedundantBooleanCheck extends DelphiCheck {
  private static final String MESSAGE = "Remove this redundant boolean literal.";

  @Override
  public DelphiCheckContext visit(PrimaryExpressionNode bool, DelphiCheckContext data) {
    if (ExpressionNodeUtils.isBooleanLiteral(bool)
        && (isRedundantComparison(bool) || isNeedlesslyInverted(bool))) {
      reportIssue(data, bool, MESSAGE);
    }

    return super.visit(bool, data);
  }

  private static boolean isRedundantComparison(PrimaryExpressionNode bool) {
    Node parent = bool.findParentheses().getParent();

    if (parent instanceof BinaryExpressionNode) {
      BinaryExpressionNode expression = (BinaryExpressionNode) parent;

      Type leftType = expression.getLeft().getType();
      Type rightType = expression.getRight().getType();
      BinaryOperator operator = expression.getOperator();

      return leftType.isBoolean()
          && rightType.isBoolean()
          && (operator == BinaryOperator.EQUAL || operator == BinaryOperator.NOT_EQUAL);
    }

    return false;
  }

  private static boolean isNeedlesslyInverted(PrimaryExpressionNode bool) {
    Node parent = bool.findParentheses().getParent();
    return parent instanceof UnaryExpressionNode
        && ((UnaryExpressionNode) parent).getOperator() == UnaryOperator.NOT;
  }
}