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 class usage information. duke@1: * duke@1: * @author Robert G. Field duke@1: */ duke@1: public class ClassUseWriter extends SubWriterHolderWriter { duke@1: duke@1: final ClassDoc classdoc; mcimadamore@184: Set pkgToPackageAnnotations = null; jjg@74: final Map> pkgToClassTypeParameter; jjg@74: final Map> pkgToClassAnnotations; jjg@74: final Map> pkgToMethodTypeParameter; jjg@74: final Map> pkgToMethodArgTypeParameter; jjg@74: final Map> pkgToMethodReturnTypeParameter; jjg@74: final Map> pkgToMethodAnnotations; jjg@74: final Map> pkgToMethodParameterAnnotations; jjg@74: final Map> pkgToFieldTypeParameter; jjg@74: final Map> pkgToFieldAnnotations; jjg@74: final Map> pkgToSubclass; jjg@74: final Map> pkgToSubinterface; jjg@74: final Map> pkgToImplementingClass; jjg@74: final Map> pkgToField; jjg@74: final Map> pkgToMethodReturn; jjg@74: final Map> pkgToMethodArgs; jjg@74: final Map> pkgToMethodThrows; jjg@74: final Map> pkgToConstructorAnnotations; jjg@74: final Map> pkgToConstructorParameterAnnotations; jjg@74: final Map> pkgToConstructorArgs; jjg@74: final Map> pkgToConstructorArgTypeParameter; jjg@74: final Map> pkgToConstructorThrows; jjg@74: final SortedSet pkgSet; duke@1: final MethodWriterImpl methodSubWriter; duke@1: final ConstructorWriterImpl constrSubWriter; duke@1: final FieldWriterImpl fieldSubWriter; duke@1: final NestedClassWriterImpl classSubWriter; duke@1: 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 ClassUseWriter(ConfigurationImpl configuration, duke@1: ClassUseMapper mapper, String path, duke@1: String filename, String relpath, duke@1: ClassDoc classdoc) throws IOException { duke@1: super(configuration, path, filename, relpath); duke@1: this.classdoc = classdoc; duke@1: if (mapper.classToPackageAnnotations.containsKey(classdoc.qualifiedName())) jjg@74: pkgToPackageAnnotations = new HashSet(mapper.classToPackageAnnotations.get(classdoc.qualifiedName())); duke@1: configuration.currentcd = classdoc; jjg@74: this.pkgSet = new TreeSet(); duke@1: this.pkgToClassTypeParameter = pkgDivide(mapper.classToClassTypeParam); duke@1: this.pkgToClassAnnotations = pkgDivide(mapper.classToClassAnnotations); duke@1: this.pkgToMethodTypeParameter = pkgDivide(mapper.classToExecMemberDocTypeParam); duke@1: this.pkgToMethodArgTypeParameter = pkgDivide(mapper.classToExecMemberDocArgTypeParam); duke@1: this.pkgToFieldTypeParameter = pkgDivide(mapper.classToFieldDocTypeParam); duke@1: this.pkgToFieldAnnotations = pkgDivide(mapper.annotationToFieldDoc); duke@1: this.pkgToMethodReturnTypeParameter = pkgDivide(mapper.classToExecMemberDocReturnTypeParam); duke@1: this.pkgToMethodAnnotations = pkgDivide(mapper.classToExecMemberDocAnnotations); duke@1: this.pkgToMethodParameterAnnotations = pkgDivide(mapper.classToExecMemberDocParamAnnotation); duke@1: this.pkgToSubclass = pkgDivide(mapper.classToSubclass); duke@1: this.pkgToSubinterface = pkgDivide(mapper.classToSubinterface); duke@1: this.pkgToImplementingClass = pkgDivide(mapper.classToImplementingClass); duke@1: this.pkgToField = pkgDivide(mapper.classToField); duke@1: this.pkgToMethodReturn = pkgDivide(mapper.classToMethodReturn); duke@1: this.pkgToMethodArgs = pkgDivide(mapper.classToMethodArgs); duke@1: this.pkgToMethodThrows = pkgDivide(mapper.classToMethodThrows); duke@1: this.pkgToConstructorAnnotations = pkgDivide(mapper.classToConstructorAnnotations); duke@1: this.pkgToConstructorParameterAnnotations = pkgDivide(mapper.classToConstructorParamAnnotation); duke@1: this.pkgToConstructorArgs = pkgDivide(mapper.classToConstructorArgs); duke@1: this.pkgToConstructorArgTypeParameter = pkgDivide(mapper.classToConstructorDocArgTypeParam); duke@1: this.pkgToConstructorThrows = pkgDivide(mapper.classToConstructorThrows); duke@1: //tmp test duke@1: if (pkgSet.size() > 0 && duke@1: mapper.classToPackage.containsKey(classdoc.qualifiedName()) && duke@1: !pkgSet.equals(mapper.classToPackage.get(classdoc.qualifiedName()))) { duke@1: configuration.root.printWarning("Internal error: package sets don't match: " + pkgSet + " with: " + duke@1: mapper.classToPackage.get(classdoc.qualifiedName())); duke@1: } duke@1: methodSubWriter = new MethodWriterImpl(this); duke@1: constrSubWriter = new ConstructorWriterImpl(this); duke@1: fieldSubWriter = new FieldWriterImpl(this); duke@1: classSubWriter = new NestedClassWriterImpl(this); duke@1: } duke@1: duke@1: /** duke@1: * Write out class use pages. duke@1: * @throws DocletAbortException duke@1: */ duke@1: public static void generate(ConfigurationImpl configuration, duke@1: ClassTree classtree) { duke@1: ClassUseMapper mapper = new ClassUseMapper(configuration.root, classtree); duke@1: ClassDoc[] classes = configuration.root.classes(); duke@1: for (int i = 0; i < classes.length; i++) { duke@1: ClassUseWriter.generate(configuration, mapper, classes[i]); duke@1: } duke@1: PackageDoc[] pkgs = configuration.packages; duke@1: for (int i = 0; i < pkgs.length; i++) { duke@1: PackageUseWriter.generate(configuration, mapper, pkgs[i]); duke@1: } duke@1: } duke@1: jjg@74: private Map> pkgDivide(Map> classMap) { jjg@74: Map> map = new HashMap>(); jjg@74: List list= classMap.get(classdoc.qualifiedName()); duke@1: if (list != null) { duke@1: Collections.sort(list); jjg@74: Iterator it = list.iterator(); duke@1: while (it.hasNext()) { jjg@74: ProgramElementDoc doc = it.next(); duke@1: PackageDoc pkg = doc.containingPackage(); duke@1: pkgSet.add(pkg); jjg@74: List inPkg = map.get(pkg.name()); duke@1: if (inPkg == null) { jjg@74: inPkg = new ArrayList(); duke@1: map.put(pkg.name(), inPkg); duke@1: } duke@1: inPkg.add(doc); duke@1: } duke@1: } duke@1: return map; duke@1: } duke@1: duke@1: /** duke@1: * Generate a class page. duke@1: */ duke@1: public static void generate(ConfigurationImpl configuration, duke@1: ClassUseMapper mapper, ClassDoc classdoc) { duke@1: ClassUseWriter clsgen; duke@1: String path = DirectoryManager.getDirectoryPath(classdoc. duke@1: containingPackage()); duke@1: if (path.length() > 0) { duke@1: path += File.separator; duke@1: } duke@1: path += "class-use"; duke@1: String filename = classdoc.name() + ".html"; duke@1: String pkgname = classdoc.containingPackage().name(); duke@1: pkgname += (pkgname.length() > 0)? ".class-use": "class-use"; duke@1: String relpath = DirectoryManager.getRelativePath(pkgname); duke@1: try { duke@1: clsgen = new ClassUseWriter(configuration, duke@1: mapper, path, filename, duke@1: relpath, classdoc); duke@1: clsgen.generateClassUseFile(); duke@1: clsgen.close(); duke@1: } catch (IOException exc) { duke@1: configuration.standardmessage. duke@1: error("doclet.exception_encountered", duke@1: exc.toString(), filename); duke@1: throw new DocletAbortException(); duke@1: } duke@1: } duke@1: duke@1: /** duke@1: * Print the class use list. duke@1: */ duke@1: protected void generateClassUseFile() throws IOException { duke@1: duke@1: printClassUseHeader(); duke@1: duke@1: if (pkgSet.size() > 0) { duke@1: generateClassUse(); duke@1: } else { duke@1: printText("doclet.ClassUse_No.usage.of.0", duke@1: classdoc.qualifiedName()); duke@1: p(); duke@1: } duke@1: duke@1: printClassUseFooter(); duke@1: } duke@1: duke@1: protected void generateClassUse() throws IOException { duke@1: if (configuration.packages.length > 1) { duke@1: generatePackageList(); duke@1: generatePackageAnnotationList(); 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: getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc, duke@1: false))); duke@1: tableHeaderEnd(); duke@1: mcimadamore@184: for (Iterator it = pkgSet.iterator(); it.hasNext();) { mcimadamore@184: PackageDoc pkg = 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 generatePackageAnnotationList() throws IOException { duke@1: if ((! classdoc.isAnnotationType()) || duke@1: pkgToPackageAnnotations == null || duke@1: pkgToPackageAnnotations.size() == 0) duke@1: return; duke@1: tableIndexSummary(); duke@1: tableHeaderStart("#CCCCFF"); duke@1: printText("doclet.ClassUse_PackageAnnotation", duke@1: getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc, duke@1: false))); duke@1: tableHeaderEnd(); mcimadamore@184: for (Iterator it = pkgToPackageAnnotations.iterator(); it.hasNext();) { mcimadamore@184: PackageDoc pkg = it.next(); duke@1: trBgcolorStyle("white", "TableRowColor"); duke@1: summaryRow(0); duke@1: //Just want an anchor here. duke@1: printPackageLink(pkg, pkg.name(), true); duke@1: summaryRowEnd(); duke@1: summaryRow(0); duke@1: printSummaryComment(pkg); duke@1: space(); duke@1: summaryRowEnd(); duke@1: trEnd(); duke@1: } duke@1: tableEnd(); duke@1: space(); duke@1: p(); duke@1: } duke@1: duke@1: protected void generateClassList() throws IOException { mcimadamore@184: for (Iterator it = pkgSet.iterator(); it.hasNext();) { mcimadamore@184: PackageDoc pkg = it.next(); duke@1: anchor(pkg.name()); duke@1: tableIndexSummary(); duke@1: tableHeaderStart("#CCCCFF"); duke@1: printText("doclet.ClassUse_Uses.of.0.in.1", duke@1: getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, duke@1: classdoc, false)), duke@1: getPackageLink(pkg, Util.getPackageName(pkg), false)); duke@1: tableHeaderEnd(); duke@1: tableEnd(); duke@1: space(); duke@1: p(); duke@1: generateClassUse(pkg); duke@1: } 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: printSummaryComment(pkg); duke@1: space(); duke@1: summaryRowEnd(); duke@1: trEnd(); duke@1: } duke@1: duke@1: /** duke@1: * Print the class use list. duke@1: */ duke@1: protected void generateClassUse(PackageDoc pkg) throws IOException { duke@1: String classLink = getLink(new LinkInfoImpl( duke@1: LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc, false)); duke@1: String pkgLink = getPackageLink(pkg, Util.getPackageName(pkg), false); duke@1: classSubWriter.printUseInfo(pkgToClassAnnotations.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_Annotation", classLink, duke@1: pkgLink)); duke@1: duke@1: classSubWriter.printUseInfo(pkgToClassTypeParameter.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_TypeParameter", classLink, duke@1: pkgLink)); duke@1: classSubWriter.printUseInfo(pkgToSubclass.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_Subclass", classLink, duke@1: pkgLink)); duke@1: classSubWriter.printUseInfo(pkgToSubinterface.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_Subinterface", duke@1: classLink, duke@1: pkgLink)); duke@1: classSubWriter.printUseInfo(pkgToImplementingClass.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_ImplementingClass", duke@1: classLink, duke@1: pkgLink)); duke@1: fieldSubWriter.printUseInfo(pkgToField.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_Field", duke@1: classLink, duke@1: pkgLink)); duke@1: fieldSubWriter.printUseInfo(pkgToFieldAnnotations.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_FieldAnnotations", duke@1: classLink, duke@1: pkgLink)); duke@1: fieldSubWriter.printUseInfo(pkgToFieldTypeParameter.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_FieldTypeParameter", duke@1: classLink, duke@1: pkgLink)); duke@1: methodSubWriter.printUseInfo(pkgToMethodAnnotations.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_MethodAnnotations", classLink, duke@1: pkgLink)); duke@1: methodSubWriter.printUseInfo(pkgToMethodParameterAnnotations.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_MethodParameterAnnotations", classLink, duke@1: pkgLink)); duke@1: methodSubWriter.printUseInfo(pkgToMethodTypeParameter.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_MethodTypeParameter", classLink, duke@1: pkgLink)); duke@1: methodSubWriter.printUseInfo(pkgToMethodReturn.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_MethodReturn", duke@1: classLink, duke@1: pkgLink)); duke@1: methodSubWriter.printUseInfo(pkgToMethodReturnTypeParameter.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_MethodReturnTypeParameter", classLink, duke@1: pkgLink)); duke@1: methodSubWriter.printUseInfo(pkgToMethodArgs.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_MethodArgs", duke@1: classLink, duke@1: pkgLink)); duke@1: methodSubWriter.printUseInfo(pkgToMethodArgTypeParameter.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_MethodArgsTypeParameters", duke@1: classLink, duke@1: pkgLink)); duke@1: methodSubWriter.printUseInfo(pkgToMethodThrows.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_MethodThrows", duke@1: classLink, duke@1: pkgLink)); duke@1: constrSubWriter.printUseInfo(pkgToConstructorAnnotations.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_ConstructorAnnotations", duke@1: classLink, duke@1: pkgLink)); duke@1: constrSubWriter.printUseInfo(pkgToConstructorParameterAnnotations.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_ConstructorParameterAnnotations", duke@1: classLink, duke@1: pkgLink)); duke@1: constrSubWriter.printUseInfo(pkgToConstructorArgs.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_ConstructorArgs", duke@1: classLink, duke@1: pkgLink)); duke@1: constrSubWriter.printUseInfo(pkgToConstructorArgTypeParameter.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_ConstructorArgsTypeParameters", duke@1: classLink, duke@1: pkgLink)); duke@1: constrSubWriter.printUseInfo(pkgToConstructorThrows.get(pkg.name()), duke@1: configuration.getText("doclet.ClassUse_ConstructorThrows", duke@1: classLink, duke@1: pkgLink)); duke@1: } duke@1: duke@1: /** duke@1: * Print the header for the class use Listing. duke@1: */ duke@1: protected void printClassUseHeader() { duke@1: String cltype = configuration.getText(classdoc.isInterface()? duke@1: "doclet.Interface": duke@1: "doclet.Class"); duke@1: String clname = classdoc.qualifiedName(); duke@1: printHtmlHeader(configuration.getText("doclet.Window_ClassUse_Header", duke@1: cltype, clname), null, true); duke@1: printTop(); duke@1: navLinks(true); duke@1: hr(); duke@1: center(); duke@1: h2(); bpatel@182: strongText("doclet.ClassUse_Title", cltype, clname); 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 printClassUseFooter() { 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", "", duke@1: configuration.getText("doclet.Package"), true, "NavBarFont1"); duke@1: navCellEnd(); duke@1: } duke@1: duke@1: /** duke@1: * Print class page indicator duke@1: */ duke@1: protected void navLinkClass() { duke@1: navCellStart(); duke@1: printLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc, "", duke@1: configuration.getText("doclet.Class"), 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: if (classdoc.containingPackage().isIncluded()) { duke@1: printHyperLink("../package-tree.html", "", duke@1: configuration.getText("doclet.Tree"), true, "NavBarFont1"); duke@1: } else { duke@1: printHyperLink(relativePath + "overview-tree.html", "", duke@1: configuration.getText("doclet.Tree"), true, "NavBarFont1"); duke@1: } duke@1: navCellEnd(); duke@1: } duke@1: duke@1: }