/*

 * Copyright (c) 2018, 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.markup;

import java.util.ArrayDeque;

import java.util.ArrayList;

import java.util.Deque;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.SortedSet;

import javax.lang.model.element.Element;

import javax.lang.model.element.ElementKind;

import javax.lang.model.element.ModuleElement;

import javax.lang.model.element.PackageElement;

import javax.lang.model.element.TypeElement;

import jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter;

import jdk.javadoc.internal.doclets.formats.html.Contents;

import jdk.javadoc.internal.doclets.formats.html.HtmlConfiguration;

import jdk.javadoc.internal.doclets.formats.html.MarkerComments;

import jdk.javadoc.internal.doclets.formats.html.SectionName;

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

import jdk.javadoc.internal.doclets.toolkit.builders.MemberSummaryBuilder;

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

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

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

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

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

import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.*;

/**

 * Factory for navigation bar.

 *

 * <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 class Navigation {

    private final HtmlConfiguration configuration;

    private final Element element;

    private final Contents contents;

    private final DocPath path;

    private final DocPath pathToRoot;

    private final Links links;

    private final PageMode documentedPage;

    private Content navLinkModule;

    private Content navLinkPackage;

    private Content navLinkClass;

    private MemberSummaryBuilder memberSummaryBuilder;

    private boolean displaySummaryModuleDescLink;

    private boolean displaySummaryModulesLink;

    private boolean displaySummaryPackagesLink;

    private boolean displaySummaryServicesLink;

    private final Map<Position, Deque<Content>> topBottomNavContents;

    private Content userHeader;

    private Content userFooter;

    private final String rowListTitle;

    private final Content searchLabel;

    public enum PageMode {

        ALLCLASSES,

        ALLPACKAGES,

        CLASS,

        CONSTANTVALUES,

        DEPRECATED,

        DOCFILE,

        HELP,

        INDEX,

        MODULE,

        OVERVIEW,

        PACKAGE,

        SERIALIZEDFORM,

        TREE,

        USE;

    }

    enum Position {

        BOTTOM(MarkerComments.START_OF_BOTTOM_NAVBAR, MarkerComments.END_OF_BOTTOM_NAVBAR),

        TOP(MarkerComments.START_OF_TOP_NAVBAR, MarkerComments.END_OF_TOP_NAVBAR);

        final Content startOfNav;

        final Content endOfNav;

        Position(Content startOfNav, Content endOfNav) {

            this.startOfNav = startOfNav;

            this.endOfNav = endOfNav;

        }

        Content startOfNav() {

            return startOfNav;

        }

        Content endOfNav() {

            return endOfNav;

        }

    }

    /**

     * Creates a {@code Navigation} object for a specific file, to be written in a specific HTML

     * version.

     *

     * @param element element being documented. null if its not an element documentation page

     * @param configuration the configuration object

     * @param page the kind of page being documented

     * @param path the DocPath object

     */

        this.configuration = configuration;

        this.element = element;

        this.contents = configuration.contents;

        this.documentedPage = page;

        this.path = path;

        this.pathToRoot = path.parent().invert();

        this.links = new Links(path);

        this.topBottomNavContents = new HashMap<>();

        this.rowListTitle = configuration.getResources().getText("doclet.Navigation");

        this.searchLabel = contents.getContent("doclet.search");

        populateNavContents(Position.TOP);

        populateNavContents(Position.BOTTOM);

    }

    /**

     * Populate the navigation contents for top and bottom navigation

     *

     * @param position the position of the navigation bar on the page

     */

    private void populateNavContents(Position position) {

        Deque<Content> queue = new ArrayDeque<>();

        Content skipNavLinks = contents.getContent("doclet.Skip_navigation_links");

        switch (position) {

            case TOP:

                queue.addLast(links.createAnchor(SectionName.NAVBAR_TOP));

                queue.addLast(links.createLink(SectionName.SKIP_NAVBAR_TOP, skipNavLinks,

                        skipNavLinks.toString(), ""));

                queue.addLast(links.createAnchor(SectionName.NAVBAR_TOP_FIRSTROW));

                queue.addLast(links.createAnchor(SectionName.SKIP_NAVBAR_TOP));

                topBottomNavContents.put(position, queue);

                break;

            case BOTTOM:

                queue.addLast(links.createAnchor(SectionName.NAVBAR_BOTTOM));

                queue.addLast(links.createLink(SectionName.SKIP_NAVBAR_BOTTOM, skipNavLinks,

                        skipNavLinks.toString(), ""));

                queue.addLast(links.createAnchor(SectionName.NAVBAR_BOTTOM_FIRSTROW));

                queue.addLast(links.createAnchor(SectionName.SKIP_NAVBAR_BOTTOM));

                topBottomNavContents.put(position, queue);

                break;

            default:

                break;

        }

    }

    public Navigation setNavLinkModule(Content navLinkModule) {

        this.navLinkModule = navLinkModule;

        return this;

    }

    public Navigation setNavLinkPackage(Content navLinkPackage) {

        this.navLinkPackage = navLinkPackage;

        return this;

    }

    public Navigation setNavLinkClass(Content navLinkClass) {

        this.navLinkClass = navLinkClass;

        return this;

    }

    public Navigation setMemberSummaryBuilder(MemberSummaryBuilder memberSummaryBuilder) {

        this.memberSummaryBuilder = memberSummaryBuilder;

        return this;

    }

    public Navigation setDisplaySummaryModuleDescLink(boolean displaySummaryModuleDescLink) {

        this.displaySummaryModuleDescLink = displaySummaryModuleDescLink;

        return this;

    }

    public Navigation setDisplaySummaryModulesLink(boolean displaySummaryModulesLink) {

        this.displaySummaryModulesLink = displaySummaryModulesLink;

        return this;

    }

    public Navigation setDisplaySummaryPackagesLink(boolean displaySummaryPackagesLink) {

        this.displaySummaryPackagesLink = displaySummaryPackagesLink;

        return this;

    }

    public Navigation setDisplaySummaryServicesLink(boolean displaySummaryServicesLink) {

        this.displaySummaryServicesLink = displaySummaryServicesLink;

        return this;

    }

    public Navigation setUserHeader(Content userHeader) {

        this.userHeader = userHeader;

        return this;

    }

    public Navigation setUserFooter(Content userFooter) {

        this.userFooter = userFooter;

        return this;

    }

    /**

     * Add the links for the main navigation.

     *

     * @param tree the content tree to which the main navigation will added

     */

    private void addMainNavLinks(Content tree) {

        switch (documentedPage) {

            case OVERVIEW:

                addActivePageLink(tree, contents.overviewLabel, configuration.createoverview);

                addModuleLink(tree);

                addPackageLink(tree);

                addPageLabel(tree, contents.classLabel, true);

                addPageLabel(tree, contents.useLabel, configuration.classuse);

                addTreeLink(tree);

                addDeprecatedLink(tree);

                addIndexLink(tree);

                addHelpLink(tree);

                break;

            case MODULE:

                addOverviewLink(tree);

                addActivePageLink(tree, contents.moduleLabel, configuration.showModules);

                addPackageLink(tree);

                addPageLabel(tree, contents.classLabel, true);

                addPageLabel(tree, contents.useLabel, configuration.classuse);

                addTreeLink(tree);

                addDeprecatedLink(tree);

                addIndexLink(tree);

                addHelpLink(tree);

                break;

            case PACKAGE:

                addOverviewLink(tree);

                addModuleOfElementLink(tree);

                addActivePageLink(tree, contents.packageLabel, true);

                addPageLabel(tree, contents.classLabel, true);

                if (configuration.classuse) {

                    addContentToTree(tree, links.createLink(DocPaths.PACKAGE_USE,

                            contents.useLabel, "", ""));

                }

                if (configuration.createtree) {

                    addContentToTree(tree, links.createLink(DocPaths.PACKAGE_TREE,

                            contents.treeLabel, "", ""));

                }

                addDeprecatedLink(tree);

                addIndexLink(tree);

                addHelpLink(tree);

                break;

            case CLASS:

                addOverviewLink(tree);

                addModuleOfElementLink(tree);

                addPackageSummaryLink(tree);

                addActivePageLink(tree, contents.classLabel, true);

                if (configuration.classuse) {

                    addContentToTree(tree, links.createLink(DocPaths.CLASS_USE.resolve(path.basename()),

                            contents.useLabel));

                }

                if (configuration.createtree) {

                    addContentToTree(tree, links.createLink(DocPaths.PACKAGE_TREE,

                            contents.treeLabel, "", ""));

                }

                addDeprecatedLink(tree);

                addIndexLink(tree);

                addHelpLink(tree);

                break;

            case USE:

                addOverviewLink(tree);

                addModuleOfElementLink(tree);

                if (element instanceof PackageElement) {

                    addPackageSummaryLink(tree);

                    addPageLabel(tree, contents.classLabel, true);

                } else {

                    addPackageOfElementLink(tree);

                    addContentToTree(tree, navLinkClass);

                }

                addActivePageLink(tree, contents.useLabel, configuration.classuse);

                if (element instanceof PackageElement) {

                    addContentToTree(tree, links.createLink(DocPaths.PACKAGE_TREE, contents.treeLabel));

                } else {

                    addContentToTree(tree, configuration.utils.isEnclosingPackageIncluded((TypeElement) element)

                            ? links.createLink(DocPath.parent.resolve(DocPaths.PACKAGE_TREE), contents.treeLabel)

                            : links.createLink(pathToRoot.resolve(DocPaths.OVERVIEW_TREE), contents.treeLabel));

                }

                addDeprecatedLink(tree);

                addIndexLink(tree);

                addHelpLink(tree);

                break;

            case TREE:

                addOverviewLink(tree);

                if (element == null) {

                    addPageLabel(tree, contents.moduleLabel, configuration.showModules);

                    addPageLabel(tree, contents.packageLabel, true);

                } else {

                    addModuleOfElementLink(tree);

                    addPackageSummaryLink(tree);

                }

                addPageLabel(tree, contents.classLabel, true);

                addPageLabel(tree, contents.useLabel, configuration.classuse);

                addActivePageLink(tree, contents.treeLabel, configuration.createtree);

                addDeprecatedLink(tree);

                addIndexLink(tree);

                addHelpLink(tree);

                break;

            case DEPRECATED:

            case INDEX:

            case HELP:

                addOverviewLink(tree);

                addModuleLink(tree);

                addPackageLink(tree);

                addPageLabel(tree, contents.classLabel, true);

                addPageLabel(tree, contents.useLabel, configuration.classuse);

                addTreeLink(tree);

                if (documentedPage == PageMode.DEPRECATED) {

                    addActivePageLink(tree, contents.deprecatedLabel, !(configuration.nodeprecated

                            || configuration.nodeprecatedlist));

                } else {

                    addDeprecatedLink(tree);

                }

                if (documentedPage == PageMode.INDEX) {

                    addActivePageLink(tree, contents.indexLabel, configuration.createindex);

                } else {

                    addIndexLink(tree);

                }

                if (documentedPage == PageMode.HELP) {

                    addActivePageLink(tree, contents.helpLabel, !configuration.nohelp);

                } else {

                    addHelpLink(tree);

                }

                break;

            case ALLCLASSES:

            case ALLPACKAGES:

            case CONSTANTVALUES:

            case SERIALIZEDFORM:

                addOverviewLink(tree);

                addModuleLink(tree);

                addPackageLink(tree);

                addPageLabel(tree, contents.classLabel, true);

                addPageLabel(tree, contents.useLabel, configuration.classuse);

                addTreeLink(tree);

                addDeprecatedLink(tree);

                addIndexLink(tree);

                addHelpLink(tree);

                break;

            case DOCFILE:

                addOverviewLink(tree);

                addModuleOfElementLink(tree);

                addContentToTree(tree, navLinkPackage);

                addPageLabel(tree, contents.classLabel, true);

                addPageLabel(tree, contents.useLabel, configuration.classuse);

                addTreeLink(tree);

                addDeprecatedLink(tree);

                addIndexLink(tree);

                addHelpLink(tree);

                break;

            default:

                break;

        }

    }

    /**

     * Add the summary links to the sub-navigation.

     *

     * @param tree the content tree to which the sub-navigation will added

     */

    private void addSummaryLinks(Content tree) {

        List<Content> listContents = new ArrayList<>();

        switch (documentedPage) {

            case CLASS:

                if (element.getKind() == ElementKind.ANNOTATION_TYPE) {

                    addAnnotationTypeSummaryLink("doclet.navField",

                            ANNOTATION_TYPE_FIELDS, listContents);

                    addAnnotationTypeSummaryLink("doclet.navAnnotationTypeRequiredMember",

                            ANNOTATION_TYPE_MEMBER_REQUIRED, listContents);

                    addAnnotationTypeSummaryLink("doclet.navAnnotationTypeOptionalMember",

                            ANNOTATION_TYPE_MEMBER_OPTIONAL, listContents);

                } else {

                    TypeElement typeElement = (TypeElement) element;

                    for (VisibleMemberTable.Kind kind : summarySet) {

                        if (kind == ENUM_CONSTANTS && !configuration.utils.isEnum(typeElement)) {

                            continue;

                        }

                        if (kind == CONSTRUCTORS && configuration.utils.isEnum(typeElement)) {

                            continue;

                        }

                        AbstractMemberWriter writer

                                = ((AbstractMemberWriter) memberSummaryBuilder.getMemberSummaryWriter(kind));

                        if (writer == null) {

                            addContentToList(listContents, contents.getNavLinkLabelContent(kind));

                        } else {

                            addTypeSummaryLink(memberSummaryBuilder.members(kind),

                                    memberSummaryBuilder.getVisibleMemberTable(),

                                    kind, listContents);

                        }

                    }

                }

                if (!listContents.isEmpty()) {

                    Content li = HtmlTree.LI(contents.summaryLabel);

                    li.add(Entity.NO_BREAK_SPACE);

                    tree.add(li);

                    addListToNav(listContents, tree);

                }

                break;

            case MODULE:

                if (displaySummaryModuleDescLink) {

                    addContentToList(listContents,

                            links.createLink(SectionName.MODULE_DESCRIPTION, contents.navModuleDescription));

                } else {

                    addContentToList(listContents, contents.navModuleDescription);

                }

                if (displaySummaryModulesLink) {

                    addContentToList(listContents,

                            links.createLink(SectionName.MODULES, contents.navModules));

                } else {

                    addContentToList(listContents, contents.navModules);

                }

                if (displaySummaryPackagesLink) {

                    addContentToList(listContents,

                            links.createLink(SectionName.PACKAGES, contents.navPackages));

                } else {

                    addContentToList(listContents, contents.navPackages);

                }

                if (displaySummaryServicesLink) {

                    addContentToList(listContents,

                            links.createLink(SectionName.SERVICES, contents.navServices));

                } else {

                    addContentToList(listContents, contents.navServices);

                }

                if (!listContents.isEmpty()) {

                    Content li = HtmlTree.LI(contents.moduleSubNavLabel);

                    li.add(Entity.NO_BREAK_SPACE);

                    tree.add(li);

                    addListToNav(listContents, tree);

                }

                break;

            default:

                break;

        }

    }

    /**

     * Add the navigation summary link.

     *

     * @param members members to be linked

     * @param vmt the visible member table

     * @param kind the visible member kind

     * @param listContents the list of contents

     */

    private void addTypeSummaryLink(SortedSet<? extends Element> members,

            VisibleMemberTable vmt,

            VisibleMemberTable.Kind kind, List<Content> listContents) {

        if (!members.isEmpty()) {

            addTypeSummaryLink(null, kind, true, listContents);

            return;

        }

        Set<TypeElement> visibleClasses = vmt.getVisibleTypeElements();

        for (TypeElement t : visibleClasses) {

            if (configuration.getVisibleMemberTable(t).hasVisibleMembers(kind)) {

                addTypeSummaryLink(null, kind, true, listContents);

                return;

            }

        }

        addTypeSummaryLink(null, kind, false, listContents);

    }

    /**

     * Add the navigation Type summary link.

     *

     * @param typeElement the Type being documented

     * @param kind the kind of member being documented

     * @param link true if the members are listed and need to be linked

     * @param listContents the list of contents to which the summary will be added

     */

    private void addTypeSummaryLink(TypeElement typeElement, VisibleMemberTable.Kind kind, boolean link,

            List<Content> listContents) {

        switch (kind) {

            case CONSTRUCTORS:

                if (link) {

                    addContentToList(listContents, links.createLink(SectionName.CONSTRUCTOR_SUMMARY,

                            contents.navConstructor));

                } else {

                    addContentToList(listContents, contents.navConstructor);

                }

                break;

            case ENUM_CONSTANTS:

                if (link) {

                    if (typeElement == null) {

                        addContentToList(listContents, links.createLink(SectionName.ENUM_CONSTANT_SUMMARY,

                                contents.navEnum));

                    } else {

                        addContentToList(listContents, links.createLink(

                                SectionName.ENUM_CONSTANTS_INHERITANCE,

                                configuration.getClassName(typeElement), contents.navEnum));

                    }

                } else {

                    addContentToList(listContents, contents.navEnum);