org.sonar.javascript.checks.RedeclaredVariableCheck 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.sonar.sslr.api.AstNode;
import org.sonar.check.BelongsToProfile;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.javascript.checks.utils.FunctionUtils;
import org.sonar.javascript.checks.utils.IdentifierUtils;
import org.sonar.javascript.parser.EcmaScriptGrammar;
import org.sonar.squidbridge.checks.SquidCheck;
import org.sonar.sslr.parser.LexerlessGrammar;

import java.util.HashSet;
import java.util.Set;
import java.util.Stack;

@Rule(
  key = "RedeclaredVariable",
  priority = Priority.MAJOR)
@BelongsToProfile(title = CheckList.SONAR_WAY_PROFILE, priority = Priority.MAJOR)
public class RedeclaredVariableCheck extends SquidCheck {

  private Stack> stack;


  @Override
  public void init() {
    subscribeTo(
      EcmaScriptGrammar.VARIABLE_DECLARATION,
      EcmaScriptGrammar.VARIABLE_DECLARATION_NO_IN);
    subscribeTo(FunctionUtils.FUNCTION_NODES);
  }

  @Override
  public void visitFile(AstNode astNode) {
    stack = new Stack>();
    stack.add(new HashSet());
  }

  @Override
  public void visitNode(AstNode astNode) {
    if (astNode.is(FunctionUtils.FUNCTION_NODES)) {
      Set currentScope = new HashSet();
      stack.add(currentScope);
      addParametersToScope(astNode, currentScope);
    } else {
      Set currentScope = stack.peek();
      String variableName = astNode.getTokenValue();
      if (currentScope.contains(variableName)) {
        getContext().createLineViolation(this, "Rename variable \"" + variableName + "\" as this name is already used.", astNode);
      } else {
        currentScope.add(variableName);
      }
    }
  }

  @Override
  public void leaveNode(AstNode astNode) {
    if (astNode.is(FunctionUtils.FUNCTION_NODES)) {
      stack.pop();
    }
  }

  @Override
  public void leaveFile(AstNode astNode) {
    stack = null;
  }

  private void addParametersToScope(AstNode functionNode, Set currentScope) {
    if (functionNode.is(EcmaScriptGrammar.ARROW_FUNCTION)) {
      addArrowParametersToScope(functionNode.getFirstChild(EcmaScriptGrammar.ARROW_PARAMETERS), currentScope);
    } else {
      addFormalParametersToScope(functionNode.getFirstChild(EcmaScriptGrammar.FORMAL_PARAMETER_LIST), currentScope);
    }
  }

  private void addArrowParametersToScope(AstNode arrowParameters, Set currentScope) {
    if (arrowParameters != null) {
      for (AstNode parameter : IdentifierUtils.getArrowParametersIdentifier(arrowParameters)) {
        currentScope.add(parameter.getTokenValue());
      }
    }
  }

  private void addFormalParametersToScope(AstNode formalParameterList, Set currentScope) {
    if (formalParameterList != null) {
      for (AstNode identifier : IdentifierUtils.getParametersIdentifier(formalParameterList)) {
        currentScope.add(identifier.getTokenValue());
      }
    }
  }

}