/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code 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 General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.tools.javac.tree;

import javax.tools.Diagnostic;

import com.sun.source.doctree.*;

import com.sun.tools.javac.parser.Tokens.Comment;

import com.sun.tools.javac.util.Assert;

import com.sun.tools.javac.util.DefinedBy;

import com.sun.tools.javac.util.DefinedBy.Api;

import com.sun.tools.javac.util.DiagnosticSource;

import com.sun.tools.javac.util.JCDiagnostic;

import com.sun.tools.javac.util.JCDiagnostic.SimpleDiagnosticPosition;

import com.sun.tools.javac.util.Position;

import java.io.IOException;

import java.io.StringWriter;

import javax.tools.JavaFileObject;

/**

 * <p><b>This is NOT part of any supported API.

 * If you write code that depends on this, you do so at your own risk.

 * This code and its internal interfaces are subject to change or

 * deletion without notice.</b>

 */

public abstract class DCTree implements DocTree {

    /**

     * The position in the comment string.

     * Use {@link #getSourcePosition getSourcePosition} to convert

     * it to a position in the source file.

     *

     * TODO: why not simply translate all these values into

     * source file positions? Is it useful to have string-offset

     * positions as well?

     */

    public int pos;

    public long getSourcePosition(DCDocComment dc) {

        return dc.comment.getSourcePos(pos);

    }

    public JCDiagnostic.DiagnosticPosition pos(DCDocComment dc) {

        return new SimpleDiagnosticPosition(dc.comment.getSourcePos(pos));

    }

    /** Convert a tree to a pretty-printed string. */

    @Override

    public String toString() {

        StringWriter s = new StringWriter();

        try {

            new DocPretty(s).print(this);

        }

        catch (IOException e) {

            // should never happen, because StringWriter is defined

            // never to throw any IOExceptions

            throw new AssertionError(e);

        }

        return s.toString();

    }

    public static abstract class DCEndPosTree<T extends DCEndPosTree<T>> extends DCTree {

        private int endPos = Position.NOPOS;

        public int getEndPos(DCDocComment dc) {

            return dc.comment.getSourcePos(endPos);

        }

        @SuppressWarnings("unchecked")

        public T setEndPos(int endPos) {

            this.endPos = endPos;

            return (T) this;

        }

    }

    public static class DCDocComment extends DCTree implements DocCommentTree {

        public final Comment comment; // required for the implicit source pos table

        public final List<DCTree> fullBody;

        public final List<DCTree> firstSentence;

        public final List<DCTree> body;

        public final List<DCTree> tags;

        public DCDocComment(Comment comment,

                            List<DCTree> fullBody,

                            List<DCTree> firstSentence,

                            List<DCTree> body,

                            List<DCTree> tags) {

            this.comment = comment;

            this.firstSentence = firstSentence;

            this.fullBody = fullBody;

            this.body = body;

            this.tags = tags;

        }

        public Kind getKind() {

            return Kind.DOC_COMMENT;

        }

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitDocComment(this, d);

        }

        public List<? extends DocTree> getFirstSentence() {

            return firstSentence;

        }

        public List<? extends DocTree> getFullBody() {

            return fullBody;

        }

        public List<? extends DocTree> getBody() {

            return body;

        }

