/*

 * Copyright (c) 1997, 2015, 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 com.sun.tools.doclets.formats.html.markup;

import java.io.*;

import java.util.*;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

import com.sun.tools.doclets.internal.toolkit.*;

import com.sun.tools.doclets.internal.toolkit.util.*;

/**

 * Class for the Html format code generation.

 * Initializes PrintWriter with FileWriter, to enable print

 * related methods to generate the code to the named File through FileWriter.

 *

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

 *

 * @since 1.2

 * @author Atul M Dambalkar

 * @author Bhavesh Patel (Modified)

 */

public class HtmlWriter {

    /**

     * The window title of this file

     */

    protected String winTitle;

    /**

     * The configuration

     */

    protected Configuration configuration;

    /**

     * The flag to indicate whether a member details list is printed or not.

     */

    protected boolean memberDetailsListPrinted;

    /**

     * Header for table displaying profiles and description..

     */

    protected final String[] profileTableHeader;

    /**

     * Header for tables displaying packages and description..

     */

    protected final String[] packageTableHeader;

    /**

     * Summary for use tables displaying class and package use.

     */

    protected final String useTableSummary;

    /**

     * Column header for class docs displaying Modifier and Type header.

     */

    protected final String modifierTypeHeader;

    public final Content overviewLabel;

    public final Content defaultPackageLabel;

    public final Content packageLabel;

    public final Content profileLabel;

    public final Content useLabel;

    public final Content prevLabel;

    public final Content nextLabel;

    public final Content prevclassLabel;

    public final Content nextclassLabel;

    public final Content summaryLabel;

    public final Content detailLabel;

    public final Content framesLabel;

    public final Content noframesLabel;

    public final Content treeLabel;

    public final Content classLabel;

    public final Content deprecatedLabel;

    public final Content deprecatedPhrase;

    public final Content allclassesLabel;

    public final Content allpackagesLabel;

    public final Content allprofilesLabel;

    public final Content indexLabel;

    public final Content helpLabel;

    public final Content seeLabel;

    public final Content descriptionLabel;

    public final Content prevpackageLabel;

    public final Content nextpackageLabel;

    public final Content prevprofileLabel;

    public final Content nextprofileLabel;

    public final Content packagesLabel;

    public final Content profilesLabel;

    public final Content methodDetailsLabel;

    public final Content annotationTypeDetailsLabel;

    public final Content fieldDetailsLabel;

    public final Content propertyDetailsLabel;

    public final Content constructorDetailsLabel;

    public final Content enumConstantsDetailsLabel;

    public final Content specifiedByLabel;

    public final Content overridesLabel;

    public final Content descfrmClassLabel;

    public final Content descfrmInterfaceLabel;

    private final Writer writer;

    private Content script;

    /**

     * Constructor.

     *

     * @param path The directory path to be created for this file

     *             or null if none to be created.

     * @exception IOException Exception raised by the FileWriter is passed on

     * to next level.

     * @exception UnsupportedEncodingException Exception raised by the

     * OutputStreamWriter is passed on to next level.

     */

    public HtmlWriter(Configuration configuration, DocPath path)

            throws IOException, UnsupportedEncodingException {

        writer = DocFile.createFileForOutput(configuration, path).openWriter();

        this.configuration = configuration;

        this.memberDetailsListPrinted = false;

        profileTableHeader = new String[] {

            configuration.getText("doclet.Profile"),

            configuration.getText("doclet.Description")

        };

        packageTableHeader = new String[] {

            configuration.getText("doclet.Package"),

            configuration.getText("doclet.Description")

        };

        useTableSummary = configuration.getText("doclet.Use_Table_Summary",

                configuration.getText("doclet.packages"));

        modifierTypeHeader = configuration.getText("doclet.0_and_1",

                configuration.getText("doclet.Modifier"),

                configuration.getText("doclet.Type"));

        overviewLabel = getResource("doclet.Overview");

        defaultPackageLabel = new StringContent(DocletConstants.DEFAULT_PACKAGE_NAME);

        packageLabel = getResource("doclet.Package");

        profileLabel = getResource("doclet.Profile");

        useLabel = getResource("doclet.navClassUse");

        prevLabel = getResource("doclet.Prev");

        nextLabel = getResource("doclet.Next");

        prevclassLabel = getNonBreakResource("doclet.Prev_Class");

        nextclassLabel = getNonBreakResource("doclet.Next_Class");

        summaryLabel = getResource("doclet.Summary");

        detailLabel = getResource("doclet.Detail");

        framesLabel = getResource("doclet.Frames");

        noframesLabel = getNonBreakResource("doclet.No_Frames");

        treeLabel = getResource("doclet.Tree");

        classLabel = getResource("doclet.Class");

        deprecatedLabel = getResource("doclet.navDeprecated");

        deprecatedPhrase = getResource("doclet.Deprecated");

        allclassesLabel = getNonBreakResource("doclet.All_Classes");

        allpackagesLabel = getNonBreakResource("doclet.All_Packages");

        allprofilesLabel = getNonBreakResource("doclet.All_Profiles");

        indexLabel = getResource("doclet.Index");

        helpLabel = getResource("doclet.Help");

        seeLabel = getResource("doclet.See");

        descriptionLabel = getResource("doclet.Description");

        prevpackageLabel = getNonBreakResource("doclet.Prev_Package");

        nextpackageLabel = getNonBreakResource("doclet.Next_Package");

        prevprofileLabel = getNonBreakResource("doclet.Prev_Profile");

        nextprofileLabel = getNonBreakResource("doclet.Next_Profile");

        packagesLabel = getResource("doclet.Packages");

        profilesLabel = getResource("doclet.Profiles");

        methodDetailsLabel = getResource("doclet.Method_Detail");

        annotationTypeDetailsLabel = getResource("doclet.Annotation_Type_Member_Detail");

        fieldDetailsLabel = getResource("doclet.Field_Detail");

        propertyDetailsLabel = getResource("doclet.Property_Detail");

        constructorDetailsLabel = getResource("doclet.Constructor_Detail");

        enumConstantsDetailsLabel = getResource("doclet.Enum_Constant_Detail");

        specifiedByLabel = getResource("doclet.Specified_By");

        overridesLabel = getResource("doclet.Overrides");

        descfrmClassLabel = getResource("doclet.Description_From_Class");

        descfrmInterfaceLabel = getResource("doclet.Description_From_Interface");

    }

