/*

 * Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.

 * 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 jdk.javadoc.internal.doclets.formats.html;

import java.util.Collection;

import java.util.List;

import java.util.Set;

import java.util.SortedSet;

import java.util.TreeSet;

import javax.lang.model.element.AnnotationMirror;

import javax.lang.model.element.Element;

import javax.lang.model.element.ModuleElement;

import javax.lang.model.element.PackageElement;

import javax.lang.model.element.TypeElement;

import javax.lang.model.type.TypeMirror;

import javax.lang.model.util.SimpleElementVisitor8;

import com.sun.source.doctree.DocTree;

import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;

import jdk.javadoc.internal.doclets.formats.html.markup.Entity;

import jdk.javadoc.internal.doclets.formats.html.markup.HtmlAttr;

import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;

import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;

import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;

import jdk.javadoc.internal.doclets.formats.html.markup.Navigation;

import jdk.javadoc.internal.doclets.formats.html.markup.Navigation.PageMode;

import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;

import jdk.javadoc.internal.doclets.toolkit.ClassWriter;

import jdk.javadoc.internal.doclets.toolkit.Content;

import jdk.javadoc.internal.doclets.toolkit.taglets.ParamTaglet;

import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;

import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;

import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;

import jdk.javadoc.internal.doclets.toolkit.util.DocPath;

import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;

/**

 * Generate the Class Information Page.

 *

 *  <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>

 *

 * @see javax.lang.model.element.TypeElement

 * @see java.util.Collections

 * @see java.util.List

 * @see java.util.ArrayList

 * @see java.util.HashMap

 *

 * @author Atul M Dambalkar

 * @author Robert Field

 * @author Bhavesh Patel (Modified)

 */

public class ClassWriterImpl extends SubWriterHolderWriter implements ClassWriter {

    private static final Set<String> suppressSubtypesSet

            = Set.of("java.lang.Object",

                     "org.omg.CORBA.Object");

    private static final Set<String> suppressImplementingSet

            = Set.of( "java.lang.Cloneable",

                    "java.lang.constant.Constable",

                    "java.lang.constant.ConstantDesc",

                    "java.io.Serializable");

    protected final TypeElement typeElement;

    protected final ClassTree classtree;

    private final Navigation navBar;

    /**

     * @param configuration the configuration data for the doclet

     * @param typeElement the class being documented.

     * @param classTree the class tree for the given class.

     */

