/*

 * Copyright (c) 1997, 2012, 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 com.sun.tools.doclets.internal.toolkit.*;

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

/**

 * Class for the Html format code generation.

 * Initilizes PrintWriter with FileWriter, to enable print

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

 *

 * @since 1.2

 * @author Atul M Dambalkar

 * @author Bhavesh Patel (Modified)

 */

public class HtmlWriter extends PrintWriter {

    /**

     * Name of the file, to which this writer is writing to.

     */

    protected final String htmlFilename;

    /**

     * The window title of this file

     */

    protected String winTitle;

    /**

     * URL file separator string("/").

     */

    public static final String fileseparator =

         DirectoryManager.URL_FILE_SEPARATOR;

    /**

     * The configuration

     */

    protected Configuration configuration;

    /**

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

     */

    protected boolean memberDetailsListPrinted;

    /**

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

    public final Content helpLabel;

    public final Content seeLabel;

    public final Content descriptionLabel;

    public final Content prevpackageLabel;

    public final Content nextpackageLabel;

    public final Content packagesLabel;

    public final Content methodDetailsLabel;

    public final Content annotationTypeDetailsLabel;

    public final Content fieldDetailsLabel;

    public final Content constructorDetailsLabel;

    public final Content enumConstantsDetailsLabel;

    public final Content specifiedByLabel;

    public final Content overridesLabel;

    public final Content descfrmClassLabel;

    public final Content descfrmInterfaceLabel;

    /**

     * Constructor.

     *

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

     *             or null if none to be created.

     * @param filename File Name to which the PrintWriter will

     *                 do the Output.

     * @param docencoding Encoding to be used for this file.

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

                      String path, String filename, String docencoding)

                      throws IOException, UnsupportedEncodingException {

        super(Util.genWriter(configuration, path, filename, docencoding));

        this.configuration = configuration;

        htmlFilename = filename;

        this.memberDetailsListPrinted = false;

        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 RawHtml(

                DocletConstants.DEFAULT_PACKAGE_NAME);

        packageLabel = getResource("doclet.Package");

        useLabel = getResource("doclet.navClassUse");

        prevLabel = getResource("doclet.Prev");

        nextLabel = getResource("doclet.Next");

        prevclassLabel = getResource("doclet.Prev_Class");

        nextclassLabel = getResource("doclet.Next_Class");

        summaryLabel = getResource("doclet.Summary");

        detailLabel = getResource("doclet.Detail");

        framesLabel = getResource("doclet.Frames");

        noframesLabel = getResource("doclet.No_Frames");

        treeLabel = getResource("doclet.Tree");

        classLabel = getResource("doclet.Class");

        deprecatedLabel = getResource("doclet.navDeprecated");

        deprecatedPhrase = getResource("doclet.Deprecated");

        allclassesLabel = getResource("doclet.All_Classes");

        indexLabel = getResource("doclet.Index");

        helpLabel = getResource("doclet.Help");

        seeLabel = getResource("doclet.See");

        descriptionLabel = getResource("doclet.Description");

        prevpackageLabel = getResource("doclet.Prev_Package");

        nextpackageLabel = getResource("doclet.Next_Package");

        packagesLabel = getResource("doclet.Packages");

        methodDetailsLabel = getResource("doclet.Method_Detail");

        annotationTypeDetailsLabel = getResource("doclet.Annotation_Type_Member_Detail");

        fieldDetailsLabel = getResource("doclet.Field_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");

    }

    /**

     * 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 new StringContent(configuration.getText(key));

    }

    /**

     * Get the configuration string as a content.

     *

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

     * @param a1 string argument added to configuration text

     * @return a content tree for the text

     */

    public Content getResource(String key, String a1) {

        return new RawHtml(configuration.getText(key, a1));

    }

    /**

     * Get the configuration string as a content.

     *

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

     * @param a1 string argument added to configuration text

     * @param a2 string argument added to configuration text

     * @return a content tree for the text

     */

    public Content getResource(String key, String a1, String a2) {

        return new RawHtml(configuration.getText(key, a1, a2));

    }

    /**

     * Print <HTML> tag. Add a newline character at the end.

     */

    public void html() {

        println("<HTML lang=\"" + configuration.getLocale().getLanguage() + "\">");

    }

    /**

     * Print </HTML> tag. Add a newline character at the end.

     */

    public void htmlEnd() {

        println("</HTML>");

    }

    /**

     * Print the script code to be embeded before the  </HEAD> tag.

     */

