org.sonar.javascript.checks.AbstractSymbolNameCheck 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.plugins.javascript.api.symbols.Symbol;
import org.sonar.plugins.javascript.api.symbols.Usage;
import org.sonar.plugins.javascript.api.JavaScriptCheck;
import org.sonar.plugins.javascript.api.symbols.SymbolModel;
import org.sonar.plugins.javascript.api.tree.ScriptTree;
import org.sonar.plugins.javascript.api.visitors.BaseTreeVisitor;

import java.util.LinkedList;
import java.util.List;

public abstract class AbstractSymbolNameCheck extends BaseTreeVisitor {
  abstract List illegalNames();
  abstract String getMessage(Symbol symbol);

  @Override
  public void visitScript(ScriptTree tree) {
    for (Symbol symbol : getIllegalSymbols()) {
      raiseIssuesOnDeclarations(this, symbol, getMessage(symbol));
    }
  }

  protected List getIllegalSymbols() {
    SymbolModel symbolModel = getContext().getSymbolModel();
    List symbols = new LinkedList<>();
    for (String name : illegalNames()){
      symbols.addAll(symbolModel.getSymbols(name));
    }
    return symbols;
  }

  protected void raiseIssuesOnDeclarations(JavaScriptCheck check, Symbol symbol, String message){
    Preconditions.checkArgument(!symbol.builtIn());

    boolean issueRaised = false;
    for (Usage usage : symbol.usages()){
      if (usage.isDeclaration()){
        getContext().addIssue(check, usage.identifierTree(), message);
        issueRaised = true;
      }
    }

    if (!issueRaised){
      getContext().addIssue(check, symbol.usages().iterator().next().identifierTree(), message);
    }

  }
}