org.sonar.javascript.checks.UnusedFunctionArgumentCheck 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.base.Preconditions;
import org.sonar.api.server.rule.RulesDefinition;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.javascript.ast.resolve.Scope;
import org.sonar.plugins.javascript.api.symbols.Symbol;
import org.sonar.plugins.javascript.api.symbols.Usage;
import org.sonar.javascript.model.internal.JavaScriptTree;
import org.sonar.plugins.javascript.api.symbols.SymbolModel;
import org.sonar.plugins.javascript.api.tree.ScriptTree;
import org.sonar.plugins.javascript.api.tree.Tree;
import org.sonar.plugins.javascript.api.visitors.BaseTreeVisitor;
import org.sonar.squidbridge.annotations.ActivatedByDefault;
import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
import org.sonar.squidbridge.annotations.SqaleSubCharacteristic;

import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;

@Rule(
  key = "UnusedFunctionArgument",
  name = "Unused function parameters should be removed",
  priority = Priority.MAJOR,
  tags = {Tags.MISRA, Tags.UNUSED})
@ActivatedByDefault
@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.UNDERSTANDABILITY)
@SqaleConstantRemediation("5min")
public class UnusedFunctionArgumentCheck extends BaseTreeVisitor {
  private static final String MESSAGE = "Remove the unused function parameter%s \"%s\".";

  private class PositionComparator implements Comparator {

    private int getLine(Symbol symbol){
      return ((JavaScriptTree)getDeclarationUsage(symbol).identifierTree()).getLine();
    }

    private int getColumn(Symbol symbol){
      return ((JavaScriptTree)getDeclarationUsage(symbol).identifierTree()).getToken().getColumn();
    }

    @Override
    public int compare(Symbol symbol1, Symbol symbol2) {
      int lineCompare = Integer.compare(getLine(symbol1), getLine(symbol2));
      if (lineCompare == 0) {
        return Integer.compare(getColumn(symbol1), getColumn(symbol2));
      } else {
        return lineCompare;
      }
    }

    private Usage getDeclarationUsage(Symbol symbol){
      Preconditions.checkArgument(symbol.is(Symbol.Kind.PARAMETER));
      for (Usage usage : symbol.usages()){
        if (usage.kind() == Usage.Kind.LEXICAL_DECLARATION){
          return usage;
        }
      }
      // parameter symbol is required to have LEXICAL_DECLARATION usage
      throw new IllegalStateException();
    }
  }

  public Collection getScopes(){
    SymbolModel symbolModel = getContext().getSymbolModel();
    Set uniqueScopes = new HashSet<>();
    for (Symbol symbol : symbolModel.getSymbols()){
      uniqueScopes.add(symbol.scope());
    }
    return uniqueScopes;
  }

  @Override
  public void visitScript(ScriptTree tree) {
    Collection scopes = getScopes();

    for (Scope scope : scopes){
      visitScope(scope);
    }
  }

  private void visitScope(Scope scope) {
    if (builtInArgumentsUsed(scope) || scope.tree().is(Tree.Kind.SET_METHOD)){
      return;
    }

    List arguments = scope.getSymbols(Symbol.Kind.PARAMETER);
    List unusedArguments = getUnusedArguments(arguments);

    if (!unusedArguments.isEmpty()) {
      String ending = unusedArguments.size() == 1 ? "" : "s";
      getContext().addIssue(this, scope.tree(), String.format(MESSAGE, ending, getListOfArguments(unusedArguments)));
    }
  }

  private List getUnusedArguments(List arguments){
    List unusedArguments = new LinkedList<>();
    Collections.sort(arguments, new PositionComparator());
    List usageInfo = getUsageInfo(arguments);
    boolean usedAfter = false;
    for (int i = arguments.size() - 1; i >= 0; i--){
      if (usageInfo.get(i)){
        usedAfter = true;
      } else if (!usedAfter){
        unusedArguments.add(0, arguments.get(i));
      }
    }
    return unusedArguments;
  }

  private static boolean builtInArgumentsUsed(Scope scope) {
    Symbol argumentsBuiltInVariable = scope.lookupSymbol("arguments");
    if (argumentsBuiltInVariable == null){
      return false;
    }
    boolean isUsed = !argumentsBuiltInVariable.usages().isEmpty();
    return argumentsBuiltInVariable.builtIn() && isUsed;
  }

  private static List getUsageInfo(List symbols) {
    List result = new LinkedList<>();
    for (Symbol symbol : symbols){
      if (symbol.usages().size() == 1){
        // only declaration
        result.add(false);
      } else {
        result.add(true);
      }
    }
    return result;
  }

  private static String getListOfArguments(List unusedArguments) {
    StringBuilder result = new StringBuilder();
    for (Symbol symbol : unusedArguments){
      result.append(symbol.name());
      result.append(", ");
    }
    return result.toString().replaceFirst(", $", "");
  }

}