/*

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

import java.io.*;

import java.text.SimpleDateFormat;

import java.util.*;

import com.sun.javadoc.*;

import com.sun.tools.doclets.formats.html.markup.*;

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

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

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

/**

 * Class for the Html Format Code Generation specific to JavaDoc.

 * This Class contains methods related to the Html Code Generation which

 * are used extensively while generating the entire documentation.

 *

 * @since 1.2

 * @author Atul M Dambalkar

 * @author Robert Field

 * @author Bhavesh Patel (Modified)

 */

public class HtmlDocletWriter extends HtmlDocWriter {

    /**

     * Relative path from the file getting generated to the destination

     * directory. For example, if the file getting generated is

     * "java/lang/Object.html", then the relative path string is "../../".

     * This string can be empty if the file getting generated is in

     * the destination directory.

     */

    public String relativePath = "";

    /**

     * Same as relativepath, but normalized to never be empty or

     * end with a slash.

     */

    public String relativepathNoSlash = "";

    /**

     * Platform-dependent directory path from the current or the

     * destination directory to the file getting generated.

     * Used when creating the file.

     * For example, if the file getting generated is

     * "java/lang/Object.html", then the path string is "java/lang".

     */

    public String path = "";

    /**

     * Name of the file getting generated. If the file getting generated is

     * "java/lang/Object.html", then the filename is "Object.html".

     */

    public String filename = "";

    /**

     * The display length used for indentation while generating the class page.

     */

    public int displayLength = 0;

    /**

     * The global configuration information for this run.

     */

    public ConfigurationImpl configuration;

    /**

     * To check whether annotation heading is printed or not.

     */

    protected boolean printedAnnotationHeading = false;

    /**

     * Constructor to construct the HtmlStandardWriter object.

     *

     * @param filename File to be generated.

     */

    public HtmlDocletWriter(ConfigurationImpl configuration,

                              String filename) throws IOException {

        super(configuration, filename);

        this.configuration = configuration;

        this.filename = filename;

    }

    /**

     * Constructor to construct the HtmlStandardWriter object.

     *

     * @param path         Platform-dependent {@link #path} used when

     *                     creating file.

     * @param filename     Name of file to be generated.

     * @param relativePath Value for the variable {@link #relativePath}.

     */

    public HtmlDocletWriter(ConfigurationImpl configuration,

                              String path, String filename,

                              String relativePath) throws IOException {

        super(configuration, path, filename);

        this.configuration = configuration;

        this.path = path;

        this.relativePath = relativePath;

        this.relativepathNoSlash =

            DirectoryManager.getPathNoTrailingSlash(this.relativePath);

        this.filename = filename;

    }

    /**

     * Replace {@docRoot} tag used in options that accept HTML text, such

     * as -header, -footer, -top and -bottom, and when converting a relative

     * HREF where commentTagsToString inserts a {@docRoot} where one was

     * missing.  (Also see DocRootTaglet for {@docRoot} tags in doc

     * comments.)

     * <p>

     * Replace {@docRoot} tag in htmlstr with the relative path to the

     * destination directory from the directory where the file is being

     * written, looping to handle all such tags in htmlstr.

     * <p>

     * For example, for "-d docs" and -header containing {@docRoot}, when

     * the HTML page for source file p/C1.java is being generated, the

     * {@docRoot} tag would be inserted into the header as "../",

     * the relative path from docs/p/ to docs/ (the document root).

     * <p>

     * Note: This doc comment was written with '@' representing '@'

     * to prevent the inline tag from being interpreted.

     */

    public String replaceDocRootDir(String htmlstr) {

        // Return if no inline tags exist

        int index = htmlstr.indexOf("{@");

        if (index < 0) {

            return htmlstr;

        }

        String lowerHtml = htmlstr.toLowerCase();

        // Return index of first occurrence of {@docroot}

        // Note: {@docRoot} is not case sensitive when passed in w/command line option

        index = lowerHtml.indexOf("{@docroot}", index);

        if (index < 0) {

            return htmlstr;

        }

        StringBuilder buf = new StringBuilder();

        int previndex = 0;

        while (true) {

            // Search for lowercase version of {@docRoot}

            index = lowerHtml.indexOf("{@docroot}", previndex);

            // If next {@docRoot} tag not found, append rest of htmlstr and exit loop

            if (index < 0) {

                buf.append(htmlstr.substring(previndex));

                break;

            }

            // If next {@docroot} tag found, append htmlstr up to start of tag

            buf.append(htmlstr.substring(previndex, index));

            previndex = index + 10;  // length for {@docroot} string

            // Insert relative path where {@docRoot} was located

            buf.append(relativepathNoSlash);

            // Append slash if next character is not a slash

            if (relativepathNoSlash.length() > 0 && previndex < htmlstr.length()

                    && htmlstr.charAt(previndex) != '/') {

                buf.append(DirectoryManager.URL_FILE_SEPARATOR);

            }

        }

        return buf.toString();

    }

