HelpWriter.java

/*
 * Copyright (c) 1998, 2020, 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 jdk.javadoc.internal.doclets.formats.html.markup.BodyContents;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
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.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;


/**
 * Generate the Help File for the generated API documentation. The help file
 * contents are helpful for browsing the generated documentation.
 *
 *  <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 HelpWriter extends HtmlDocletWriter {

    private final Navigation navBar;

    private final String[][] SEARCH_EXAMPLES = {
            {"j.l.obj", "\"java.lang.Object\""},
            {"InpStr", "\"java.io.InputStream\""},
            {"HM.cK", "\"java.util.HashMap.containsKey(Object)\""}
    };

    /**
     * Constructor to construct HelpWriter object.
     * @param configuration the configuration
     * @param filename File to be generated.
     */
    public HelpWriter(HtmlConfiguration configuration,
                      DocPath filename) {
        super(configuration, filename);
        this.navBar = new Navigation(null, configuration, PageMode.HELP, path);
    }

    /**
     * Construct the HelpWriter object and then use it to generate the help
     * file. The name of the generated file is "help-doc.html". The help file
     * will get generated if and only if "-helpfile" and "-nohelp" is not used
     * on the command line.
     *
     * @param configuration the configuration
     * @throws DocFileIOException if there is a problem while generating the documentation
     */
    public static void generate(HtmlConfiguration configuration) throws DocFileIOException {
        DocPath filename = DocPaths.HELP_DOC;
        HelpWriter helpgen = new HelpWriter(configuration, filename);
        helpgen.generateHelpFile();
    }

    /**
     * Generate the help file contents.
     *
     * @throws DocFileIOException if there is a problem while generating the documentation
     */
    protected void generateHelpFile() throws DocFileIOException {
        String title = resources.getText("doclet.Window_Help_title");
        HtmlTree body = getBody(getWindowTitle(title));
        Content headerContent = new ContentBuilder();
        addTop(headerContent);
        navBar.setUserHeader(getUserHeaderFooter(true));
        headerContent.add(navBar.getContent(true));
        ContentBuilder helpFileContent = new ContentBuilder();
        addHelpFileContents(helpFileContent);
        HtmlTree footer = HtmlTree.FOOTER();
        navBar.setUserFooter(getUserHeaderFooter(false));
        footer.add(navBar.getContent(false));
        addBottom(footer);
        body.add(new BodyContents()
                .setHeader(headerContent)
                .addMainContent(helpFileContent)
                .setFooter(footer)
                .toContent());
        printHtmlDocument(null, "help", body);
    }

    /**
     * Add the help file contents from the resource file to the content tree. While adding the
     * help file contents it also keeps track of user options. If "-notree"
     * is used, then the "overview-tree.html" will not get added and hence
     * help information also will not get added.
     *
     * @param contentTree the content tree to which the help file contents will be added
     */
    protected void addHelpFileContents(Content contentTree) {
        // Heading
        Content heading = HtmlTree.HEADING(Headings.PAGE_TITLE_HEADING, false, HtmlStyle.title,
                contents.getContent("doclet.help.main_heading"));
        Content div = HtmlTree.DIV(HtmlStyle.header, heading);
        Content intro = HtmlTree.DIV(HtmlStyle.subTitle,
                contents.getContent("doclet.help.intro"));
        div.add(intro);
        contentTree.add(div);
        HtmlTree htmlTree;
        HtmlTree ul = new HtmlTree(HtmlTag.UL);
        ul.setStyle(HtmlStyle.blockList);

        // Overview
        if (options.createOverview()) {
            Content overviewHeading = HtmlTree.HEADING(Headings.CONTENT_HEADING,
                contents.overviewLabel);
            htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, overviewHeading);
            String overviewKey = configuration.showModules
                    ? "doclet.help.overview.modules.body"
                    : "doclet.help.overview.packages.body";
            Content overviewLink = links.createLink(
                    DocPaths.INDEX, resources.getText("doclet.Overview"));
            Content overviewBody = contents.getContent(overviewKey, overviewLink);
            Content overviewPara = HtmlTree.P(overviewBody);
            htmlTree.add(overviewPara);
            ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
        }

        // Module
        if (configuration.showModules) {
            Content moduleHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
                    contents.moduleLabel);
            htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, moduleHead);
            Content moduleIntro = contents.getContent("doclet.help.module.intro");
            Content modulePara = HtmlTree.P(moduleIntro);
            htmlTree.add(modulePara);
            HtmlTree ulModule = new HtmlTree(HtmlTag.UL);
            ulModule.add(HtmlTree.LI(contents.packagesLabel));
            ulModule.add(HtmlTree.LI(contents.modulesLabel));
            ulModule.add(HtmlTree.LI(contents.servicesLabel));
            htmlTree.add(ulModule);
            ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
        }

        // Package
        Content packageHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
                contents.packageLabel);
        htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, packageHead);
        Content packageIntro = contents.getContent("doclet.help.package.intro");
        Content packagePara = HtmlTree.P(packageIntro);
        htmlTree.add(packagePara);
        HtmlTree ulPackage = new HtmlTree(HtmlTag.UL);
        ulPackage.add(HtmlTree.LI(contents.interfaces));
        ulPackage.add(HtmlTree.LI(contents.classes));
        ulPackage.add(HtmlTree.LI(contents.enums));
        ulPackage.add(HtmlTree.LI(contents.exceptions));
        ulPackage.add(HtmlTree.LI(contents.errors));
        ulPackage.add(HtmlTree.LI(contents.annotationTypes));
        htmlTree.add(ulPackage);
        ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));

        // Class/interface
        Content classHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
                contents.getContent("doclet.help.class_interface.head"));
        htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, classHead);
        Content classIntro = contents.getContent("doclet.help.class_interface.intro");
        Content classPara = HtmlTree.P(classIntro);
        htmlTree.add(classPara);
        HtmlTree ul1 = new HtmlTree(HtmlTag.UL);
        ul1.add(HtmlTree.LI(contents.getContent("doclet.help.class_interface.inheritance_diagram")));
        ul1.add(HtmlTree.LI(contents.getContent("doclet.help.class_interface.subclasses")));
        ul1.add(HtmlTree.LI(contents.getContent("doclet.help.class_interface.subinterfaces")));
        ul1.add(HtmlTree.LI(contents.getContent("doclet.help.class_interface.implementations")));
        ul1.add(HtmlTree.LI(contents.getContent("doclet.help.class_interface.declaration")));
        ul1.add(HtmlTree.LI(contents.getContent("doclet.help.class_interface.description")));
        htmlTree.add(ul1);
        htmlTree.add(new HtmlTree(HtmlTag.BR));
        HtmlTree ul2 = new HtmlTree(HtmlTag.UL);
        ul2.add(HtmlTree.LI(contents.nestedClassSummary));
        ul2.add(HtmlTree.LI(contents.fieldSummaryLabel));
        ul2.add(HtmlTree.LI(contents.propertySummaryLabel));
        ul2.add(HtmlTree.LI(contents.constructorSummaryLabel));
        ul2.add(HtmlTree.LI(contents.methodSummary));
        htmlTree.add(ul2);
        htmlTree.add(new HtmlTree(HtmlTag.BR));
        HtmlTree ul3 = new HtmlTree(HtmlTag.UL);
        ul3.add(HtmlTree.LI(contents.fieldDetailsLabel));
        ul3.add(HtmlTree.LI(contents.propertyDetailsLabel));
        ul3.add(HtmlTree.LI(contents.constructorDetailsLabel));
        ul3.add(HtmlTree.LI(contents.methodDetailLabel));
        htmlTree.add(ul3);
        Content classSummary = contents.getContent("doclet.help.class_interface.summary");
        Content para = HtmlTree.P(classSummary);
        htmlTree.add(para);
        ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));

        // Annotation Types
        Content aHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
                contents.annotationType);
        htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, aHead);
        Content aIntro = contents.getContent("doclet.help.annotation_type.intro");
        Content aPara = HtmlTree.P(aIntro);
        htmlTree.add(aPara);
        HtmlTree aul = new HtmlTree(HtmlTag.UL);
        aul.add(HtmlTree.LI(contents.getContent("doclet.help.annotation_type.declaration")));
        aul.add(HtmlTree.LI(contents.getContent("doclet.help.annotation_type.description")));
        aul.add(HtmlTree.LI(contents.annotateTypeRequiredMemberSummaryLabel));
        aul.add(HtmlTree.LI(contents.annotateTypeOptionalMemberSummaryLabel));
        aul.add(HtmlTree.LI(contents.annotationTypeMemberDetail));
        htmlTree.add(aul);
        ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));

        // Enums
        Content enumHead = HtmlTree.HEADING(Headings.CONTENT_HEADING, contents.enum_);
        htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, enumHead);
        Content eIntro = contents.getContent("doclet.help.enum.intro");
        Content enumPara = HtmlTree.P(eIntro);
        htmlTree.add(enumPara);
        HtmlTree eul = new HtmlTree(HtmlTag.UL);
        eul.add(HtmlTree.LI(contents.getContent("doclet.help.enum.declaration")));
        eul.add(HtmlTree.LI(contents.getContent("doclet.help.enum.definition")));
        eul.add(HtmlTree.LI(contents.enumConstantSummary));
        eul.add(HtmlTree.LI(contents.enumConstantDetailLabel));
        htmlTree.add(eul);
        ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));

        // Class Use
        if (options.classUse()) {
            Content useHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
                    contents.getContent("doclet.help.use.head"));
            htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, useHead);
            Content useBody = contents.getContent("doclet.help.use.body");
            Content usePara = HtmlTree.P(useBody);
            htmlTree.add(usePara);
            ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
        }

        // Tree
        if (options.createTree()) {
            Content treeHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
                    contents.getContent("doclet.help.tree.head"));
            htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, treeHead);
            Content treeIntro = contents.getContent("doclet.help.tree.intro",
                    links.createLink(DocPaths.OVERVIEW_TREE,
                    resources.getText("doclet.Class_Hierarchy")),
                    HtmlTree.CODE(new StringContent("java.lang.Object")));
            Content treePara = HtmlTree.P(treeIntro);
            htmlTree.add(treePara);
            HtmlTree tul = new HtmlTree(HtmlTag.UL);
            tul.add(HtmlTree.LI(contents.getContent("doclet.help.tree.overview")));
            tul.add(HtmlTree.LI(contents.getContent("doclet.help.tree.package")));
            htmlTree.add(tul);
            ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
        }

        // Deprecated
        if (!(options.noDeprecatedList() || options.noDeprecated())) {
            Content dHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
                    contents.deprecatedAPI);
            htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, dHead);
            Content deprBody = contents.getContent("doclet.help.deprecated.body",
                    links.createLink(DocPaths.DEPRECATED_LIST,
                    resources.getText("doclet.Deprecated_API")));
            Content dPara = HtmlTree.P(deprBody);
            htmlTree.add(dPara);
            ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
        }

        // Index
        if (options.createIndex()) {
            Content indexlink;
            if (options.splitIndex()) {
                indexlink = links.createLink(DocPaths.INDEX_FILES.resolve(DocPaths.indexN(1)),
                        resources.getText("doclet.Index"));
            } else {
                indexlink = links.createLink(DocPaths.INDEX_ALL,
                        resources.getText("doclet.Index"));
            }
            Content indexHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
                    contents.getContent("doclet.help.index.head"));
            htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, indexHead);
            Content indexBody = contents.getContent("doclet.help.index.body", indexlink);
            Content indexPara = HtmlTree.P(indexBody);
            htmlTree.add(indexPara);
            ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
        }

        // Serialized Form
        Content sHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
                contents.serializedForm);
        htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, sHead);
        Content serialBody = contents.getContent("doclet.help.serial_form.body");
        Content serialPara = HtmlTree.P(serialBody);
        htmlTree.add(serialPara);
        ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));

        // Constant Field Values
        Content constHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
                contents.constantsSummaryTitle);
        htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, constHead);
        Content constantsBody = contents.getContent("doclet.help.constants.body",
                links.createLink(DocPaths.CONSTANT_VALUES,
                resources.getText("doclet.Constants_Summary")));
        Content constPara = HtmlTree.P(constantsBody);
        htmlTree.add(constPara);
        ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));

        // Search
        Content searchHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
                contents.getContent("doclet.help.search.head"));
        htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, searchHead);
        Content searchIntro = HtmlTree.P(contents.getContent("doclet.help.search.intro"));
        Content searchExamples = new HtmlTree(HtmlTag.UL);
        for (String[] example : SEARCH_EXAMPLES) {
            searchExamples.add(HtmlTree.LI(
                    contents.getContent("doclet.help.search.example",
                            HtmlTree.CODE(new StringContent(example[0])), example[1])));
        }
        Content searchSpecLink = HtmlTree.A(
                resources.getText("doclet.help.search.spec.url", Runtime.version().feature()),
                contents.getContent("doclet.help.search.spec.title"));
        Content searchRefer = HtmlTree.P(contents.getContent("doclet.help.search.refer", searchSpecLink));
        htmlTree.add(searchIntro);
        htmlTree.add(searchExamples);
        htmlTree.add(searchRefer);
        ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));

        contentTree.add(ul);
        contentTree.add(new HtmlTree(HtmlTag.HR));
        contentTree.add(HtmlTree.SPAN(HtmlStyle.emphasizedPhrase,
                contents.getContent("doclet.help.footnote")));
    }
}