/*

 * Copyright (c) 1998, 2017, 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.net.*;

import java.util.*;

import javax.lang.model.element.Element;

import javax.lang.model.element.PackageElement;

import javax.lang.model.element.TypeElement;

import javax.tools.JavaFileManager;

import javax.tools.JavaFileObject;

import javax.tools.StandardJavaFileManager;

import com.sun.source.util.DocTreePath;

import com.sun.tools.doclint.DocLint;

import jdk.javadoc.doclet.Doclet;

import jdk.javadoc.doclet.DocletEnvironment;

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

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

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

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

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

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

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

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

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

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

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

import static javax.tools.Diagnostic.Kind.*;

/**

 * Configure the output based on the command line options.

 * <p>

 * Also determine the length of the command line option. For example,

 * for a option "-header" there will be a string argument associated, then the

 * the length of option "-header" is two. But for option "-nohelp" no argument

 * is needed so it's length is 1.

 * </p>

 * <p>

 * Also do the error checking on the options used. For example it is illegal to

 * use "-helpfile" option when already "-nohelp" option is used.

 * </p>

 *

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

 *

 * @author Robert Field.

 * @author Atul Dambalkar.

 * @author Jamie Ho

 * @author Bhavesh Patel (Modified)

 */

public class HtmlConfiguration extends BaseConfiguration {

    /**

     * The build date.  Note: For now, we will use

     * a version number instead of a date.

     */

    public static final String BUILD_DATE = System.getProperty("java.version");

    /**

     * Argument for command line option "-header".

     */

    public String header = "";

    /**

     * Argument for command line option "-packagesheader".

     */

    public String packagesheader = "";

    /**

     * Argument for command line option "-footer".

     */

    public String footer = "";

    /**

     * Argument for command line option "-doctitle".

     */

    public String doctitle = "";

    /**

     * Argument for command line option "-windowtitle".

     */

    public String windowtitle = "";

    /**

     * Argument for command line option "-top".

     */

    public String top = "";

    /**

     * Argument for command line option "-bottom".

     */

    public String bottom = "";

    /**

     * Argument for command line option "-helpfile".

     */

    public String helpfile = "";

    /**

     * Argument for command line option "-stylesheetfile".

     */

    public String stylesheetfile = "";

    /**

     * Argument for command line option "-Xdocrootparent".

     */

    public String docrootparent = "";

    /**

     * True if command line option "-nohelp" is used. Default value is false.

     */

    public boolean nohelp = false;

    /**

     * True if command line option "-splitindex" is used. Default value is

     * false.

     */

    public boolean splitindex = false;

    /**

     * False if command line option "-noindex" is used. Default value is true.

     */

    public boolean createindex = true;

    /**

     * True if command line option "-use" is used. Default value is false.

     */

    public boolean classuse = false;

    /**

     * False if command line option "-notree" is used. Default value is true.

     */

    public boolean createtree = true;

    /**

     * True if command line option "-nodeprecated" is used. Default value is

     * false.

     */

    public boolean nodeprecatedlist = false;

    /**

     * True if command line option "-nonavbar" is used. Default value is false.

     */

    public boolean nonavbar = false;

    /**

     * True if command line option "-nooverview" is used. Default value is

     * false

     */

    private boolean nooverview = false;

    /**

     * The overview path specified with "-overview" flag.

     */

    public String overviewpath = null;

    /**

     * This is true if option "-overview" is used or option "-overview" is not

     * used and number of packages is more than one.

     */

    public boolean createoverview = false;

    /**

     * Specifies whether or not frames should be generated.

     * Defaults to true; can be set by --frames; can be set to false by --no-frames; last one wins.

     */

    public boolean frames = true;

    /**

     * This is the HTML version of the generated pages. HTML 4.01 is the default output version.

     */

    public HtmlVersion htmlVersion = HtmlVersion.HTML4;

    /**

     * Collected set of doclint options

     */

    public Map<Doclet.Option, String> doclintOpts = new LinkedHashMap<>();