    /**

     * Print Html Hyper Link, with target frame.  This

     * link will only appear if page is not in a frame.

     *

     * @param link String name of the file.

     * @param where Position in the file

     * @param target Name of the target frame.

     * @param label Tag for the link.

     * @param strong Whether the label should be strong or not?

     */

    public void printNoFramesTargetHyperLink(String link, String where,

                                               String target, String label,

                                               boolean strong) {

        script();

        println("  <!--");

        println("  if(window==top) {");

        println("    document.writeln('"

            + getHyperLinkString(link, where, label, strong, "", "", target) + "');");

        println("  }");

        println("  //-->");

        scriptEnd();

        noScript();

        println("  " + getHyperLinkString(link, where, label, strong, "", "", target));

        noScriptEnd();

        println(DocletConstants.NL);

    }

    /**

     * Get the script to show or hide the All classes link.

     *

     * @param id id of the element to show or hide

     * @return a content tree for the script

     */

    public Content getAllClassesLinkScript(String id) {

        HtmlTree script = new HtmlTree(HtmlTag.SCRIPT);

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

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

                "  allClassesLink = document.getElementById(\"" + id + "\");" + DocletConstants.NL +

                "  if(window==top) {" + DocletConstants.NL +

                "    allClassesLink.style.display = \"block\";" + DocletConstants.NL +

                "  }" + DocletConstants.NL +

                "  else {" + DocletConstants.NL +

                "    allClassesLink.style.display = \"none\";" + DocletConstants.NL +

                "  }" + DocletConstants.NL +

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

        Content scriptContent = new RawHtml(scriptCode);

        script.addContent(scriptContent);

        Content div = HtmlTree.DIV(script);

        return div;

    }

    /**

     * Add method information.

     *

     * @param method the method to be documented

     * @param dl the content tree to which the method information will be added

     */

    private void addMethodInfo(MethodDoc method, Content dl) {

        ClassDoc[] intfacs = method.containingClass().interfaces();

        MethodDoc overriddenMethod = method.overriddenMethod();

        // Check whether there is any implementation or overridden info to be

        // printed. If no overridden or implementation info needs to be

        // printed, do not print this section.

        if ((intfacs.length > 0 &&

                new ImplementedMethods(method, this.configuration).build().length > 0) ||

                overriddenMethod != null) {

            MethodWriterImpl.addImplementsInfo(this, method, dl);

            if (overriddenMethod != null) {

                MethodWriterImpl.addOverridden(this,

                        method.overriddenType(), overriddenMethod, dl);

            }

        }

    }

    /**

     * Adds the tags information.

     *

     * @param doc the doc for which the tags will be generated

     * @param htmltree the documentation tree to which the tags will be added

     */

    protected void addTagsInfo(Doc doc, Content htmltree) {

        if (configuration.nocomment) {

            return;

        }

        Content dl = new HtmlTree(HtmlTag.DL);

        if (doc instanceof MethodDoc) {

            addMethodInfo((MethodDoc) doc, dl);

        }

        TagletOutputImpl output = new TagletOutputImpl("");

        TagletWriter.genTagOuput(configuration.tagletManager, doc,

            configuration.tagletManager.getCustomTags(doc),

                getTagletWriterInstance(false), output);

        String outputString = output.toString().trim();

        if (!outputString.isEmpty()) {

            Content resultString = new RawHtml(outputString);

            dl.addContent(resultString);

        }

        htmltree.addContent(dl);

    }

    /**

     * Check whether there are any tags for Serialization Overview

     * section to be printed.

     *

     * @param field the FieldDoc object to check for tags.

     * @return true if there are tags to be printed else return false.

     */

    protected boolean hasSerializationOverviewTags(FieldDoc field) {

        TagletOutputImpl output = new TagletOutputImpl("");

        TagletWriter.genTagOuput(configuration.tagletManager, field,

            configuration.tagletManager.getCustomTags(field),

                getTagletWriterInstance(false), output);

        return (!output.toString().trim().isEmpty());

    }

    /**

     * Returns a TagletWriter that knows how to write HTML.

     *

     * @return a TagletWriter that knows how to write HTML.

     */

    public TagletWriter getTagletWriterInstance(boolean isFirstSentence) {

        return new TagletWriterImpl(this, isFirstSentence);

    }

    protected void printTagsInfoHeader() {

        dl();

    }

    protected void printTagsInfoFooter() {

        dlEnd();

    }

    /**

     * Get Package link, with target frame.

     *

     * @param pd The link will be to the "package-summary.html" page for this package

     * @param target name of the target frame

     * @param label tag for the link

     * @return a content for the target package link

     */

    public Content getTargetPackageLink(PackageDoc pd, String target,

            Content label) {

        return getHyperLink(pathString(pd, "package-summary.html"), "", label, "", target);

    }

    /**

     * Print the html file header. Also print Html page title and stylesheet

     * default properties.

     *

     * @param title         String window title to go in the <TITLE> tag

     * @param metakeywords  Array of String keywords for META tag.  Each element

     *                      of the array is assigned to a separate META tag.

     *                      Pass in null for no array.

     * @param includeScript boolean true if printing windowtitle script.

     *             False for files that appear in the left-hand frames.

     */

