org.sonar.php.tree.impl.expression.AnonymousClassTreeImpl 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.impl.expression;

import java.util.Iterator;
import java.util.List;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
import org.sonar.php.symbols.ClassSymbol;
import org.sonar.php.tree.impl.PHPTree;
import org.sonar.php.tree.impl.SeparatedListImpl;
import org.sonar.php.tree.symbols.HasClassSymbol;
import org.sonar.php.utils.collections.IteratorUtils;
import org.sonar.plugins.php.api.tree.SeparatedList;
import org.sonar.plugins.php.api.tree.Tree;
import org.sonar.plugins.php.api.tree.declaration.AttributeGroupTree;
import org.sonar.plugins.php.api.tree.declaration.CallArgumentTree;
import org.sonar.plugins.php.api.tree.declaration.ClassMemberTree;
import org.sonar.plugins.php.api.tree.declaration.MethodDeclarationTree;
import org.sonar.plugins.php.api.tree.declaration.NamespaceNameTree;
import org.sonar.plugins.php.api.tree.expression.AnonymousClassTree;
import org.sonar.plugins.php.api.tree.expression.ExpressionTree;
import org.sonar.plugins.php.api.tree.lexical.SyntaxToken;
import org.sonar.plugins.php.api.visitors.VisitorCheck;

public class AnonymousClassTreeImpl extends PHPTree implements AnonymousClassTree, HasClassSymbol {

  private static final Kind KIND = Kind.ANONYMOUS_CLASS;

  private final List attributeGroups;
  private final SyntaxToken classToken;
  private final SyntaxToken openParenthesisToken;
  private final SeparatedList arguments;
  private final SyntaxToken closeParenthesisToken;
  private final SyntaxToken extendsToken;
  private final NamespaceNameTree superClass;
  private final SyntaxToken implementsToken;
  private final SeparatedListImpl superInterfaces;
  private final SyntaxToken openCurlyBraceToken;
  private final List members;
  private final SyntaxToken closeCurlyBraceToken;
  private final SeparatedList callArguments;
  @Nullable
  private final SyntaxToken readonly;
  private ClassSymbol symbol;

  @SuppressWarnings("java:S107")
  public AnonymousClassTreeImpl(
    List attributeGroups,
    @Nullable SyntaxToken readonly,
    SyntaxToken classToken,
    @Nullable SyntaxToken openParenthesisToken,
    SeparatedList callArguments,
    @Nullable SyntaxToken closeParenthesisToken,
    @Nullable SyntaxToken extendsToken,
    @Nullable NamespaceNameTree superClass,
    @Nullable SyntaxToken implementsToken,
    @Nullable SeparatedListImpl superInterfaces,
    SyntaxToken openCurlyBraceToken,
    List members,
    SyntaxToken closeCurlyBraceToken) {
    List argumentValues = callArguments.stream()
      .map(CallArgumentTree::value)
      .toList();

    this.attributeGroups = attributeGroups;
    this.readonly = readonly;
    this.classToken = classToken;
    this.openParenthesisToken = openParenthesisToken;
    this.callArguments = callArguments;
    this.arguments = new SeparatedListImpl<>(argumentValues, callArguments.getSeparators());
    this.closeParenthesisToken = closeParenthesisToken;
    this.extendsToken = extendsToken;
    this.superClass = superClass;
    this.implementsToken = implementsToken;
    this.superInterfaces = superInterfaces;
    this.openCurlyBraceToken = openCurlyBraceToken;
    this.members = members;
    this.closeCurlyBraceToken = closeCurlyBraceToken;
  }

  @Override
  public List attributeGroups() {
    return attributeGroups;
  }

  @Override
  public boolean isReadOnly() {
    return readonly != null;
  }

  @Override
  public SyntaxToken classToken() {
    return classToken;
  }

  @Nullable
  @Override
  public SyntaxToken openParenthesisToken() {
    return openCurlyBraceToken;
  }

  /**
   * @deprecated since 3.11 . Use {@link #callArguments()} instead.
   */
  @Deprecated
  @Override
  public SeparatedList arguments() {
    return arguments;
  }

  @Override
  public SeparatedList callArguments() {
    return callArguments;
  }

  @Nullable
  @Override
  public SyntaxToken closeParenthesisToken() {
    return closeCurlyBraceToken;
  }

  @Nullable
  @Override
  public SyntaxToken extendsToken() {
    return extendsToken;
  }

  @Nullable
  @Override
  public NamespaceNameTree superClass() {
    return superClass;
  }

  @Nullable
  @Override
  public SyntaxToken implementsToken() {
    return implementsToken;
  }

  @Override
  public SeparatedList superInterfaces() {
    return superInterfaces;
  }

  @Override
  public SyntaxToken openCurlyBraceToken() {
    return openCurlyBraceToken;
  }

  @Override
  public List members() {
    return members;
  }

  @Override
  public SyntaxToken closeCurlyBraceToken() {
    return closeCurlyBraceToken;
  }

  @Nullable
  @Override
  public MethodDeclarationTree fetchConstructor() {
    MethodDeclarationTree constructor = null;

    for (ClassMemberTree member : members) {
      if (member.is(Kind.METHOD_DECLARATION)) {
        MethodDeclarationTree method = (MethodDeclarationTree) member;
        String methodName = method.name().text();

        if (PHP5_CONSTRUCTOR_NAME.equalsIgnoreCase(methodName)) {
          constructor = method;
        }
      }
    }

    return constructor;
  }

  @Override
  public Iterator childrenIterator() {
    return IteratorUtils.concat(
      attributeGroups.iterator(),
      IteratorUtils.iteratorOf(readonly, classToken, openParenthesisToken),
      callArguments.elementsAndSeparators(),
      IteratorUtils.iteratorOf(closeParenthesisToken, extendsToken, superClass, implementsToken),
      superInterfaces.elementsAndSeparators(),
      IteratorUtils.iteratorOf(openCurlyBraceToken),
      members.iterator(),
      IteratorUtils.iteratorOf(closeCurlyBraceToken));
  }

  @Override
  public void accept(VisitorCheck visitor) {
    visitor.visitAnonymousClass(this);
  }

  @Override
  public Kind getKind() {
    return KIND;
  }

  public ClassSymbol symbol() {
    return symbol;
  }

  public void setSymbol(ClassSymbol symbol) {
    this.symbol = symbol;
  }
}