duke@1: /* xdono@117: * Copyright 1998-2008 Sun Microsystems, Inc. All Rights Reserved. duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@1: * duke@1: * This code is free software; you can redistribute it and/or modify it duke@1: * under the terms of the GNU General Public License version 2 only, as duke@1: * published by the Free Software Foundation. Sun designates this duke@1: * particular file as subject to the "Classpath" exception as provided duke@1: * by Sun in the LICENSE file that accompanied this code. duke@1: * duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@1: * version 2 for more details (a copy is included in the LICENSE file that duke@1: * accompanied this code). duke@1: * duke@1: * You should have received a copy of the GNU General Public License version duke@1: * 2 along with this work; if not, write to the Free Software Foundation, duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@1: * duke@1: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, duke@1: * CA 95054 USA or visit www.sun.com if you need additional information or duke@1: * have any questions. duke@1: */ duke@1: duke@1: package com.sun.tools.doclets.formats.html; duke@1: duke@1: import com.sun.tools.doclets.internal.toolkit.util.*; duke@1: import com.sun.javadoc.*; duke@1: import java.io.*; duke@1: import java.util.*; duke@1: duke@1: /** duke@1: * Generate package usage information. duke@1: * duke@1: * @author Robert G. Field duke@1: */ duke@1: public class PackageUseWriter extends SubWriterHolderWriter { duke@1: duke@1: final PackageDoc pkgdoc; jjg@74: final SortedMap> usingPackageToUsedClasses = new TreeMap>(); duke@1: duke@1: /** duke@1: * Constructor. duke@1: * duke@1: * @param filename the file to be generated. duke@1: * @throws IOException duke@1: * @throws DocletAbortException duke@1: */ duke@1: public PackageUseWriter(ConfigurationImpl configuration, duke@1: ClassUseMapper mapper, String filename, duke@1: PackageDoc pkgdoc) throws IOException { duke@1: super(configuration, DirectoryManager.getDirectoryPath(pkgdoc), duke@1: filename, duke@1: DirectoryManager.getRelativePath(pkgdoc.name())); duke@1: this.pkgdoc = pkgdoc; duke@1: duke@1: // by examining all classes in this package, find what packages duke@1: // use these classes - produce a map between using package and duke@1: // used classes. duke@1: ClassDoc[] content = pkgdoc.allClasses(); duke@1: for (int i = 0; i < content.length; ++i) { duke@1: ClassDoc usedClass = content[i]; jjg@74: Set usingClasses = mapper.classToClass.get(usedClass.qualifiedName()); duke@1: if (usingClasses != null) { mcimadamore@184: for (Iterator it = usingClasses.iterator(); it.hasNext(); ) { mcimadamore@184: ClassDoc usingClass = it.next(); duke@1: PackageDoc usingPackage = usingClass.containingPackage(); jjg@74: Set usedClasses = usingPackageToUsedClasses duke@1: .get(usingPackage.name()); duke@1: if (usedClasses == null) { jjg@74: usedClasses = new TreeSet(); duke@1: usingPackageToUsedClasses.put(Util.getPackageName(usingPackage), duke@1: usedClasses); duke@1: } duke@1: usedClasses.add(usedClass); duke@1: } duke@1: } duke@1: } duke@1: } duke@1: duke@1: /** duke@1: * Generate a class page. duke@1: * duke@1: * @param configuration the current configuration of the doclet. duke@1: * @param mapper the mapping of the class usage. duke@1: * @param pkgdoc the package doc being documented. duke@1: */ duke@1: public static void generate(ConfigurationImpl configuration, duke@1: ClassUseMapper mapper, PackageDoc pkgdoc) { duke@1: PackageUseWriter pkgusegen; duke@1: String filename = "package-use.html"; duke@1: try { duke@1: pkgusegen = new PackageUseWriter(configuration, duke@1: mapper, filename, pkgdoc); duke@1: pkgusegen.generatePackageUseFile(); duke@1: pkgusegen.close(); duke@1: } catch (IOException exc) { duke@1: configuration.standardmessage.error( duke@1: "doclet.exception_encountered", duke@1: exc.toString(), filename); duke@1: throw new DocletAbortException(); duke@1: } duke@1: } duke@1: duke@1: duke@1: /** duke@1: * Print the class use list. duke@1: */ duke@1: protected void generatePackageUseFile() throws IOException { duke@1: printPackageUseHeader(); duke@1: duke@1: if (usingPackageToUsedClasses.isEmpty()) { duke@1: printText("doclet.ClassUse_No.usage.of.0", pkgdoc.name()); duke@1: p(); duke@1: } else { duke@1: generatePackageUse(); duke@1: } duke@1: duke@1: printPackageUseFooter(); duke@1: } duke@1: duke@1: /** duke@1: * Print the class use list. duke@1: */ duke@1: protected void generatePackageUse() throws IOException { duke@1: if (configuration.packages.length > 1) { duke@1: generatePackageList(); duke@1: } duke@1: generateClassList(); duke@1: } duke@1: duke@1: protected void generatePackageList() throws IOException { duke@1: tableIndexSummary(); duke@1: tableHeaderStart("#CCCCFF"); duke@1: printText("doclet.ClassUse_Packages.that.use.0", duke@1: getPackageLink(pkgdoc, Util.getPackageName(pkgdoc), false)); duke@1: tableHeaderEnd(); mcimadamore@184: Iterator it = usingPackageToUsedClasses.keySet().iterator(); duke@1: while (it.hasNext()) { mcimadamore@184: PackageDoc pkg = configuration.root.packageNamed(it.next()); duke@1: generatePackageUse(pkg); duke@1: } duke@1: tableEnd(); duke@1: space(); duke@1: p(); duke@1: } duke@1: duke@1: protected void generateClassList() throws IOException { mcimadamore@184: Iterator itp = usingPackageToUsedClasses.keySet().iterator(); duke@1: while (itp.hasNext()) { mcimadamore@184: String packageName = itp.next(); duke@1: PackageDoc usingPackage = configuration.root.packageNamed(packageName); duke@1: if (usingPackage != null) { duke@1: anchor(usingPackage.name()); duke@1: } duke@1: tableIndexSummary(); duke@1: tableHeaderStart("#CCCCFF"); duke@1: printText("doclet.ClassUse_Classes.in.0.used.by.1", duke@1: getPackageLink(pkgdoc, Util.getPackageName(pkgdoc), false), duke@1: getPackageLink(usingPackage,Util.getPackageName(usingPackage), false)); duke@1: tableHeaderEnd(); mcimadamore@184: Iterator itc = mcimadamore@184: usingPackageToUsedClasses.get(packageName).iterator(); duke@1: while (itc.hasNext()) { mcimadamore@184: printClassRow(itc.next(), packageName); duke@1: } duke@1: tableEnd(); duke@1: space(); duke@1: p(); duke@1: } duke@1: } duke@1: duke@1: protected void printClassRow(ClassDoc usedClass, String packageName) { duke@1: String path = pathString(usedClass, duke@1: "class-use/" + usedClass.name() + ".html"); duke@1: duke@1: trBgcolorStyle("white", "TableRowColor"); duke@1: summaryRow(0); bpatel@182: strong(); duke@1: printHyperLink(path, packageName, usedClass.name(), true); bpatel@182: strongEnd(); duke@1: println(); br(); duke@1: printNbsps(); duke@1: printIndexComment(usedClass); duke@1: summaryRowEnd(); duke@1: trEnd(); duke@1: } duke@1: duke@1: /** duke@1: * Print the package use list. duke@1: */ duke@1: protected void generatePackageUse(PackageDoc pkg) throws IOException { duke@1: trBgcolorStyle("white", "TableRowColor"); duke@1: summaryRow(0); duke@1: //Just want an anchor here. duke@1: printHyperLink("", pkg.name(), Util.getPackageName(pkg), true); duke@1: summaryRowEnd(); duke@1: summaryRow(0); duke@1: if (pkg != null) { duke@1: printSummaryComment(pkg); duke@1: } duke@1: space(); duke@1: summaryRowEnd(); duke@1: trEnd(); duke@1: } duke@1: duke@1: /** duke@1: * Print the header for the class use Listing. duke@1: */ duke@1: protected void printPackageUseHeader() { duke@1: String packageLabel = configuration.getText("doclet.Package"); duke@1: String name = pkgdoc.name(); duke@1: printHtmlHeader(configuration.getText("doclet.Window_ClassUse_Header", duke@1: packageLabel, name), null, true); duke@1: printTop(); duke@1: navLinks(true); duke@1: hr(); duke@1: center(); duke@1: h2(); bpatel@182: strongText("doclet.ClassUse_Title", packageLabel, name); duke@1: h2End(); duke@1: centerEnd(); duke@1: } duke@1: duke@1: /** duke@1: * Print the footer for the class use Listing. duke@1: */ duke@1: protected void printPackageUseFooter() { duke@1: hr(); duke@1: navLinks(false); duke@1: printBottom(); duke@1: printBodyHtmlEnd(); duke@1: } duke@1: duke@1: duke@1: /** duke@1: * Print this package link duke@1: */ duke@1: protected void navLinkPackage() { duke@1: navCellStart(); duke@1: printHyperLink("package-summary.html", "", configuration.getText("doclet.Package"), duke@1: true, "NavBarFont1"); duke@1: navCellEnd(); duke@1: } duke@1: duke@1: /** duke@1: * Print class use link duke@1: */ duke@1: protected void navLinkClassUse() { duke@1: navCellRevStart(); duke@1: fontStyle("NavBarFont1Rev"); bpatel@182: strongText("doclet.navClassUse"); duke@1: fontEnd(); duke@1: navCellEnd(); duke@1: } duke@1: duke@1: protected void navLinkTree() { duke@1: navCellStart(); duke@1: printHyperLink("package-tree.html", "", configuration.getText("doclet.Tree"), duke@1: true, "NavBarFont1"); duke@1: navCellEnd(); duke@1: } duke@1: duke@1: }