    public void printHtmlHeader(String title, String[] metakeywords,

            boolean includeScript) {

        println("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 " +

                    "Transitional//EN\" " +

                    "\"http://www.w3.org/TR/html4/loose.dtd\">");

        println("<!--NewPage-->");

        html();

        head();

        if (! configuration.notimestamp) {

            print("<!-- Generated by javadoc (build " + ConfigurationImpl.BUILD_DATE + ") on ");

            print(today());

            println(" -->");

        }

        if (configuration.charset.length() > 0) {

            println("<META http-equiv=\"Content-Type\" content=\"text/html; "

                        + "charset=" + configuration.charset + "\">");

        }

        if ( configuration.windowtitle.length() > 0 ) {

            title += " (" + configuration.windowtitle  + ")";

        }

        title(title);

        println(title);

        titleEnd();

        println("");

        if (! configuration.notimestamp) {

                SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");

                println("<META NAME=\"date\" "

                                    + "CONTENT=\"" + dateFormat.format(new Date()) + "\">");

        }

        if ( metakeywords != null ) {

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

                println("<META NAME=\"keywords\" "

                            + "CONTENT=\"" + metakeywords[i] + "\">");

            }

        }

        println("");

        printStyleSheetProperties();

        println("");

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

        // and package-frame

        if (includeScript) {

            printWinTitleScript(title);

        }

        println("");

        headEnd();

        println("");

        body("white", includeScript);

    }

    /**

     * Generates the HTML document tree and prints it out.

     *

     * @param metakeywords Array of String keywords for META tag. Each element

     *                     of the array is assigned to a separate META tag.

     *                     Pass in null for no array

     * @param includeScript true if printing windowtitle script

     *                      false for files that appear in the left-hand frames

     * @param body the body htmltree to be included in the document

     */

    public void printHtmlDocument(String[] metakeywords, boolean includeScript,

            Content body) {

        Content htmlDocType = DocType.Transitional();

        Content htmlComment = new Comment(configuration.getText("doclet.New_Page"));

        Content head = new HtmlTree(HtmlTag.HEAD);

        if (!configuration.notimestamp) {

            Content headComment = new Comment("Generated by javadoc (version " +

                    ConfigurationImpl.BUILD_DATE + ") on " + today());

            head.addContent(headComment);

        }

        if (configuration.charset.length() > 0) {

            Content meta = HtmlTree.META("Content-Type", "text/html",

                    configuration.charset);

            head.addContent(meta);

        }

        head.addContent(getTitle());

        if (!configuration.notimestamp) {

            SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");

            Content meta = HtmlTree.META("date", dateFormat.format(new Date()));

            head.addContent(meta);

        }

        if (metakeywords != null) {

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

                Content meta = HtmlTree.META("keywords", metakeywords[i]);

                head.addContent(meta);

            }

        }

        head.addContent(getStyleSheetProperties());

        Content htmlTree = HtmlTree.HTML(configuration.getLocale().getLanguage(),

                head, body);

        Content htmlDocument = new HtmlDocument(htmlDocType,

                htmlComment, htmlTree);

        print(htmlDocument.toString());

    }

    /**

     * Get the window title.

     *

     * @param title the title string to construct the complete window title

     * @return the window title string

     */

    public String getWindowTitle(String title) {

        if (configuration.windowtitle.length() > 0) {

            title += " (" + configuration.windowtitle  + ")";

        }

        return title;

    }

    /**

     * Print user specified header and the footer.

     *

     * @param header if true print the user provided header else print the

     * user provided footer.

     */

    public void printUserHeaderFooter(boolean header) {

        em();

        if (header) {

            print(replaceDocRootDir(configuration.header));

        } else {

            if (configuration.footer.length() != 0) {

                print(replaceDocRootDir(configuration.footer));

            } else {

                print(replaceDocRootDir(configuration.header));

            }

        }

        emEnd();

    }

    /**

     * Get user specified header and the footer.

     *

     * @param header if true print the user provided header else print the

     * user provided footer.

     */

    public Content getUserHeaderFooter(boolean header) {

        String content;

        if (header) {

            content = replaceDocRootDir(configuration.header);

        } else {

            if (configuration.footer.length() != 0) {

                content = replaceDocRootDir(configuration.footer);

            } else {

                content = replaceDocRootDir(configuration.header);

            }

        }

        Content rawContent = new RawHtml(content);

        Content em = HtmlTree.EM(rawContent);

        return em;

    }

    /**

     * Print the user specified top.

     */

    public void printTop() {

        print(replaceDocRootDir(configuration.top));

        hr();

    }

    /**

     * Adds the user specified top.

     *

     * @param body the content tree to which user specified top will be added

     */

    public void addTop(Content body) {

        Content top = new RawHtml(replaceDocRootDir(configuration.top));

        body.addContent(top);

    }

    /**

     * Print the user specified bottom.

     */

    public void printBottom() {

        hr();

        print(replaceDocRootDir(configuration.bottom));