aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.doclets.formats.html;
aoqi@0: 
aoqi@0: import java.io.*;
aoqi@0: 
aoqi@0: import com.sun.javadoc.*;
aoqi@0: import com.sun.tools.doclets.formats.html.markup.*;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Generate Class Hierarchy page for all the Classes in this run.  Use
aoqi@0:  * ClassTree for building the Tree. The name of
aoqi@0:  * the generated file is "overview-tree.html" and it is generated in the
aoqi@0:  * current or the destination directory.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Atul M Dambalkar
aoqi@0:  * @author Bhavesh Patel (Modified)
aoqi@0:  */
aoqi@0: public class TreeWriter extends AbstractTreeWriter {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Packages in this run.
aoqi@0:      */
aoqi@0:     private PackageDoc[] packages;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * True if there are no packages specified on the command line,
aoqi@0:      * False otherwise.
aoqi@0:      */
aoqi@0:     private boolean classesonly;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Constructor to construct TreeWriter object.
aoqi@0:      *
aoqi@0:      * @param configuration the current configuration of the doclet.
aoqi@0:      * @param filename String filename
aoqi@0:      * @param classtree the tree being built.
aoqi@0:      */
aoqi@0:     public TreeWriter(ConfigurationImpl configuration,
aoqi@0:             DocPath filename, ClassTree classtree)
aoqi@0:     throws IOException {
aoqi@0:         super(configuration, filename, classtree);
aoqi@0:         packages = configuration.packages;
aoqi@0:     classesonly = packages.length == 0;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Create a TreeWriter object and use it to generate the
aoqi@0:      * "overview-tree.html" file.
aoqi@0:      *
aoqi@0:      * @param classtree the class tree being documented.
aoqi@0:      * @throws  DocletAbortException
aoqi@0:      */
aoqi@0:     public static void generate(ConfigurationImpl configuration,
aoqi@0:                                 ClassTree classtree) {
aoqi@0:         TreeWriter treegen;
aoqi@0:         DocPath filename = DocPaths.OVERVIEW_TREE;
aoqi@0:         try {
aoqi@0:             treegen = new TreeWriter(configuration, filename, classtree);
aoqi@0:             treegen.generateTreeFile();
aoqi@0:             treegen.close();
aoqi@0:         } catch (IOException exc) {
aoqi@0:             configuration.standardmessage.error(
aoqi@0:                         "doclet.exception_encountered",
aoqi@0:                         exc.toString(), filename);
aoqi@0:             throw new DocletAbortException(exc);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Generate the interface hierarchy and class hierarchy.
aoqi@0:      */
aoqi@0:     public void generateTreeFile() throws IOException {
aoqi@0:         Content body = getTreeHeader();
aoqi@0:         Content headContent = getResource("doclet.Hierarchy_For_All_Packages");
aoqi@0:         Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, false,
aoqi@0:                 HtmlStyle.title, headContent);
aoqi@0:         Content div = HtmlTree.DIV(HtmlStyle.header, heading);
aoqi@0:         addPackageTreeLinks(div);
aoqi@0:         body.addContent(div);
aoqi@0:         HtmlTree divTree = new HtmlTree(HtmlTag.DIV);
aoqi@0:         divTree.addStyle(HtmlStyle.contentContainer);
aoqi@0:         addTree(classtree.baseclasses(), "doclet.Class_Hierarchy", divTree);
aoqi@0:         addTree(classtree.baseinterfaces(), "doclet.Interface_Hierarchy", divTree);
aoqi@0:         addTree(classtree.baseAnnotationTypes(), "doclet.Annotation_Type_Hierarchy", divTree);
aoqi@0:         addTree(classtree.baseEnums(), "doclet.Enum_Hierarchy", divTree);
aoqi@0:         body.addContent(divTree);
aoqi@0:         addNavLinks(false, body);
aoqi@0:         addBottom(body);
aoqi@0:         printHtmlDocument(null, true, body);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Add the links to all the package tree files.
aoqi@0:      *
aoqi@0:      * @param contentTree the content tree to which the links will be added
aoqi@0:      */
aoqi@0:     protected void addPackageTreeLinks(Content contentTree) {
aoqi@0:         //Do nothing if only unnamed package is used
aoqi@0:         if (packages.length == 1 && packages[0].name().length() == 0) {
aoqi@0:             return;
aoqi@0:         }
aoqi@0:         if (!classesonly) {
aoqi@0:             Content span = HtmlTree.SPAN(HtmlStyle.packageHierarchyLabel,
aoqi@0:                     getResource("doclet.Package_Hierarchies"));
aoqi@0:             contentTree.addContent(span);
aoqi@0:             HtmlTree ul = new HtmlTree(HtmlTag.UL);
aoqi@0:             ul.addStyle(HtmlStyle.horizontal);
aoqi@0:             for (int i = 0; i < packages.length; i++) {
aoqi@0:                 // If the package name length is 0 or if -nodeprecated option
aoqi@0:                 // is set and the package is marked as deprecated, do not include
aoqi@0:                 // the page in the list of package hierarchies.
aoqi@0:                 if (packages[i].name().length() == 0 ||
aoqi@0:                         (configuration.nodeprecated && Util.isDeprecated(packages[i]))) {
aoqi@0:                     continue;
aoqi@0:                 }
aoqi@0:                 DocPath link = pathString(packages[i], DocPaths.PACKAGE_TREE);
aoqi@0:                 Content li = HtmlTree.LI(getHyperLink(
aoqi@0:                         link, new StringContent(packages[i].name())));
aoqi@0:                 if (i < packages.length - 1) {
aoqi@0:                     li.addContent(", ");
aoqi@0:                 }
aoqi@0:                 ul.addContent(li);
aoqi@0:             }
aoqi@0:             contentTree.addContent(ul);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the tree header.
aoqi@0:      *
aoqi@0:      * @return a content tree for the tree header
aoqi@0:      */
aoqi@0:     protected Content getTreeHeader() {
aoqi@0:         String title = configuration.getText("doclet.Window_Class_Hierarchy");
aoqi@0:         Content bodyTree = getBody(true, getWindowTitle(title));
aoqi@0:         addTop(bodyTree);
aoqi@0:         addNavLinks(true, bodyTree);
aoqi@0:         return bodyTree;
aoqi@0:     }
aoqi@0: }