org.sonar.javascript.tree.symbols.SymbolModelImpl Maven / Gradle / Ivy
/*
* SonarQube JavaScript Plugin
* Copyright (C) 2011-2018 SonarSource SA
* mailto:info 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.javascript.tree.symbols;
import java.util.Collections;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import javax.annotation.Nullable;
import org.sonar.api.config.Configuration;
import org.sonar.javascript.tree.symbols.type.TypeVisitor;
import org.sonar.plugins.javascript.api.symbols.Symbol;
import org.sonar.plugins.javascript.api.symbols.Symbol.Kind;
import org.sonar.plugins.javascript.api.symbols.SymbolModel;
import org.sonar.plugins.javascript.api.tree.Tree;
import org.sonar.plugins.javascript.api.visitors.TreeVisitorContext;
public class SymbolModelImpl implements SymbolModel, SymbolModelBuilder {
private Set symbols = new HashSet<>();
private Set scopes = new HashSet<>();
private Scope globalScope;
public static void build(TreeVisitorContext context, @Nullable Configuration configuration) {
Map treeScopeMap = getScopes(context);
new HoistedSymbolVisitor(treeScopeMap, configuration).scanTree(context);
new SymbolVisitor(treeScopeMap).scanTree(context);
new TypeVisitor(configuration).scanTree(context);
}
private static Map getScopes(TreeVisitorContext context) {
ScopeVisitor scopeVisitor = new ScopeVisitor();
scopeVisitor.scanTree(context);
return scopeVisitor.getTreeScopeMap();
}
@Override
public Scope globalScope() {
return globalScope;
}
@Override
public void addScope(Scope scope) {
if (scopes.isEmpty()) {
globalScope = scope;
}
scopes.add(scope);
}
@Override
public Set getScopes() {
return scopes;
}
@Override
public Symbol declareSymbol(String name, Symbol.Kind kind, Scope scope) {
Symbol symbol = scope.getSymbol(name);
if (symbol == null) {
symbol = new Symbol(name, kind, scope);
scope.addSymbol(symbol);
symbols.add(symbol);
} else if (kind.equals(Kind.FUNCTION)) {
symbol.setKind(Kind.FUNCTION);
}
return symbol;
}
@Override
public Symbol declareExternalSymbol(String name, Symbol.Kind kind, Scope scope) {
Symbol symbol = scope.getSymbol(name);
if (symbol == null) {
symbol = new Symbol(name, kind, scope);
symbol.setExternal(true);
scope.addSymbol(symbol);
symbols.add(symbol);
}
return symbol;
}
/**
* Returns all symbols in script
*/
@Override
public Set getSymbols() {
return Collections.unmodifiableSet(symbols);
}
/**
* @param kind kind of symbols to look for
* @return list of symbols with the given kind
*/
@Override
public Set getSymbols(Symbol.Kind kind) {
Set result = new HashSet<>();
for (Symbol symbol : symbols) {
if (kind.equals(symbol.kind())) {
result.add(symbol);
}
}
return result;
}
/**
* @param name name of symbols to look for
* @return list of symbols with the given name
*/
@Override
public Set getSymbols(String name) {
Set result = new HashSet<>();
for (Symbol symbol : symbols) {
if (name.equals(symbol.name())) {
result.add(symbol);
}
}
return result;
}
@Nullable
@Override
public Scope getScope(Tree tree) {
for (Scope scope : getScopes()) {
if (scope.tree().equals(tree)) {
return scope;
}
}
return null;
}
}