org.sonar.pickbasic.checks.NonEmptyCaseWithoutBreakCheck.java Source code

Introduction

Here is the source code for org.sonar.pickbasic.checks.NonEmptyCaseWithoutBreakCheck.java

Source

/*
 * SonarQube PickBasic Plugin
 * Copyright (C) 2014-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * 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  02110-1301, USA.
 */
package org.sonar.pickbasic.checks;

import com.google.common.collect.Iterables;
import java.util.List;
import org.sonar.api.server.rule.RulesDefinition;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.plugins.pickbasic.api.tree.Tree.Kind;
import org.sonar.plugins.pickbasic.api.tree.statement.BlockTree;
import org.sonar.plugins.pickbasic.api.tree.statement.StatementTree;
import org.sonar.plugins.pickbasic.api.tree.statement.SwitchClauseTree;
import org.sonar.plugins.pickbasic.api.tree.statement.SwitchStatementTree;
import org.sonar.plugins.pickbasic.api.visitors.BaseTreeVisitor;
import org.sonar.squidbridge.annotations.ActivatedByDefault;
import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
import org.sonar.squidbridge.annotations.SqaleSubCharacteristic;

@Rule(key = "NonEmptyCaseWithoutBreak", name = "Switch cases should end with an unconditional \"break\" statement", priority = Priority.CRITICAL, tags = {
        Tags.CERT, Tags.CWE, Tags.MISRA, Tags.PITFALL })
@ActivatedByDefault
@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.LOGIC_RELIABILITY)
@SqaleConstantRemediation("10min")
public class NonEmptyCaseWithoutBreakCheck extends BaseTreeVisitor {

    private static final String MESSAGE = "End this switch case with an unconditional break, continue, return or throw statement.";

    @Override
    public void visitSwitchStatement(SwitchStatementTree tree) {
        List<SwitchClauseTree> cases = tree.cases();
        for (int i = 0; i < cases.size() - 1; i++) {
            SwitchClauseTree switchClauseTree = cases.get(i);
            List<StatementTree> statements = switchClauseTree.statements();
            if (!statements.isEmpty() && !endsWithJump(statements)) {
                getContext().addIssue(this, switchClauseTree, MESSAGE);
            }
        }

        super.visitSwitchStatement(tree);
    }

    private boolean endsWithJump(List<StatementTree> statements) {
        if (statements.isEmpty()) {
            return false;
        }
        if (statements.size() == 1 && statements.get(0).is(Kind.BLOCK)) {
            BlockTree block = (BlockTree) statements.get(0);
            return endsWithJump(block.statements());
        }
        return Iterables.getLast(statements).is(Kind.BREAK_STATEMENT, Kind.RETURN_STATEMENT, Kind.THROW_STATEMENT,
                Kind.CONTINUE_STATEMENT);
    }
}