    public final Resources resources;

    /**

     * First file to appear in the right-hand frame in the generated

     * documentation.

     */

    public DocPath topFile = DocPath.empty;

    /**

     * The TypeElement for the class file getting generated.

     */

    public TypeElement currentTypeElement = null;  // Set this TypeElement in the ClassWriter.

    protected List<SearchIndexItem> memberSearchIndex = new ArrayList<>();

    protected List<SearchIndexItem> moduleSearchIndex = new ArrayList<>();

    protected List<SearchIndexItem> packageSearchIndex = new ArrayList<>();

    protected List<SearchIndexItem> tagSearchIndex = new ArrayList<>();

    protected List<SearchIndexItem> typeSearchIndex = new ArrayList<>();

    protected Map<Character,List<SearchIndexItem>> tagSearchIndexMap = new HashMap<>();

    protected Set<Character> tagSearchIndexKeys;

    protected Contents contents;

    protected Messages messages;

    /**

     * Constructor. Initializes resource for the

     * {@link com.sun.tools.doclets.internal.toolkit.util.MessageRetriever MessageRetriever}.

     */

    public HtmlConfiguration(Doclet doclet) {

        super(doclet);

        resources = new Resources(this,

                BaseConfiguration.sharedResourceBundleName,

                "jdk.javadoc.internal.doclets.formats.html.resources.standard");

        messages = new Messages(this);

        contents = new Contents(this);

    }

    private final String versionRBName = "jdk.javadoc.internal.tool.resources.version";

    private ResourceBundle versionRB;

    /**

     * Return the build date for the doclet.

     * @return the build date

     */

    @Override

    public String getDocletSpecificBuildDate() {

        if (versionRB == null) {

            try {

                versionRB = ResourceBundle.getBundle(versionRBName, getLocale());

            } catch (MissingResourceException e) {

                return BUILD_DATE;

            }

        }

        try {

            return versionRB.getString("release");

        } catch (MissingResourceException e) {

            return BUILD_DATE;

        }

    }

    @Override

    public Resources getResources() {

        return resources;

    }

    @Override

    public Messages getMessages() {

        return messages;

    }

    protected boolean validateOptions() {

        // check shared options

        if (!generalValidOptions()) {

            return false;

        }

        // check if helpfile exists

        if (!helpfile.isEmpty()) {

            DocFile help = DocFile.createFileForInput(this, helpfile);

            if (!help.exists()) {

                reporter.print(ERROR, getText("doclet.File_not_found", helpfile));

                return false;

            }

        }

        // In a more object-oriented world, this would be done by methods on the Option objects.

        // Note that -windowtitle silently removes any and all HTML elements, and so does not need

        // to be handled here.

        utils.checkJavaScriptInOption("-header", header);

        utils.checkJavaScriptInOption("-footer", footer);

        utils.checkJavaScriptInOption("-top", top);

        utils.checkJavaScriptInOption("-bottom", bottom);

        utils.checkJavaScriptInOption("-doctitle", doctitle);

        utils.checkJavaScriptInOption("-packagesheader", packagesheader);

        return true;

    }

    @Override

    public boolean finishOptionSettings() {

        if (!validateOptions()) {

            return false;

        }

        if (!getSpecifiedTypeElements().isEmpty()) {

            Map<String, PackageElement> map = new HashMap<>();

            PackageElement pkg;

            for (TypeElement aClass : getIncludedTypeElements()) {

                pkg = utils.containingPackage(aClass);

                if (!map.containsKey(utils.getPackageName(pkg))) {

                    map.put(utils.getPackageName(pkg), pkg);

                }

            }

        }

        setCreateOverview();

        setTopFile(docEnv);

        workArounds.initDocLint(doclintOpts.values(), tagletManager.getCustomTagNames(),

                Utils.toLowerCase(htmlVersion.name()));

        return true;

    }

    /**

     * Return true if the generated output is HTML5.

     */

    public boolean isOutputHtml5() {

        return htmlVersion == HtmlVersion.HTML5;

    }