    public ClassWriterImpl(HtmlConfiguration configuration, TypeElement typeElement,

                           ClassTree classTree) {

        super(configuration, configuration.docPaths.forClass(typeElement));

        this.typeElement = typeElement;

        configuration.currentTypeElement = typeElement;

        this.classtree = classTree;

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public Content getHeader(String header) {

        HtmlTree bodyTree = getBody(getWindowTitle(utils.getSimpleName(typeElement)));

        Content linkContent = getModuleLink(utils.elementUtils.getModuleOf(typeElement),

                contents.moduleLabel);

        navBar.setNavLinkModule(linkContent);

        navBar.setMemberSummaryBuilder(configuration.getBuilderFactory().getMemberSummaryBuilder(this));

        navBar.setUserHeader(getUserHeaderFooter(true));

        HtmlTree div = new HtmlTree(HtmlTag.DIV);

        div.setStyle(HtmlStyle.header);

        if (configuration.showModules) {

            ModuleElement mdle = configuration.docEnv.getElementUtils().getModuleOf(typeElement);

            Content classModuleLabel = HtmlTree.SPAN(HtmlStyle.moduleLabelInType, contents.moduleLabel);

            Content moduleNameDiv = HtmlTree.DIV(HtmlStyle.subTitle, classModuleLabel);

            moduleNameDiv.add(Entity.NO_BREAK_SPACE);

            moduleNameDiv.add(getModuleLink(mdle,

                    new StringContent(mdle.getQualifiedName())));

            div.add(moduleNameDiv);

        }

        PackageElement pkg = utils.containingPackage(typeElement);

        if (!pkg.isUnnamed()) {

            Content classPackageLabel = HtmlTree.SPAN(HtmlStyle.packageLabelInType, contents.packageLabel);

            Content pkgNameDiv = HtmlTree.DIV(HtmlStyle.subTitle, classPackageLabel);

            pkgNameDiv.add(Entity.NO_BREAK_SPACE);

            Content pkgNameContent = getPackageLink(pkg,

                    new StringContent(utils.getPackageName(pkg)));

            pkgNameDiv.add(pkgNameContent);

            div.add(pkgNameDiv);

        }

        LinkInfoImpl linkInfo = new LinkInfoImpl(configuration,

                LinkInfoImpl.Kind.CLASS_HEADER, typeElement);

        //Let's not link to ourselves in the header.

        linkInfo.linkToSelf = false;

        Content heading = HtmlTree.HEADING(Headings.PAGE_TITLE_HEADING, true,

        heading.add(getTypeParameterLinks(linkInfo));

        div.add(heading);

        return bodyTree;

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public Content getClassContentHeader() {

        return getContentHeader();

    }

    /**

     * {@inheritDoc}

     */

    @Override

        Content htmlTree = HtmlTree.FOOTER();

        navBar.setUserFooter(getUserHeaderFooter(false));

        htmlTree.add(navBar.getContent(false));

        addBottom(htmlTree);

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void printDocument(Content contentTree) throws DocFileIOException {

        String description = getDescription("declaration", typeElement);

        PackageElement pkg = utils.containingPackage(typeElement);

        List<DocPath> localStylesheets = getLocalStylesheets(pkg);

        printHtmlDocument(configuration.metakeywords.getMetaKeywords(typeElement),

                description, localStylesheets, contentTree);

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public Content getClassInfoTreeHeader() {

        return getMemberTreeHeader();

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public Content getClassInfo(Content classInfoTree) {

        return getMemberTree(HtmlStyle.description, classInfoTree);

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void addClassSignature(String modifiers, Content classInfoTree) {

        Content hr = new HtmlTree(HtmlTag.HR);

        classInfoTree.add(hr);

        Content pre = new HtmlTree(HtmlTag.PRE);

        addAnnotationInfo(typeElement, pre);

        pre.add(modifiers);

        LinkInfoImpl linkInfo = new LinkInfoImpl(configuration,

                LinkInfoImpl.Kind.CLASS_SIGNATURE, typeElement);

        //Let's not link to ourselves in the signature.

        linkInfo.linkToSelf = false;

        Content className = new StringContent(utils.getSimpleName(typeElement));

        Content parameterLinks = getTypeParameterLinks(linkInfo);

        if (configuration.linksource) {

            addSrcLink(typeElement, className, pre);

            pre.add(parameterLinks);

        } else {

            Content span = HtmlTree.SPAN(HtmlStyle.typeNameLabel, className);

            span.add(parameterLinks);

            pre.add(span);

        }

        if (!utils.isInterface(typeElement)) {

            TypeMirror superclass = utils.getFirstVisibleSuperClass(typeElement);

            if (superclass != null) {

                pre.add(DocletConstants.NL);

                pre.add("extends ");

                Content link = getLink(new LinkInfoImpl(configuration,

                        LinkInfoImpl.Kind.CLASS_SIGNATURE_PARENT_NAME,

                        superclass));

                pre.add(link);

            }

        }

        List<? extends TypeMirror> interfaces = typeElement.getInterfaces();

        if (!interfaces.isEmpty()) {

            boolean isFirst = true;

            for (TypeMirror type : interfaces) {

                TypeElement tDoc = utils.asTypeElement(type);

                if (!(utils.isPublic(tDoc) || utils.isLinkable(tDoc))) {

                    continue;

                }

                if (isFirst) {

                    pre.add(DocletConstants.NL);

                    pre.add(utils.isInterface(typeElement) ? "extends " : "implements ");

                    isFirst = false;

                } else {

                    pre.add(", ");

                }

                Content link = getLink(new LinkInfoImpl(configuration,

                                                        LinkInfoImpl.Kind.CLASS_SIGNATURE_PARENT_NAME,

                                                        type));

                pre.add(link);

            }

        }

        classInfoTree.add(pre);

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void addClassDescription(Content classInfoTree) {

        if(!configuration.nocomment) {

            // generate documentation for the class.

            if (!utils.getFullBody(typeElement).isEmpty()) {

                addInlineComment(typeElement, classInfoTree);

            }

        }

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void addClassTagInfo(Content classInfoTree) {

        if(!configuration.nocomment) {

            // Print Information about all the tags here

            addTagsInfo(typeElement, classInfoTree);

        }

    }

    /**

     * Get the class hierarchy tree for the given class.

     *

     * @param type the class to print the hierarchy for

     * @return a content tree for class inheritence

     */

    private Content getClassInheritenceTree(TypeMirror type) {

        TypeMirror sup;

        HtmlTree classTree = null;

        do {

            sup = utils.getFirstVisibleSuperClass(type);

            HtmlTree htmlElement = HtmlTree.DIV(HtmlStyle.inheritance, getTreeForClassHelper(type));

            if (classTree != null)

                htmlElement.add(classTree);

            classTree = htmlElement;

            type = sup;

        } while (sup != null);

        classTree.put(HtmlAttr.TITLE, contents.getContent("doclet.Inheritance_Tree").toString());

        return classTree;

    }

    /**

     * Get the class helper tree for the given class.

     *

     * @param type the class to print the helper for

     * @return a content tree for class helper

     */

    private Content getTreeForClassHelper(TypeMirror type) {

        Content content = new ContentBuilder();

        if (type.equals(typeElement.asType())) {

            Content typeParameters = getTypeParameterLinks(

                    new LinkInfoImpl(configuration, LinkInfoImpl.Kind.TREE,

                    typeElement));

            if (configuration.shouldExcludeQualifier(utils.containingPackage(typeElement).toString())) {

                content.add(utils.asTypeElement(type).getSimpleName());

                content.add(typeParameters);

            } else {

                content.add(utils.asTypeElement(type).getQualifiedName());

                content.add(typeParameters);

            }

        } else {

            Content link = getLink(new LinkInfoImpl(configuration,

                    LinkInfoImpl.Kind.CLASS_TREE_PARENT, type)

                    .label(configuration.getClassName(utils.asTypeElement(type))));

            content.add(link);

        }

        return content;

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void addClassTree(Content classContentTree) {

        if (!utils.isClass(typeElement)) {

            return;

        }

        classContentTree.add(getClassInheritenceTree(typeElement.asType()));

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void addTypeParamInfo(Content classInfoTree) {

        if (!utils.getTypeParamTrees(typeElement).isEmpty()) {

            Content typeParam = (new ParamTaglet()).getTagletOutput(typeElement,

                    getTagletWriterInstance(false));

            Content dl = HtmlTree.DL(typeParam);

            classInfoTree.add(dl);

        }

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void addSubClassInfo(Content classInfoTree) {

        if (utils.isClass(typeElement)) {

            for (String s : suppressSubtypesSet) {

                if (typeElement.getQualifiedName().contentEquals(s)) {

                    return;    // Don't generate the list, too huge

                }

            }

            Set<TypeElement> subclasses = classtree.directSubClasses(typeElement, false);

            if (!subclasses.isEmpty()) {

                Content label = contents.subclassesLabel;

                Content dt = HtmlTree.DT(label);

                Content dl = HtmlTree.DL(dt);

                dl.add(getClassLinks(LinkInfoImpl.Kind.SUBCLASSES,

                        subclasses));

                classInfoTree.add(dl);

            }

        }

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void addSubInterfacesInfo(Content classInfoTree) {

        if (utils.isInterface(typeElement)) {

            Set<TypeElement> subInterfaces = classtree.allSubClasses(typeElement, false);

            if (!subInterfaces.isEmpty()) {

                Content label = contents.subinterfacesLabel;

                Content dt = HtmlTree.DT(label);

                Content dl = HtmlTree.DL(dt);

                dl.add(getClassLinks(LinkInfoImpl.Kind.SUBINTERFACES,

                        subInterfaces));

                classInfoTree.add(dl);

            }

        }

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void addInterfaceUsageInfo (Content classInfoTree) {

        if (!utils.isInterface(typeElement)) {

            return;

        }

        for (String s : suppressImplementingSet) {

            if (typeElement.getQualifiedName().contentEquals(s)) {

                return;    // Don't generate the list, too huge

            }

        }

        Set<TypeElement> implcl = classtree.implementingClasses(typeElement);

        if (!implcl.isEmpty()) {

            Content label = contents.implementingClassesLabel;

            Content dt = HtmlTree.DT(label);

            Content dl = HtmlTree.DL(dt);

            dl.add(getClassLinks(LinkInfoImpl.Kind.IMPLEMENTED_CLASSES,

                    implcl));

            classInfoTree.add(dl);

        }

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void addImplementedInterfacesInfo(Content classInfoTree) {

        SortedSet<TypeMirror> interfaces = new TreeSet<>(utils.makeTypeMirrorClassUseComparator());

        interfaces.addAll(utils.getAllInterfaces(typeElement));

        if (utils.isClass(typeElement) && !interfaces.isEmpty()) {

            Content label = contents.allImplementedInterfacesLabel;

            Content dt = HtmlTree.DT(label);

            Content dl = HtmlTree.DL(dt);

            dl.add(getClassLinks(LinkInfoImpl.Kind.IMPLEMENTED_INTERFACES, interfaces));

            classInfoTree.add(dl);

        }

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void addSuperInterfacesInfo(Content classInfoTree) {

        SortedSet<TypeMirror> interfaces =

                new TreeSet<>(utils.makeTypeMirrorIndexUseComparator());

        interfaces.addAll(utils.getAllInterfaces(typeElement));

        if (utils.isInterface(typeElement) && !interfaces.isEmpty()) {

            Content label = contents.allSuperinterfacesLabel;

            Content dt = HtmlTree.DT(label);

            Content dl = HtmlTree.DL(dt);

            dl.add(getClassLinks(LinkInfoImpl.Kind.SUPER_INTERFACES, interfaces));

            classInfoTree.add(dl);

        }

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void addNestedClassInfo(final Content classInfoTree) {

        Element outerClass = typeElement.getEnclosingElement();

        if (outerClass == null)

            return;

        new SimpleElementVisitor8<Void, Void>() {

            @Override

            public Void visitType(TypeElement e, Void p) {

                Content label = utils.isInterface(e)

                        ? contents.enclosingInterfaceLabel

                        : contents.enclosingClassLabel;

                Content dt = HtmlTree.DT(label);

                Content dl = HtmlTree.DL(dt);

                Content dd = new HtmlTree(HtmlTag.DD);

                dd.add(getLink(new LinkInfoImpl(configuration,

                        LinkInfoImpl.Kind.CLASS, e)));

                dl.add(dd);

                classInfoTree.add(dl);