    protected void printWinTitleScript(String winTitle){

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

            script();

            println("function windowTitle()");

            println("{");

            println("    if (location.href.indexOf('is-external=true') == -1) {");

            println("        parent.document.title=\"" + winTitle + "\";");

            println("    }");

            println("}");

            scriptEnd();

            noScript();

            noScriptEnd();

        }

    }

    /**

     * Returns an HtmlTree for the SCRIPT tag.

     *

     * @return an HtmlTree for the SCRIPT tag

     */

    protected HtmlTree getWinTitleScript(){

        HtmlTree script = new HtmlTree(HtmlTag.SCRIPT);

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

            script.addAttr(HtmlAttr.TYPE, "text/javascript");

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

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

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

                    "    }" + DocletConstants.NL +

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

            RawHtml scriptContent = new RawHtml(scriptCode);

            script.addContent(scriptContent);

        }

        return script;

    }

    /**

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

     *

     * @return a content for the SCRIPT tag

     */

    protected Content getFramesetJavaScript(){

        HtmlTree script = new HtmlTree(HtmlTag.SCRIPT);

        script.addAttr(HtmlAttr.TYPE, "text/javascript");

        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)" + DocletConstants.NL +

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

                "    function loadFrames() {" + DocletConstants.NL +

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

                "             top.classFrame.location = top.targetPage;" + DocletConstants.NL +

                "    }" + DocletConstants.NL;

        RawHtml scriptContent = new RawHtml(scriptCode);

        script.addContent(scriptContent);

        return script;

    }

    /**

     * Print the Javascript <SCRIPT> start tag with its type

     * attribute.

     */

    public void script() {

        println("<SCRIPT type=\"text/javascript\">");

    }

    /**

     * Print the Javascript </SCRIPT> end tag.

     */

    public void scriptEnd() {

        println("</SCRIPT>");

    }

    /**

     * Print the Javascript <NOSCRIPT> start tag.

     */

    public void noScript() {

        println("<NOSCRIPT>");

    }

    /**

     * Print the Javascript </NOSCRIPT> end tag.

     */

    public void noScriptEnd() {

        println("</NOSCRIPT>");

    }

    /**

     * Return the Javascript call to be embedded in the <BODY> tag.

     * Return nothing if winTitle is empty.

     * @return the Javascript call to be embedded in the <BODY> tag.

     */

    protected String getWindowTitleOnload(){

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

            return " onload=\"windowTitle();\"";

        } else {

            return "";

        }

    }

    /**

     * Print <BODY BGCOLOR="bgcolor">, including JavaScript

     * "onload" call to load windowtitle script.  This script shows the name

     * of the document in the window title bar when frames are on.

     *

     * @param bgcolor Background color.

     * @param includeScript  boolean set true if printing windowtitle script

     */

    public void body(String bgcolor, boolean includeScript) {

        print("<BODY BGCOLOR=\"" + bgcolor + "\"");

        if (includeScript) {

            print(getWindowTitleOnload());

        }

        println(">");

    }

    /**

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

            body.addContent(getWinTitleScript());

            Content noScript = HtmlTree.NOSCRIPT(

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

            body.addContent(noScript);

        }

        return body;

    }

    /**

     * Print </BODY> tag. Add a newline character at the end.

     */

    public void bodyEnd() {

        println("</BODY>");

    }

    /**

     * Print <TITLE> tag. Add a newline character at the end.

     */

    public void title() {

        println("<TITLE>");

    }

    /**

     * Print <TITLE> tag. Add a newline character at the end.

     *

     * @param winTitle The title of this document.

     */

    public void title(String winTitle) {

        // Set window title string which is later printed

        this.winTitle = winTitle;

        title();

    }

    /**

     * Returns an HtmlTree for the TITLE tag.

     *

     * @return an HtmlTree for the TITLE tag

     */

    public HtmlTree getTitle() {

        HtmlTree title = HtmlTree.TITLE(new StringContent(winTitle));

        return title;

    }

    /**

     * Print </TITLE> tag. Add a newline character at the end.

     */

    public void titleEnd() {

        println("</TITLE>");

    }

    /**

     * Print <UL> tag. Add a newline character at the end.

     */

    public void ul() {

        println("<UL>");

    }

    /**

     * Print </UL> tag. Add a newline character at the end.

     */

    public void ulEnd() {

        println("</UL>");

    }

    /**

     * Print <LI> tag.

     */

    public void li() {

        print("<LI>");

    }

    /**

     * Print <LI TYPE="type"> tag.

     *

     * @param type Type string.

     */

    public void li(String type) {

        print("<LI TYPE=\"" + type + "\">");

    }

    /**

     * Print <H1> tag. Add a newline character at the end.

     */

    public void h1() {

        println("<H1>");

    }

    /**

     * Print </H1> tag. Add a newline character at the end.

     */

    public void h1End() {

        println("</H1>");

    }

    /**

     * Print text with <H1> tag. Also adds </H1> tag. Add a newline character

     * at the end of the text.

     *

     * @param text Text to be printed with <H1> format.

     */

    public void h1(String text) {

        h1();

        println(text);

        h1End();

    }

    /**

     * Print <H2> tag. Add a newline character at the end.

     */

    public void h2() {