net.sourceforge.pmd.lang.java.ast.ASTCompilationUnit Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pmd-java Show documentation
There is a newer version: 7.8.0
/**
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.lang.java.ast;

import java.util.ArrayList;
import java.util.List;

import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

import net.sourceforge.pmd.annotation.Experimental;
import net.sourceforge.pmd.lang.ast.AstInfo;
import net.sourceforge.pmd.lang.ast.NodeStream;
import net.sourceforge.pmd.lang.ast.RootNode;
import net.sourceforge.pmd.lang.java.ast.internal.JavaAstUtils;
import net.sourceforge.pmd.lang.java.symbols.table.JSymbolTable;
import net.sourceforge.pmd.lang.java.types.TypeSystem;
import net.sourceforge.pmd.lang.java.types.ast.internal.LazyTypeResolver;
import net.sourceforge.pmd.lang.rule.xpath.NoAttribute;


/**
 * The root node of all Java ASTs.
 *
 *  *
 * CompilationUnit ::= OrdinaryCompilationUnit
 *                   | SimpleCompilationUnit
 *                   | ModularCompilationUnit
 *
 * OrdinaryCompilationUnit ::=
 *   {@linkplain ASTPackageDeclaration PackageDeclaration}?
 *   {@linkplain ASTImportDeclaration ImportDeclaration}*
 *   {@linkplain ASTTypeDeclaration TypeDeclaration}*
 *
 * SimpleCompilationUnit ::=
 *   {@linkplain ASTImportDeclaration ImportDeclaration}*
 *   {@linkplain ASTImplicitClassDeclaration ImplicitClassDeclaration}
 *
 * ModularCompilationUnit ::=
 *   {@linkplain ASTImportDeclaration ImportDeclaration}*
 *   {@linkplain ASTModuleDeclaration ModuleDeclaration}
 *
 * 
 */
public final class ASTCompilationUnit extends AbstractJavaNode implements RootNode {

    private LazyTypeResolver lazyTypeResolver;
    private List comments;
    private AstInfo astInfo;

    ASTCompilationUnit(int id) {
        super(id);
        setRoot(this);
    }

    public List getComments() {
        return comments;
    }

    void setAstInfo(AstInfo task) {
        this.astInfo = task;
    }

    @Override
    public AstInfo getAstInfo() {
        return astInfo;
    }

    void setComments(List comments) {
        List result = new ArrayList<>();

        // collapses single line markdown comments into consecutive JavadocComments
        List currentMarkdownBlock = null;

        for (JavaComment comment : comments) {
            if (JavaAstUtils.isMarkdownComment(comment.getToken())) {
                if (currentMarkdownBlock == null) {
                    currentMarkdownBlock = new ArrayList<>();
                } else {
                    JavaComment lastComment = currentMarkdownBlock.get(currentMarkdownBlock.size() - 1);
                    int lastCommentLine = lastComment.getReportLocation().getStartLine();
                    if (comment.getReportLocation().getStartLine() - lastCommentLine > 1) {
                        result.add(new JavadocComment(currentMarkdownBlock));
                        currentMarkdownBlock = new ArrayList<>();
                    }
                }
                currentMarkdownBlock.add(comment);
            } else {
                if (currentMarkdownBlock != null) {
                    result.add(new JavadocComment(currentMarkdownBlock));
                    currentMarkdownBlock = null;
                }
                result.add(comment);
            }
        }
        if (currentMarkdownBlock != null) {
            result.add(new JavadocComment(currentMarkdownBlock));
        }

        this.comments = result;
    }


    @Override
    protected  R acceptVisitor(JavaVisitor visitor, P data) {
        return visitor.visit(this, data);
    }

    /**
     * Returns the package declaration, if there is one.
     */
    public @Nullable ASTPackageDeclaration getPackageDeclaration() {
        return AstImplUtil.getChildAs(this, 0, ASTPackageDeclaration.class);
    }


    /**
     * Returns the package name of this compilation unit. If there is no
     * package declaration, then returns the empty string.
     */
    public @NonNull String getPackageName() {
        ASTPackageDeclaration pack = getPackageDeclaration();
        return pack == null ? "" : pack.getName();
    }

    /**
     * Returns the top-level type declarations declared in this compilation
     * unit. This may be empty, eg if this a package-info.java, or a modular
     * compilation unit (but ordinary compilation units may also be empty).
     */
    public NodeStream getTypeDeclarations() {
        return children(ASTTypeDeclaration.class);
    }

    /**
     * Returns the module declaration, if this is a modular compilation unit.
     */
    public @Nullable ASTModuleDeclaration getModuleDeclaration() {
        return firstChild(ASTModuleDeclaration.class);
    }

    @Override
    public @NonNull JSymbolTable getSymbolTable() {
        assert symbolTable != null : "Symbol table wasn't set";
        return symbolTable;
    }


    @Override
    public TypeSystem getTypeSystem() {
        assert lazyTypeResolver != null : "Type resolution not initialized";
        return lazyTypeResolver.getTypeSystem();
    }

    void setTypeResolver(LazyTypeResolver typeResolver) {
        this.lazyTypeResolver = typeResolver;
    }

    @NonNull LazyTypeResolver getLazyTypeResolver() {
        assert lazyTypeResolver != null : "Type resolution not initialized";
        return lazyTypeResolver;
    }

    @Experimental("Implicitly Declared Classes and Instance Main Methods is a Java 22 / Java 23 Preview feature")
    @NoAttribute
    public boolean isSimpleCompilationUnit() {
        return children(ASTImplicitClassDeclaration.class).nonEmpty();
    }
}