Thu, 02 Oct 2008 19:58:40 -0700
6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell
duke@1 | 1 | /* |
xdono@117 | 2 | * Copyright 1998-2008 Sun Microsystems, Inc. All Rights Reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
duke@1 | 9 | * by Sun in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
duke@1 | 23 | * have any questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.formats.html; |
duke@1 | 27 | |
duke@1 | 28 | import com.sun.tools.doclets.internal.toolkit.util.*; |
duke@1 | 29 | import com.sun.javadoc.*; |
duke@1 | 30 | import java.io.*; |
duke@1 | 31 | import java.util.*; |
duke@1 | 32 | |
duke@1 | 33 | /** |
duke@1 | 34 | * Generate package usage information. |
duke@1 | 35 | * |
duke@1 | 36 | * @author Robert G. Field |
duke@1 | 37 | */ |
duke@1 | 38 | public class PackageUseWriter extends SubWriterHolderWriter { |
duke@1 | 39 | |
duke@1 | 40 | final PackageDoc pkgdoc; |
jjg@74 | 41 | final SortedMap<String,Set<ClassDoc>> usingPackageToUsedClasses = new TreeMap<String,Set<ClassDoc>>(); |
duke@1 | 42 | |
duke@1 | 43 | /** |
duke@1 | 44 | * Constructor. |
duke@1 | 45 | * |
duke@1 | 46 | * @param filename the file to be generated. |
duke@1 | 47 | * @throws IOException |
duke@1 | 48 | * @throws DocletAbortException |
duke@1 | 49 | */ |
duke@1 | 50 | public PackageUseWriter(ConfigurationImpl configuration, |
duke@1 | 51 | ClassUseMapper mapper, String filename, |
duke@1 | 52 | PackageDoc pkgdoc) throws IOException { |
duke@1 | 53 | super(configuration, DirectoryManager.getDirectoryPath(pkgdoc), |
duke@1 | 54 | filename, |
duke@1 | 55 | DirectoryManager.getRelativePath(pkgdoc.name())); |
duke@1 | 56 | this.pkgdoc = pkgdoc; |
duke@1 | 57 | |
duke@1 | 58 | // by examining all classes in this package, find what packages |
duke@1 | 59 | // use these classes - produce a map between using package and |
duke@1 | 60 | // used classes. |
duke@1 | 61 | ClassDoc[] content = pkgdoc.allClasses(); |
duke@1 | 62 | for (int i = 0; i < content.length; ++i) { |
duke@1 | 63 | ClassDoc usedClass = content[i]; |
jjg@74 | 64 | Set<ClassDoc> usingClasses = mapper.classToClass.get(usedClass.qualifiedName()); |
duke@1 | 65 | if (usingClasses != null) { |
duke@1 | 66 | for (Iterator it = usingClasses.iterator(); it.hasNext(); ) { |
duke@1 | 67 | ClassDoc usingClass = (ClassDoc)it.next(); |
duke@1 | 68 | PackageDoc usingPackage = usingClass.containingPackage(); |
jjg@74 | 69 | Set<ClassDoc> usedClasses = usingPackageToUsedClasses |
duke@1 | 70 | .get(usingPackage.name()); |
duke@1 | 71 | if (usedClasses == null) { |
jjg@74 | 72 | usedClasses = new TreeSet<ClassDoc>(); |
duke@1 | 73 | usingPackageToUsedClasses.put(Util.getPackageName(usingPackage), |
duke@1 | 74 | usedClasses); |
duke@1 | 75 | } |
duke@1 | 76 | usedClasses.add(usedClass); |
duke@1 | 77 | } |
duke@1 | 78 | } |
duke@1 | 79 | } |
duke@1 | 80 | } |
duke@1 | 81 | |
duke@1 | 82 | /** |
duke@1 | 83 | * Generate a class page. |
duke@1 | 84 | * |
duke@1 | 85 | * @param configuration the current configuration of the doclet. |
duke@1 | 86 | * @param mapper the mapping of the class usage. |
duke@1 | 87 | * @param pkgdoc the package doc being documented. |
duke@1 | 88 | */ |
duke@1 | 89 | public static void generate(ConfigurationImpl configuration, |
duke@1 | 90 | ClassUseMapper mapper, PackageDoc pkgdoc) { |
duke@1 | 91 | PackageUseWriter pkgusegen; |
duke@1 | 92 | String filename = "package-use.html"; |
duke@1 | 93 | try { |
duke@1 | 94 | pkgusegen = new PackageUseWriter(configuration, |
duke@1 | 95 | mapper, filename, pkgdoc); |
duke@1 | 96 | pkgusegen.generatePackageUseFile(); |
duke@1 | 97 | pkgusegen.close(); |
duke@1 | 98 | } catch (IOException exc) { |
duke@1 | 99 | configuration.standardmessage.error( |
duke@1 | 100 | "doclet.exception_encountered", |
duke@1 | 101 | exc.toString(), filename); |
duke@1 | 102 | throw new DocletAbortException(); |
duke@1 | 103 | } |
duke@1 | 104 | } |
duke@1 | 105 | |
duke@1 | 106 | |
duke@1 | 107 | /** |
duke@1 | 108 | * Print the class use list. |
duke@1 | 109 | */ |
duke@1 | 110 | protected void generatePackageUseFile() throws IOException { |
duke@1 | 111 | printPackageUseHeader(); |
duke@1 | 112 | |
duke@1 | 113 | if (usingPackageToUsedClasses.isEmpty()) { |
duke@1 | 114 | printText("doclet.ClassUse_No.usage.of.0", pkgdoc.name()); |
duke@1 | 115 | p(); |
duke@1 | 116 | } else { |
duke@1 | 117 | generatePackageUse(); |
duke@1 | 118 | } |
duke@1 | 119 | |
duke@1 | 120 | printPackageUseFooter(); |
duke@1 | 121 | } |
duke@1 | 122 | |
duke@1 | 123 | /** |
duke@1 | 124 | * Print the class use list. |
duke@1 | 125 | */ |
duke@1 | 126 | protected void generatePackageUse() throws IOException { |
duke@1 | 127 | if (configuration.packages.length > 1) { |
duke@1 | 128 | generatePackageList(); |
duke@1 | 129 | } |
duke@1 | 130 | generateClassList(); |
duke@1 | 131 | } |
duke@1 | 132 | |
duke@1 | 133 | protected void generatePackageList() throws IOException { |
duke@1 | 134 | tableIndexSummary(); |
duke@1 | 135 | tableHeaderStart("#CCCCFF"); |
duke@1 | 136 | printText("doclet.ClassUse_Packages.that.use.0", |
duke@1 | 137 | getPackageLink(pkgdoc, Util.getPackageName(pkgdoc), false)); |
duke@1 | 138 | tableHeaderEnd(); |
duke@1 | 139 | Iterator it = usingPackageToUsedClasses.keySet().iterator(); |
duke@1 | 140 | while (it.hasNext()) { |
duke@1 | 141 | PackageDoc pkg = configuration.root.packageNamed((String)it.next()); |
duke@1 | 142 | generatePackageUse(pkg); |
duke@1 | 143 | } |
duke@1 | 144 | tableEnd(); |
duke@1 | 145 | space(); |
duke@1 | 146 | p(); |
duke@1 | 147 | } |
duke@1 | 148 | |
duke@1 | 149 | protected void generateClassList() throws IOException { |
duke@1 | 150 | Iterator itp = usingPackageToUsedClasses.keySet().iterator(); |
duke@1 | 151 | while (itp.hasNext()) { |
duke@1 | 152 | String packageName = (String)itp.next(); |
duke@1 | 153 | PackageDoc usingPackage = configuration.root.packageNamed(packageName); |
duke@1 | 154 | if (usingPackage != null) { |
duke@1 | 155 | anchor(usingPackage.name()); |
duke@1 | 156 | } |
duke@1 | 157 | tableIndexSummary(); |
duke@1 | 158 | tableHeaderStart("#CCCCFF"); |
duke@1 | 159 | printText("doclet.ClassUse_Classes.in.0.used.by.1", |
duke@1 | 160 | getPackageLink(pkgdoc, Util.getPackageName(pkgdoc), false), |
duke@1 | 161 | getPackageLink(usingPackage,Util.getPackageName(usingPackage), false)); |
duke@1 | 162 | tableHeaderEnd(); |
duke@1 | 163 | Iterator itc = |
duke@1 | 164 | ((Collection)usingPackageToUsedClasses.get(packageName)) |
duke@1 | 165 | .iterator(); |
duke@1 | 166 | while (itc.hasNext()) { |
duke@1 | 167 | printClassRow((ClassDoc)itc.next(), packageName); |
duke@1 | 168 | } |
duke@1 | 169 | tableEnd(); |
duke@1 | 170 | space(); |
duke@1 | 171 | p(); |
duke@1 | 172 | } |
duke@1 | 173 | } |
duke@1 | 174 | |
duke@1 | 175 | protected void printClassRow(ClassDoc usedClass, String packageName) { |
duke@1 | 176 | String path = pathString(usedClass, |
duke@1 | 177 | "class-use/" + usedClass.name() + ".html"); |
duke@1 | 178 | |
duke@1 | 179 | trBgcolorStyle("white", "TableRowColor"); |
duke@1 | 180 | summaryRow(0); |
duke@1 | 181 | bold(); |
duke@1 | 182 | printHyperLink(path, packageName, usedClass.name(), true); |
duke@1 | 183 | boldEnd(); |
duke@1 | 184 | println(); br(); |
duke@1 | 185 | printNbsps(); |
duke@1 | 186 | printIndexComment(usedClass); |
duke@1 | 187 | summaryRowEnd(); |
duke@1 | 188 | trEnd(); |
duke@1 | 189 | } |
duke@1 | 190 | |
duke@1 | 191 | /** |
duke@1 | 192 | * Print the package use list. |
duke@1 | 193 | */ |
duke@1 | 194 | protected void generatePackageUse(PackageDoc pkg) throws IOException { |
duke@1 | 195 | trBgcolorStyle("white", "TableRowColor"); |
duke@1 | 196 | summaryRow(0); |
duke@1 | 197 | //Just want an anchor here. |
duke@1 | 198 | printHyperLink("", pkg.name(), Util.getPackageName(pkg), true); |
duke@1 | 199 | summaryRowEnd(); |
duke@1 | 200 | summaryRow(0); |
duke@1 | 201 | if (pkg != null) { |
duke@1 | 202 | printSummaryComment(pkg); |
duke@1 | 203 | } |
duke@1 | 204 | space(); |
duke@1 | 205 | summaryRowEnd(); |
duke@1 | 206 | trEnd(); |
duke@1 | 207 | } |
duke@1 | 208 | |
duke@1 | 209 | /** |
duke@1 | 210 | * Print the header for the class use Listing. |
duke@1 | 211 | */ |
duke@1 | 212 | protected void printPackageUseHeader() { |
duke@1 | 213 | String packageLabel = configuration.getText("doclet.Package"); |
duke@1 | 214 | String name = pkgdoc.name(); |
duke@1 | 215 | printHtmlHeader(configuration.getText("doclet.Window_ClassUse_Header", |
duke@1 | 216 | packageLabel, name), null, true); |
duke@1 | 217 | printTop(); |
duke@1 | 218 | navLinks(true); |
duke@1 | 219 | hr(); |
duke@1 | 220 | center(); |
duke@1 | 221 | h2(); |
duke@1 | 222 | boldText("doclet.ClassUse_Title", packageLabel, name); |
duke@1 | 223 | h2End(); |
duke@1 | 224 | centerEnd(); |
duke@1 | 225 | } |
duke@1 | 226 | |
duke@1 | 227 | /** |
duke@1 | 228 | * Print the footer for the class use Listing. |
duke@1 | 229 | */ |
duke@1 | 230 | protected void printPackageUseFooter() { |
duke@1 | 231 | hr(); |
duke@1 | 232 | navLinks(false); |
duke@1 | 233 | printBottom(); |
duke@1 | 234 | printBodyHtmlEnd(); |
duke@1 | 235 | } |
duke@1 | 236 | |
duke@1 | 237 | |
duke@1 | 238 | /** |
duke@1 | 239 | * Print this package link |
duke@1 | 240 | */ |
duke@1 | 241 | protected void navLinkPackage() { |
duke@1 | 242 | navCellStart(); |
duke@1 | 243 | printHyperLink("package-summary.html", "", configuration.getText("doclet.Package"), |
duke@1 | 244 | true, "NavBarFont1"); |
duke@1 | 245 | navCellEnd(); |
duke@1 | 246 | } |
duke@1 | 247 | |
duke@1 | 248 | /** |
duke@1 | 249 | * Print class use link |
duke@1 | 250 | */ |
duke@1 | 251 | protected void navLinkClassUse() { |
duke@1 | 252 | navCellRevStart(); |
duke@1 | 253 | fontStyle("NavBarFont1Rev"); |
duke@1 | 254 | boldText("doclet.navClassUse"); |
duke@1 | 255 | fontEnd(); |
duke@1 | 256 | navCellEnd(); |
duke@1 | 257 | } |
duke@1 | 258 | |
duke@1 | 259 | protected void navLinkTree() { |
duke@1 | 260 | navCellStart(); |
duke@1 | 261 | printHyperLink("package-tree.html", "", configuration.getText("doclet.Tree"), |
duke@1 | 262 | true, "NavBarFont1"); |
duke@1 | 263 | navCellEnd(); |
duke@1 | 264 | } |
duke@1 | 265 | |
duke@1 | 266 | } |