org.sonar.php.tree.symbols.SymbolTableImpl Maven / Gradle / Ivy

Go to download
/*
 * SonarQube PHP Plugin
 * Copyright (C) 2010-2024 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.php.tree.symbols;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.sonar.php.symbols.ClassSymbolData;
import org.sonar.php.symbols.FunctionSymbolData;
import org.sonar.php.symbols.ProjectSymbolData;
import org.sonar.php.tree.visitors.AssignmentExpressionVisitor;
import org.sonar.php.tree.visitors.FrameworkDetectionVisitor;
import org.sonar.plugins.php.api.symbols.QualifiedName;
import org.sonar.plugins.php.api.symbols.Symbol;
import org.sonar.plugins.php.api.symbols.SymbolTable;
import org.sonar.plugins.php.api.symbols.TypeSymbol;
import org.sonar.plugins.php.api.tree.CompilationUnitTree;
import org.sonar.plugins.php.api.tree.Tree;
import org.sonar.plugins.php.api.tree.expression.IdentifierTree;
import org.sonar.plugins.php.api.visitors.PhpFile;

public class SymbolTableImpl implements SymbolTable {

  private final List symbols = new ArrayList<>();
  private final Map scopes = new HashMap<>();
  private final Map symbolsByTree = new HashMap<>();
  private final Map symbolByQualifiedName = new HashMap<>();
  private Collection classSymbolData;
  private Collection functionSymbolData;
  private Framework framework = Framework.EMPTY;

  private SymbolTableImpl() {
  }

  public static SymbolTableImpl create(CompilationUnitTree compilationUnit) {
    return create(compilationUnit, new ProjectSymbolData(), null);
  }

  public static SymbolTableImpl create(CompilationUnitTree compilationUnit, ProjectSymbolData projectSymbolData, @Nullable PhpFile file) {
    return create(compilationUnit, projectSymbolData, file, true);
  }

  public static SymbolTableImpl create(CompilationUnitTree compilationUnit, ProjectSymbolData projectSymbolData, @Nullable PhpFile file, boolean frameworkDetectionEnabled) {
    var symbolModel = new SymbolTableImpl();
    var declarationVisitor = new DeclarationVisitor(symbolModel, projectSymbolData, file);
    declarationVisitor.visitCompilationUnit(compilationUnit);
    symbolModel.classSymbolData = declarationVisitor.classSymbolData();
    symbolModel.functionSymbolData = declarationVisitor.functionSymbolData();
    new SymbolVisitor(symbolModel).visitCompilationUnit(compilationUnit);
    new SymbolUsageVisitor(
      symbolModel,
      declarationVisitor.classSymbolIndex(),
      declarationVisitor.functionSymbolIndex()).visitCompilationUnit(compilationUnit);
    compilationUnit.accept(new AssignmentExpressionVisitor());
    if (frameworkDetectionEnabled) {
      var frameworkDetectionVisitor = new FrameworkDetectionVisitor();
      compilationUnit.accept(frameworkDetectionVisitor);
      symbolModel.framework = frameworkDetectionVisitor.getFramework();
    }
    return symbolModel;
  }

  public static SymbolTableImpl create(Collection classSymbolData, Collection functionSymbolData) {
    var symbolTable = new SymbolTableImpl();
    symbolTable.classSymbolData = classSymbolData;
    symbolTable.functionSymbolData = functionSymbolData;
    return symbolTable;
  }

  Scope addScope(Scope scope) {
    return scopes.computeIfAbsent(scope.tree(), t -> scope);
  }

  @Override
  public Set getScopes() {
    return new HashSet<>(scopes.values());
  }

  @Nullable
  @Override
  public Scope getScopeFor(Tree tree) {
    return scopes.get(tree);
  }

  @Override
  public Framework getFramework() {
    return this.framework;
  }

  SymbolImpl declareSymbol(IdentifierTree name, Symbol.Kind kind, Scope scope, SymbolQualifiedName namespace) {
    SymbolImpl symbol;
    if (kind.hasQualifiedName()) {
      SymbolQualifiedName qualifiedName = namespace.resolve(name.text());
      symbol = new SymbolImpl(name, kind, scope, qualifiedName);
      symbolByQualifiedName.put(qualifiedName, symbol);
    } else {
      symbol = new SymbolImpl(name, kind, scope);
    }
    addSymbol(name, scope, symbol);
    return symbol;
  }

  private void addSymbol(IdentifierTree name, Scope scope, Symbol symbol) {
    symbols.add(symbol);
    scope.addSymbol(symbol);
    associateSymbol(name, symbol);
  }

  TypeSymbolImpl declareTypeSymbol(IdentifierTree name, Scope scope, SymbolQualifiedName qualifiedName) {
    var symbol = new TypeSymbolImpl(name, scope, qualifiedName);
    symbolByQualifiedName.put(qualifiedName, symbol);
    addSymbol(name, scope, symbol);
    return symbol;
  }

  MemberSymbolImpl declareMemberSymbol(IdentifierTree name, Symbol.Kind kind, Scope scope, TypeSymbol owner) {
    var memberSymbol = new MemberSymbolImpl(name, kind, scope, owner);
    symbolByQualifiedName.put(memberSymbol.qualifiedName(), memberSymbol);
    addSymbol(name, scope, memberSymbol);
    return memberSymbol;
  }

  SymbolImpl createUndeclaredSymbol(QualifiedName fullyQualifiedName, Symbol.Kind kind) {
    var undeclaredSymbol = new UndeclaredSymbol(fullyQualifiedName, kind);
    symbolByQualifiedName.put(fullyQualifiedName, undeclaredSymbol);
    return undeclaredSymbol;
  }

  /**
   * Returns all symbols in script
   */
  public List getSymbols() {
    return Collections.unmodifiableList(symbols);
  }

  /**
   * @param kind kind of symbols to look for
   * @return list of symbols with the given kind
   */
  @Override
  public List getSymbols(Symbol.Kind kind) {
    List result = new ArrayList<>();
    for (Symbol symbol : getSymbols()) {
      if (kind == symbol.kind()) {
        result.add(symbol);
      }
    }
    return result;
  }

  /**
   * @param name name of symbols to look for
   * @return list of symbols with the given name
   */
  public List getSymbols(String name) {
    List result = new ArrayList<>();
    for (Symbol symbol : getSymbols()) {
      if (symbol.called(name)) {
        result.add(symbol);
      }
    }
    return result;
  }

  Symbol getSymbol(QualifiedName qualifiedName) {
    return symbolByQualifiedName.get(qualifiedName);
  }

  Symbol getSymbol(String qualifiedName) {
    return getSymbol(SymbolQualifiedName.qualifiedName(qualifiedName));
  }

  void associateSymbol(Tree identifier, Symbol symbol) {
    // If a tree could semantically be associated with two different symbols (see SONARPHP-857), keep the first one and do not override.
    symbolsByTree.putIfAbsent(identifier, symbol);
  }

  @Override
  @CheckForNull
  public Symbol getSymbol(Tree tree) {
    return symbolsByTree.get(tree);
  }

  public Collection classSymbolDatas() {
    return classSymbolData;
  }

  public Collection functionSymbolDatas() {
    return functionSymbolData;
  }
}