        public List<? extends DocTree> getBlockTags() {

            return tags;

        }

    }

    public static abstract class DCBlockTag extends DCTree implements BlockTagTree {

        public String getTagName() {

            return getKind().tagName;

        }

    }

    public static abstract class DCInlineTag extends DCEndPosTree<DCInlineTag> implements InlineTagTree {

        public String getTagName() {

            return getKind().tagName;

        }

    }

    public static class DCAttribute extends DCTree implements AttributeTree {

        public final Name name;

        public final ValueKind vkind;

        public final List<DCTree> value;

        DCAttribute(Name name, ValueKind vkind, List<DCTree> value) {

            Assert.check((vkind == ValueKind.EMPTY) ? (value == null) : (value != null));

            this.name = name;

            this.vkind = vkind;

            this.value = value;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return Kind.ATTRIBUTE;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitAttribute(this, d);

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Name getName() {

            return name;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public ValueKind getValueKind() {

            return vkind;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public List<DCTree> getValue() {

            return value;

        }

    }

    public static class DCAuthor extends DCBlockTag implements AuthorTree {

        public final List<DCTree> name;

        DCAuthor(List<DCTree> name) {

            this.name = name;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return Kind.AUTHOR;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitAuthor(this, d);

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public List<? extends DocTree> getName() {

            return name;

        }

    }

    public static class DCComment extends DCTree implements CommentTree {

        public final String body;

        DCComment(String body) {

            this.body = body;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return Kind.COMMENT;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitComment(this, d);

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public String getBody() {

            return body;

        }

    }

    public static class DCDeprecated extends DCBlockTag implements DeprecatedTree {

        public final List<DCTree> body;

        DCDeprecated(List<DCTree> body) {

            this.body = body;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return Kind.DEPRECATED;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitDeprecated(this, d);

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public List<? extends DocTree> getBody() {

            return body;

        }

    }

    public static class DCDocRoot extends DCInlineTag implements DocRootTree {

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return Kind.DOC_ROOT;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitDocRoot(this, d);

        }

    }

    public static class DCEndElement extends DCTree implements EndElementTree {

        public final Name name;

        DCEndElement(Name name) {

            this.name = name;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return Kind.END_ELEMENT;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitEndElement(this, d);

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Name getName() {

            return name;

        }

    }

    public static class DCEntity extends DCTree implements EntityTree {

        public final Name name;

        DCEntity(Name name) {

            this.name = name;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return Kind.ENTITY;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitEntity(this, d);

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Name getName() {

            return name;

        }

    }

    public static class DCErroneous extends DCTree implements ErroneousTree, JCDiagnostic.DiagnosticPosition {

        public final String body;

        public final JCDiagnostic diag;

        DCErroneous(String body, JCDiagnostic.Factory diags, DiagnosticSource diagSource, String code, Object... args) {

            this.body = body;

            this.diag = diags.error(null, diagSource, this, code, args);

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return Kind.ERRONEOUS;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitErroneous(this, d);

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public String getBody() {

            return body;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Diagnostic<JavaFileObject> getDiagnostic() {

            return diag;

        }

        @Override

        public JCTree getTree() {

            return null;

        }

        @Override

        public int getStartPosition() {

            return pos;

        }

        @Override

        public int getPreferredPosition() {

            return pos + body.length() - 1;

        }

        @Override

        public int getEndPosition(EndPosTable endPosTable) {

            return pos + body.length();

        }

    }

    public static class DCIdentifier extends DCTree implements IdentifierTree {

        public final Name name;

        DCIdentifier(Name name) {

            this.name = name;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return Kind.IDENTIFIER;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitIdentifier(this, d);

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Name getName() {

            return name;

        }

    }

    public static class DCIndex extends DCInlineTag implements IndexTree {

        public final DCTree term;

        public final List<DCTree> description;

        DCIndex(DCTree term, List<DCTree> description) {

            this.term = term;

            this.description = description;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return Kind.INDEX;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitIndex(this, d);

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public DocTree getSearchTerm() {

            return term;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public java.util.List<? extends DocTree> getDescription() {

            return description;

        }

    }

    public static class DCInheritDoc extends DCInlineTag implements InheritDocTree {

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return Kind.INHERIT_DOC;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitInheritDoc(this, d);

        }

    }

    public static class DCLink extends DCInlineTag implements LinkTree {

        public final Kind kind;

        public final DCReference ref;

        public final List<DCTree> label;

        DCLink(Kind kind, DCReference ref, List<DCTree> label) {

            Assert.check(kind == Kind.LINK || kind == Kind.LINK_PLAIN);

            this.kind = kind;

            this.ref = ref;

            this.label = label;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return kind;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitLink(this, d);

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public ReferenceTree getReference() {

            return ref;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public List<? extends DocTree> getLabel() {

            return label;

        }

    }

    public static class DCLiteral extends DCInlineTag implements LiteralTree {

        public final Kind kind;

        public final DCText body;

        DCLiteral(Kind kind, DCText body) {

            Assert.check(kind == Kind.CODE || kind == Kind.LITERAL);

            this.kind = kind;

            this.body = body;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public Kind getKind() {

            return kind;

        }

        @Override @DefinedBy(Api.COMPILER_TREE)

        public <R, D> R accept(DocTreeVisitor<R, D> v, D d) {

            return v.visitLiteral(this, d);

        }

        @Override @DefinedBy(Api.COMPILER_TREE)