Mercurial > jdk8-mips64-public > langtools / file revision

 /*

  * 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 java.util.*;

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

     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;

         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");

     }

     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 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));

     }

     /**

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

     }

     /**

      * 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("\"");

             vars.append(entry.getKey());

             vars.append("\":");

             vars.append(entry.getValue());

         }

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

         sep = "";

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

         for (MethodTypes entry : methodTypes) {

             vars.append(sep);

             sep = ",";

             vars.append(entry.value()).append(":");

             vars.append("[").append("\"").append(entry.tabId());

             vars.append("\"").append(sep).append("\"").append(entry.text()).append("\"]");

         }

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

         addStyles(HtmlStyle.altColor, vars);

         addStyles(HtmlStyle.rowColor, vars);

         addStyles(HtmlStyle.tableTab, vars);

         addStyles(HtmlStyle.activeTableTab, vars);

         script.addContent(new RawHtml(vars.toString()));

     }

     /**

      * Adds javascript style variables to the document.

      *

      * @param style style to be added as a javascript variable

      * @param vars variable string to which the style variable will be added

      */

     public void addStyles(HtmlStyle style, StringBuilder vars) {

         vars.append("var ").append(style).append(" = \"").append(style)

                 .append("\";").append(DocletConstants.NL);

     }

     /**

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

     }

     /**

      * Return, text passed, with Italics <i> and </i> tags, surrounding it.

      * So if the text passed is "Hi", then string returned will be "<i>Hi</i>".

      *

      * @param text String to be printed in between <I> and </I> tags.

      */

     public String italicsText(String text) {

         return "<i>" + text + "</i>";

     }

     public String codeText(String text) {

         return "<code>" + text + "</code>";

     }

     /**

      * Return " ", non-breaking space.

      */

     public Content getSpace() {

         return RawHtml.nbsp;

     }

     /*

      * Returns a header for Modifier and Type column of a table.

      */

     public String getModifierTypeHeader() {

         return modifierTypeHeader;

     }

 }