au.com.integradev.delphi.checks.BeginEndRequiredCheck 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 org.sonar.check.Rule;
import org.sonar.plugins.communitydelphi.api.ast.CaseItemStatementNode;
import org.sonar.plugins.communitydelphi.api.ast.CaseStatementNode;
import org.sonar.plugins.communitydelphi.api.ast.CompoundStatementNode;
import org.sonar.plugins.communitydelphi.api.ast.ElseBlockNode;
import org.sonar.plugins.communitydelphi.api.ast.IfStatementNode;
import org.sonar.plugins.communitydelphi.api.ast.Node;
import org.sonar.plugins.communitydelphi.api.ast.RoutineBodyNode;
import org.sonar.plugins.communitydelphi.api.ast.StatementListNode;
import org.sonar.plugins.communitydelphi.api.ast.StatementNode;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheck;
import org.sonar.plugins.communitydelphi.api.check.DelphiCheckContext;
import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;

@DeprecatedRuleKey(ruleKey = "BeginEndRequiredRule", repositoryKey = "delph")
@Rule(key = "BeginEndRequired")
public class BeginEndRequiredCheck extends DelphiCheck {
  private static final String MESSAGE = "Wrap this statement with 'begin'..'end'";

  @Override
  public DelphiCheckContext visit(StatementNode statement, DelphiCheckContext context) {
    if (isMissingBeginEnd(statement)) {
      reportIssue(context, statement, MESSAGE);
    }
    return super.visit(statement, context);
  }

  @Override
  public DelphiCheckContext visit(ElseBlockNode elseBlock, DelphiCheckContext context) {
    if (!(elseBlock.getParent() instanceof CaseStatementNode)) {
      StatementListNode statementList = elseBlock.getStatementList();
      if (statementList.isEmpty()
          || statementList.getStatements().size() > 1
          || !(statementList.getStatements().get(0) instanceof CompoundStatementNode)) {
        reportIssue(context, elseBlock, MESSAGE);
      }
    }
    return super.visit(elseBlock, context);
  }

  private static boolean isMissingBeginEnd(StatementNode statement) {
    if (statement.getParent() instanceof RoutineBodyNode) {
      return false;
    }

    if (statement instanceof CompoundStatementNode || statement instanceof CaseItemStatementNode) {
      return false;
    }

    Node parent = statement.getParent();

    if (parent instanceof CaseItemStatementNode) {
      return false;
    }

    if (statement instanceof IfStatementNode && parent instanceof IfStatementNode) {
      return ((IfStatementNode) parent).getElseStatement() != statement;
    }

    return !(parent instanceof StatementListNode);
  }
}