    public void write(Content c) throws IOException {

        c.write(writer, true);

    }

    public void close() throws IOException {

        writer.close();

    }

    /**

     * Get the configuration string as a content.

     *

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

     * @return a content tree for the text

     */

    public Content getResource(String key) {

        return configuration.getResource(key);

    }

    /**

     * Get the configuration string as a content, replacing spaces

     * with non-breaking spaces.

     *

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

     * @return a content tree for the text

     */

    public Content getNonBreakResource(String key) {

        String text = configuration.getText(key);

        Content c = configuration.newContent();

        int start = 0;

        int p;

        while ((p = text.indexOf(" ", start)) != -1) {

            c.addContent(text.substring(start, p));

            c.addContent(RawHtml.nbsp);

            start = p + 1;

        }

        c.addContent(text.substring(start));

        return c;

    }

    /**

     * 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

     */

    public Content getResource(String key, Object o) {

        return configuration.getResource(key, o);

    }

    /**

     * Get the configuration string as a content.

     *

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

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

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

     * @return a content tree for the text

     */

    public Content getResource(String key, Object o0, Object o1) {

        return configuration.getResource(key, o0, o1);

    }

    /**

     * Returns an HtmlTree for the SCRIPT tag.

     *

     * @return an HtmlTree for the SCRIPT tag

     */

    protected HtmlTree getWinTitleScript(){

        HtmlTree script = HtmlTree.SCRIPT();

        if(winTitle != null && winTitle.length() > 0) {

            String scriptCode = "<!--" + DocletConstants.NL +

                    "    try {" + DocletConstants.NL +

                    "        if (location.href.indexOf('is-external=true') == -1) {" + DocletConstants.NL +

                    "            parent.document.title=\"" + escapeJavaScriptChars(winTitle) + "\";" + DocletConstants.NL +

                    "        }" + DocletConstants.NL +

                    "    }" + DocletConstants.NL +

                    "    catch(err) {" + DocletConstants.NL +

                    "    }" + DocletConstants.NL +

                    "//-->" + DocletConstants.NL;

            RawHtml scriptContent = new RawHtml(scriptCode);

            script.addContent(scriptContent);

        }

        return script;

    }

    /**

     * Returns a String with escaped special JavaScript characters.

     *

     * @param s String that needs to be escaped

     * @return a valid escaped JavaScript string

     */

    private static String escapeJavaScriptChars(String s) {

        StringBuilder sb = new StringBuilder();

        for (int i = 0; i < s.length(); i++) {

            char ch = s.charAt(i);

            switch (ch) {

                case '\b':

                    sb.append("\\b");

                    break;

                case '\t':

                    sb.append("\\t");

                    break;

                case '\n':

                    sb.append("\\n");

                    break;

                case '\f':

                    sb.append("\\f");

                    break;

                case '\r':

                    sb.append("\\r");

                    break;

                case '"':

                    sb.append("\\\"");

                    break;

                case '\'':

                    sb.append("\\\'");

                    break;

                case '\\':

                    sb.append("\\\\");

                    break;

                default:

                    if (ch < 32 || ch >= 127) {

                        sb.append(String.format("\\u%04X", (int)ch));

                    } else {

                        sb.append(ch);

                    }

                    break;

            }

        }

        return sb.toString();

    }

    /**

     * Returns a content tree for the SCRIPT tag for the main page(index.html).

     *

     * @return a content for the SCRIPT tag

     */