    /**

     * Return true if the tag is allowed for this specific version of HTML.

     */

    public boolean allowTag(HtmlTag htmlTag) {

        return htmlTag.allowTag(this.htmlVersion);

    }

    /**

     * Decide the page which will appear first in the right-hand frame. It will

     * be "overview-summary.html" if "-overview" option is used or no

     * "-overview" but the number of packages is more than one. It will be

     * "package-summary.html" of the respective package if there is only one

     * package to document. It will be a class page(first in the sorted order),

     * if only classes are provided on the command line.

     *

     * @param docEnv the doclet environment

     */

    protected void setTopFile(DocletEnvironment docEnv) {

        if (!checkForDeprecation(docEnv)) {

            return;

        }

        if (createoverview) {

            topFile = DocPaths.overviewSummary(frames);

        } else {

            if (showModules) {

                topFile = DocPath.empty.resolve(DocPaths.moduleSummary(modules.first()));

            } else if (packages.size() == 1 && packages.first().isUnnamed()) {

                List<TypeElement> classes = new ArrayList<>(getIncludedTypeElements());

                if (!classes.isEmpty()) {

                    TypeElement te = getValidClass(classes);

                    topFile = DocPath.forClass(utils, te);

                }

            } else if (!packages.isEmpty()) {

                topFile = DocPath.forPackage(packages.first()).resolve(DocPaths.PACKAGE_SUMMARY);

            }

        }

    }

    protected TypeElement getValidClass(List<TypeElement> classes) {

        if (!nodeprecated) {

            return classes.get(0);

        }

        for (TypeElement te : classes) {

            if (!utils.isDeprecated(te)) {

                return te;

            }

        }

        return null;

    }

    protected boolean checkForDeprecation(DocletEnvironment docEnv) {

        for (TypeElement te : getIncludedTypeElements()) {

            if (isGeneratedDoc(te)) {

                return true;

            }

        }

        return false;

    }

    /**

     * Generate "overview.html" page if option "-overview" is used or number of

     * packages is more than one. Sets {@link #createoverview} field to true.

     */

    protected void setCreateOverview() {

        if ((overviewpath != null || packages.size() > 1) && !nooverview) {

            createoverview = true;

        }

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public WriterFactory getWriterFactory() {

        return new WriterFactoryImpl(this);

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public Locale getLocale() {

        if (locale == null)

            return Locale.getDefault();

        return locale;

    }

    /**

     * Return the path of the overview file or null if it does not exist.

     *

     * @return the path of the overview file or null if it does not exist.

     */

    @Override

    public JavaFileObject getOverviewPath() {

        if (overviewpath != null && getFileManager() instanceof StandardJavaFileManager) {

            StandardJavaFileManager fm = (StandardJavaFileManager) getFileManager();

            return fm.getJavaFileObjects(overviewpath).iterator().next();

        }

        return null;

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public JavaFileManager getFileManager() {

        return docEnv.getJavaFileManager();

    }

    @Override

    public boolean showMessage(DocTreePath path, String key) {

        return (path == null || workArounds.haveDocLint());

    }

    @Override

    public boolean showMessage(Element e, String key) {

        return (e == null || workArounds.haveDocLint());

    }

    @Override

    public String getText(String key) {

        return resources.getText(key);

    }

    @Override

    public String getText(String key, String... args) {

        return resources.getText(key, (Object[]) args);

    }

   /**

     * {@inheritdoc}

     */

    @Override

    public Content getContent(String key) {

        return contents.getContent(key);

    }

    /**

     * Get the configuration string as a content.

     *

     * @param key the key to look for in the configuration file

     * @param o   string or content argument added to configuration text

     * @return a content tree for the text

     */

    @Override

    public Content getContent(String key, Object o) {

        return contents.getContent(key, o);

    }

    /**

     * Get the configuration string as a content.

     *

     * @param key the key to look for in the configuration file

     * @param o1 resource argument

     * @param o2 resource argument

     * @return a content tree for the text

     */