1 /* 2 * Copyright (c) 1998, 2020, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package jdk.javadoc.internal.doclets.formats.html; 27 28 import java.util.Set; 29 import java.util.SortedMap; 30 import java.util.TreeMap; 31 import java.util.TreeSet; 32 33 import javax.lang.model.element.Element; 34 import javax.lang.model.element.PackageElement; 35 import javax.lang.model.element.TypeElement; 36 37 import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder; 38 import jdk.javadoc.internal.doclets.formats.html.markup.Entity; 39 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle; 40 import jdk.javadoc.internal.doclets.formats.html.markup.TagName; 41 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree; 42 import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode; 43 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent; 44 import jdk.javadoc.internal.doclets.formats.html.markup.Table; 45 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader; 46 import jdk.javadoc.internal.doclets.toolkit.Content; 47 import jdk.javadoc.internal.doclets.toolkit.util.ClassUseMapper; 48 import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; 49 import jdk.javadoc.internal.doclets.toolkit.util.DocPath; 50 import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; 51 52 /** 53 * Generate package usage information. 54 * 55 * <p><b>This is NOT part of any supported API. 56 * If you write code that depends on this, you do so at your own risk. 57 * This code and its internal interfaces are subject to change or 58 * deletion without notice.</b> 59 */ 60 public class PackageUseWriter extends SubWriterHolderWriter { 61 62 final PackageElement packageElement; 63 final SortedMap<String, Set<TypeElement>> usingPackageToUsedClasses = new TreeMap<>(); 64 65 /** 66 * Constructor. 67 * 68 * @param configuration the configuration 69 * @param mapper a mapper to provide details of where elements are used 70 * @param filename the file to be generated 71 * @param pkgElement the package element to be documented 72 */ PackageUseWriter(HtmlConfiguration configuration, ClassUseMapper mapper, DocPath filename, PackageElement pkgElement)73 public PackageUseWriter(HtmlConfiguration configuration, 74 ClassUseMapper mapper, DocPath filename, 75 PackageElement pkgElement) { 76 super(configuration, configuration.docPaths.forPackage(pkgElement).resolve(filename)); 77 this.packageElement = pkgElement; 78 79 // by examining all classes in this package, find what packages 80 // use these classes - produce a map between using package and 81 // used classes. 82 for (TypeElement usedClass : utils.getEnclosedTypeElements(pkgElement)) { 83 Set<TypeElement> usingClasses = mapper.classToClass.get(usedClass); 84 if (usingClasses != null) { 85 for (TypeElement usingClass : usingClasses) { 86 PackageElement usingPackage = utils.containingPackage(usingClass); 87 Set<TypeElement> usedClasses = usingPackageToUsedClasses 88 .get(utils.getPackageName(usingPackage)); 89 if (usedClasses == null) { 90 usedClasses = new TreeSet<>(comparators.makeGeneralPurposeComparator()); 91 usingPackageToUsedClasses.put(utils.getPackageName(usingPackage), 92 usedClasses); 93 } 94 usedClasses.add(usedClass); 95 } 96 } 97 } 98 } 99 100 /** 101 * Generate a class page. 102 * 103 * @param configuration the current configuration of the doclet. 104 * @param mapper the mapping of the class usage. 105 * @param pkgElement the package being documented. 106 * @throws DocFileIOException if there is a problem generating the package use page 107 */ generate(HtmlConfiguration configuration, ClassUseMapper mapper, PackageElement pkgElement)108 public static void generate(HtmlConfiguration configuration, 109 ClassUseMapper mapper, PackageElement pkgElement) 110 throws DocFileIOException { 111 DocPath filename = DocPaths.PACKAGE_USE; 112 PackageUseWriter pkgusegen = new PackageUseWriter(configuration, mapper, filename, pkgElement); 113 pkgusegen.generatePackageUseFile(); 114 } 115 116 /** 117 * Generate the package use list. 118 * @throws DocFileIOException if there is a problem generating the package use page 119 */ generatePackageUseFile()120 protected void generatePackageUseFile() throws DocFileIOException { 121 HtmlTree body = getPackageUseHeader(); 122 Content mainContent = new ContentBuilder(); 123 if (usingPackageToUsedClasses.isEmpty()) { 124 mainContent.add(contents.getContent("doclet.ClassUse_No.usage.of.0", utils.getPackageName(packageElement))); 125 } else { 126 addPackageUse(mainContent); 127 } 128 bodyContents.addMainContent(mainContent); 129 bodyContents.setFooter(getFooter()); 130 body.add(bodyContents); 131 printHtmlDocument(null, 132 getDescription("use", packageElement), 133 body); 134 } 135 136 /** 137 * Add the package use information. 138 * 139 * @param contentTree the content tree to which the package use information will be added 140 */ addPackageUse(Content contentTree)141 protected void addPackageUse(Content contentTree) { 142 Content content = new ContentBuilder(); 143 if (configuration.packages.size() > 1) { 144 addPackageList(content); 145 } 146 addClassList(content); 147 contentTree.add(content); 148 } 149 150 /** 151 * Add the list of packages that use the given package. 152 * 153 * @param contentTree the content tree to which the package list will be added 154 */ addPackageList(Content contentTree)155 protected void addPackageList(Content contentTree) { 156 Content caption = contents.getContent( 157 "doclet.ClassUse_Packages.that.use.0", 158 getPackageLink(packageElement, utils.getPackageName(packageElement))); 159 Table table = new Table(HtmlStyle.summaryTable) 160 .setCaption(caption) 161 .setHeader(getPackageTableHeader()) 162 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast); 163 for (String pkgname: usingPackageToUsedClasses.keySet()) { 164 PackageElement pkg = utils.elementUtils.getPackageElement(pkgname); 165 Content packageLink = links.createLink(getPackageAnchorName(pkg), 166 new StringContent(utils.getPackageName(pkg))); 167 Content summary = new ContentBuilder(); 168 if (pkg != null && !pkg.isUnnamed()) { 169 addSummaryComment(pkg, summary); 170 } else { 171 summary.add(Entity.NO_BREAK_SPACE); 172 } 173 table.addRow(packageLink, summary); 174 } 175 contentTree.add(table); 176 } 177 178 /** 179 * Add the list of classes that use the given package. 180 * 181 * @param contentTree the content tree to which the class list will be added 182 */ addClassList(Content contentTree)183 protected void addClassList(Content contentTree) { 184 TableHeader classTableHeader = new TableHeader( 185 contents.classLabel, contents.descriptionLabel); 186 HtmlTree ul = new HtmlTree(TagName.UL); 187 ul.setStyle(HtmlStyle.blockList); 188 for (String packageName : usingPackageToUsedClasses.keySet()) { 189 PackageElement usingPackage = utils.elementUtils.getPackageElement(packageName); 190 HtmlTree section = HtmlTree.SECTION(HtmlStyle.detail) 191 .setId(getPackageAnchorName(usingPackage)); 192 Content caption = contents.getContent( 193 "doclet.ClassUse_Classes.in.0.used.by.1", 194 getPackageLink(packageElement, utils.getPackageName(packageElement)), 195 getPackageLink(usingPackage, utils.getPackageName(usingPackage))); 196 Table table = new Table(HtmlStyle.summaryTable) 197 .setCaption(caption) 198 .setHeader(classTableHeader) 199 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast); 200 for (TypeElement te : usingPackageToUsedClasses.get(packageName)) { 201 DocPath dp = pathString(te, 202 DocPaths.CLASS_USE.resolve(docPaths.forName(te))); 203 Content stringContent = new StringContent(utils.getSimpleName(te)); 204 Content typeContent = links.createLink(dp.fragment(getPackageAnchorName(usingPackage)), 205 stringContent); 206 Content summary = new ContentBuilder(); 207 addIndexComment(te, summary); 208 209 table.addRow(typeContent, summary); 210 } 211 section.add(table); 212 ul.add(HtmlTree.LI(section)); 213 } 214 Content li = HtmlTree.SECTION(HtmlStyle.packageUses, ul); 215 contentTree.add(li); 216 } 217 218 /** 219 * Get the header for the package use listing. 220 * 221 * @return a content tree representing the package use header 222 */ getPackageUseHeader()223 private HtmlTree getPackageUseHeader() { 224 String packageText = resources.getText("doclet.Package"); 225 String name = packageElement.isUnnamed() ? "" : utils.getPackageName(packageElement); 226 String title = resources.getText("doclet.Window_ClassUse_Header", packageText, name); 227 HtmlTree bodyTree = getBody(getWindowTitle(title)); 228 ContentBuilder headingContent = new ContentBuilder(); 229 headingContent.add(contents.getContent("doclet.ClassUse_Title", packageText)); 230 headingContent.add(new HtmlTree(TagName.BR)); 231 headingContent.add(name); 232 Content heading = HtmlTree.HEADING_TITLE(Headings.PAGE_TITLE_HEADING, 233 HtmlStyle.title, headingContent); 234 Content div = HtmlTree.DIV(HtmlStyle.header, heading); 235 bodyContents.setHeader(getHeader(PageMode.USE, packageElement)) 236 .addMainContent(div); 237 return bodyTree; 238 } 239 240 @Override getNavBar(PageMode pageMode, Element element)241 protected Navigation getNavBar(PageMode pageMode, Element element) { 242 Content linkContent = getModuleLink(utils.elementUtils.getModuleOf(element), 243 contents.moduleLabel); 244 return super.getNavBar(pageMode, element) 245 .setNavLinkModule(linkContent); 246 } 247 } 248