org.sonar.javascript.checks.NonCaseLabelInSwitchCheck Maven / Gradle / Ivy

Go to download
/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011 SonarSource and Eriks Nukis
 * [email protected]
 *
 * 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 org.sonar.javascript.checks;

import com.google.common.collect.ImmutableList;
import java.util.ArrayDeque;
import java.util.Deque;
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.javascript.api.tree.Tree;
import org.sonar.plugins.javascript.api.tree.Tree.Kind;
import org.sonar.plugins.javascript.api.tree.statement.LabelledStatementTree;
import org.sonar.plugins.javascript.api.visitors.SubscriptionBaseTreeVisitor;
import org.sonar.squidbridge.annotations.ActivatedByDefault;
import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
import org.sonar.squidbridge.annotations.SqaleSubCharacteristic;

@Rule(
  key = "S1219",
  name = "\"switch\" statements should not contain non-case labels",
  priority = Priority.CRITICAL,
  tags = {Tags.MISRA, Tags.PITFALL})
@ActivatedByDefault
@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.READABILITY)
@SqaleConstantRemediation("10min")
public class NonCaseLabelInSwitchCheck extends SubscriptionBaseTreeVisitor {

  private Deque stack = new ArrayDeque<>();

  @Override
  public List nodesToVisit() {
    return ImmutableList.builder()
      .add(Kind.LABELLED_STATEMENT, Kind.CASE_CLAUSE)
      .add(
        Kind.FUNCTION_EXPRESSION,
        Kind.FUNCTION_DECLARATION,
        Kind.GENERATOR_FUNCTION_EXPRESSION,
        Kind.GENERATOR_DECLARATION)
      .build();
  }

  @Override
  public void visitFile(Tree scriptTree) {
    stack.clear();
    stack.push(0);
  }

  @Override
  public void visitNode(Tree tree) {
    if (tree.is(Kind.CASE_CLAUSE)) {
      enterCase();

    } else if (tree.is(Kind.LABELLED_STATEMENT)) {

      if (inCase()) {
        getContext().addIssue(this, tree,
          String.format("Remove this misleading \"%s\" label.", ((LabelledStatementTree) tree).label().name()));
      }

    } else {
      stack.push(0);
    }
  }


  @Override
  public void leaveNode(Tree tree) {
    if (tree.is(Kind.CASE_CLAUSE)) {
      leaveCase();

    } else if (tree.is(Kind.LABELLED_STATEMENT)) {
      // do nothing

    } else {
      stack.pop();
    }
  }

  private void leaveCase() {
    stack.push(stack.pop() - 1);
  }

  private boolean inCase() {
    return stack.peek() > 0;
  }

  private void enterCase() {
    stack.push(stack.pop() + 1);
  }

}