    protected Content getFramesJavaScript() {

        HtmlTree script = HtmlTree.SCRIPT();

        String scriptCode = DocletConstants.NL +

                "    targetPage = \"\" + window.location.search;" + DocletConstants.NL +

                "    if (targetPage != \"\" && targetPage != \"undefined\")" + DocletConstants.NL +

                "        targetPage = targetPage.substring(1);" + DocletConstants.NL +

                "    if (targetPage.indexOf(\":\") != -1 || (targetPage != \"\" && !validURL(targetPage)))" + DocletConstants.NL +

                "        targetPage = \"undefined\";" + DocletConstants.NL +

                "    function validURL(url) {" + DocletConstants.NL +

                "        try {" + DocletConstants.NL +

                "            url = decodeURIComponent(url);" + DocletConstants.NL +

                "        }" + DocletConstants.NL +

                "        catch (error) {" + DocletConstants.NL +

                "            return false;" + DocletConstants.NL +

                "        }" + DocletConstants.NL +

                "        var pos = url.indexOf(\".html\");" + DocletConstants.NL +

                "        if (pos == -1 || pos != url.length - 5)" + DocletConstants.NL +

                "            return false;" + DocletConstants.NL +

                "        var allowNumber = false;" + DocletConstants.NL +

                "        var allowSep = false;" + DocletConstants.NL +

                "        var seenDot = false;" + DocletConstants.NL +

                "        for (var i = 0; i < url.length - 5; i++) {" + DocletConstants.NL +

                "            var ch = url.charAt(i);" + DocletConstants.NL +

                "            if ('a' <= ch && ch <= 'z' ||" + DocletConstants.NL +

                "                    'A' <= ch && ch <= 'Z' ||" + DocletConstants.NL +

                "                    ch == '$' ||" + DocletConstants.NL +

                "                    ch == '_' ||" + DocletConstants.NL +

                "                    ch.charCodeAt(0) > 127) {" + DocletConstants.NL +

                "                allowNumber = true;" + DocletConstants.NL +

                "                allowSep = true;" + DocletConstants.NL +

                "            } else if ('0' <= ch && ch <= '9'" + DocletConstants.NL +

                "                    || ch == '-') {" + DocletConstants.NL +

                "                if (!allowNumber)" + DocletConstants.NL +

                "                     return false;" + DocletConstants.NL +

                "            } else if (ch == '/' || ch == '.') {" + DocletConstants.NL +

                "                if (!allowSep)" + DocletConstants.NL +

                "                    return false;" + DocletConstants.NL +

                "                allowNumber = false;" + DocletConstants.NL +

                "                allowSep = false;" + DocletConstants.NL +

                "                if (ch == '.')" + DocletConstants.NL +

                "                     seenDot = true;" + DocletConstants.NL +

                "                if (ch == '/' && seenDot)" + DocletConstants.NL +

                "                     return false;" + DocletConstants.NL +

                "            } else {" + DocletConstants.NL +

                "                return false;"+ DocletConstants.NL +

                "            }" + DocletConstants.NL +

                "        }" + DocletConstants.NL +

                "        return true;" + DocletConstants.NL +

                "    }" + DocletConstants.NL;

        RawHtml scriptContent = new RawHtml(scriptCode);

        script.addContent(scriptContent);

        return script;

    }

    /**

     * Returns an HtmlTree for the BODY tag.

     *

     * @param includeScript  set true if printing windowtitle script

     * @param title title for the window

     * @return an HtmlTree for the BODY tag

     */

    public HtmlTree getBody(boolean includeScript, String title) {

        HtmlTree body = new HtmlTree(HtmlTag.BODY);

        // Set window title string which is later printed

        this.winTitle = title;

        // Don't print windowtitle script for overview-frame, allclasses-frame

        // and package-frame

        if (includeScript) {

            this.script = getWinTitleScript();

            body.addContent(script);

            Content noScript = HtmlTree.NOSCRIPT(

                    HtmlTree.DIV(getResource("doclet.No_Script_Message")));

            body.addContent(noScript);

        }

        return body;

    }

    /**

     * Generated javascript variables for the document.

     *

     * @param typeMap map comprising of method and type relationship

     * @param methodTypes set comprising of all methods types for this class

     */

    public void generateMethodTypesScript(Map<String,Integer> typeMap,

            Set<MethodTypes> methodTypes) {

        String sep = "";

        StringBuilder vars = new StringBuilder("var methods = {");

        for (Map.Entry<String,Integer> entry : typeMap.entrySet()) {

            vars.append(sep);

            sep = ",";

        }

        vars.append("};").append(DocletConstants.NL);

        sep = "";

        vars.append("var tabs = {");

        for (MethodTypes entry : methodTypes) {

            vars.append(sep);

            sep = ",";

        }

        addStyles(HtmlStyle.altColor, vars);