org.mozilla.javascript.ast.AstRoot Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rhino Show documentation
Rhino is an open-source implementation of JavaScript written entirely in Java. It is typically embedded into Java applications to provide scripting to end users.
The newest version!
/* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

package org.mozilla.javascript.ast;

import java.util.SortedSet;
import java.util.TreeSet;
import org.mozilla.javascript.Node;
import org.mozilla.javascript.Token;

/**
 * Node for the root of a parse tree. It contains the statements and functions in the script, and a
 * list of {@link Comment} nodes associated with the script as a whole. Node type is {@link
 * Token#SCRIPT}.
 *
 * Note that the tree itself does not store errors. To collect the parse errors and warnings,
 * pass an {@link org.mozilla.javascript.ErrorReporter} to the {@link org.mozilla.javascript.Parser}
 * via the {@link org.mozilla.javascript.CompilerEnvirons}.
 */
public class AstRoot extends ScriptNode {

    private SortedSet comments;

    {
        type = Token.SCRIPT;
    }

    public AstRoot() {}

    public AstRoot(int pos) {
        super(pos);
    }

    /**
     * Returns comment set
     *
     * @return comment set, sorted by start position. Can be {@code null}.
     */
    public SortedSet getComments() {
        return comments;
    }

    /**
     * Sets comment list, and updates the parent of each entry to point to this node. Replaces any
     * existing comments.
     *
     * @param comments comment list. can be {@code null}.
     */
    public void setComments(SortedSet comments) {
        if (comments == null) {
            this.comments = null;
        } else {
            if (this.comments != null) this.comments.clear();
            for (Comment c : comments) addComment(c);
        }
    }

    /**
     * Add a comment to the comment set.
     *
     * @param comment the comment node.
     * @throws IllegalArgumentException if comment is {@code null}
     */
    public void addComment(Comment comment) {
        assertNotNull(comment);
        if (comments == null) {
            comments = new TreeSet<>(new AstNode.PositionComparator());
        }
        comments.add(comment);
        comment.setParent(this);
    }

    /**
     * Visits the comment nodes in the order they appear in the source code. The comments are not
     * visited by the {@link #visit} function - you must use this function to visit them.
     *
     * @param visitor the callback object. It is passed each comment node. The return value is
     *     ignored.
     */
    public void visitComments(NodeVisitor visitor) {
        if (comments != null) {
            for (Comment c : comments) {
                visitor.visit(c);
            }
        }
    }

    /**
     * Visits the AST nodes, then the comment nodes. This method is equivalent to calling {@link
     * #visit}, then {@link #visitComments}. The return value is ignored while visiting comment
     * nodes.
     *
     * @param visitor the callback object.
     */
    public void visitAll(NodeVisitor visitor) {
        visit(visitor);
        visitComments(visitor);
    }

    @Override
    public String toSource(int depth) {
        StringBuilder sb = new StringBuilder();
        for (Node node : this) {
            sb.append(((AstNode) node).toSource(depth));
            if (node.getType() == Token.COMMENT) {
                sb.append("\n");
            }
        }
        return sb.toString();
    }

    /** A debug-printer that includes comments (at the end). */
    @Override
    public String debugPrint() {
        DebugPrintVisitor dpv = new DebugPrintVisitor(new StringBuilder(1000));
        visitAll(dpv);
        return dpv.toString();
    }

    /**
     * Debugging function to check that the parser has set the parent link for every node in the
     * tree.
     *
     * @throws IllegalStateException if a parent link is missing
     */
    public void checkParentLinks() {
        this.visit(
                new NodeVisitor() {
                    @Override
                    public boolean visit(AstNode node) {
                        int type = node.getType();
                        if (type == Token.SCRIPT) return true;
                        if (node.getParent() == null)
                            throw new IllegalStateException(
                                    "No parent for node: " + node + "\n" + node.toSource(0));
                        return true;
                    }
                });
    }
}