Thu, 13 Jan 2011 21:28:38 -0800
7010528: javadoc performance regression
Reviewed-by: jjg
duke@1 | 1 | /* |
ohair@798 | 2 | * Copyright (c) 1997, 2010, Oracle and/or its affiliates. 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 |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle 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 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.formats.html; |
duke@1 | 27 | |
duke@1 | 28 | import java.io.*; |
duke@1 | 29 | import java.util.*; |
bpatel@766 | 30 | import com.sun.javadoc.*; |
bpatel@766 | 31 | import com.sun.tools.doclets.internal.toolkit.*; |
bpatel@766 | 32 | import com.sun.tools.doclets.internal.toolkit.util.*; |
bpatel@766 | 33 | import com.sun.tools.doclets.formats.html.markup.*; |
duke@1 | 34 | |
duke@1 | 35 | /** |
duke@1 | 36 | * Generate the package index page "overview-summary.html" for the right-hand |
duke@1 | 37 | * frame. A click on the package name on this page will update the same frame |
duke@1 | 38 | * with the "pacakge-summary.html" file for the clicked package. |
duke@1 | 39 | * |
duke@1 | 40 | * @author Atul M Dambalkar |
bpatel@243 | 41 | * @author Bhavesh Patel (Modified) |
duke@1 | 42 | */ |
duke@1 | 43 | public class PackageIndexWriter extends AbstractPackageIndexWriter { |
duke@1 | 44 | |
duke@1 | 45 | /** |
duke@1 | 46 | * Root of the program structure. Used for "overview" documentation. |
duke@1 | 47 | */ |
duke@1 | 48 | private RootDoc root; |
duke@1 | 49 | |
duke@1 | 50 | /** |
duke@1 | 51 | * Map representing the group of packages as specified on the command line. |
duke@1 | 52 | * |
duke@1 | 53 | * @see Group |
duke@1 | 54 | */ |
jjg@74 | 55 | private Map<String,List<PackageDoc>> groupPackageMap; |
duke@1 | 56 | |
duke@1 | 57 | /** |
duke@1 | 58 | * List to store the order groups as specified on the command line. |
duke@1 | 59 | */ |
mcimadamore@184 | 60 | private List<String> groupList; |
duke@1 | 61 | |
duke@1 | 62 | /** |
duke@1 | 63 | * Construct the PackageIndexWriter. Also constructs the grouping |
duke@1 | 64 | * information as provided on the command line by "-group" option. Stores |
duke@1 | 65 | * the order of groups specified by the user. |
duke@1 | 66 | * |
duke@1 | 67 | * @see Group |
duke@1 | 68 | */ |
duke@1 | 69 | public PackageIndexWriter(ConfigurationImpl configuration, |
duke@1 | 70 | String filename) |
duke@1 | 71 | throws IOException { |
duke@1 | 72 | super(configuration, filename); |
duke@1 | 73 | this.root = configuration.root; |
duke@1 | 74 | groupPackageMap = configuration.group.groupPackages(packages); |
duke@1 | 75 | groupList = configuration.group.getGroupList(); |
duke@1 | 76 | } |
duke@1 | 77 | |
duke@1 | 78 | /** |
duke@1 | 79 | * Generate the package index page for the right-hand frame. |
duke@1 | 80 | * |
duke@1 | 81 | * @param configuration the current configuration of the doclet. |
duke@1 | 82 | */ |
duke@1 | 83 | public static void generate(ConfigurationImpl configuration) { |
duke@1 | 84 | PackageIndexWriter packgen; |
duke@1 | 85 | String filename = "overview-summary.html"; |
duke@1 | 86 | try { |
duke@1 | 87 | packgen = new PackageIndexWriter(configuration, filename); |
bpatel@766 | 88 | packgen.buildPackageIndexFile("doclet.Window_Overview_Summary", true); |
duke@1 | 89 | packgen.close(); |
duke@1 | 90 | } catch (IOException exc) { |
duke@1 | 91 | configuration.standardmessage.error( |
duke@1 | 92 | "doclet.exception_encountered", |
duke@1 | 93 | exc.toString(), filename); |
duke@1 | 94 | throw new DocletAbortException(); |
duke@1 | 95 | } |
duke@1 | 96 | } |
duke@1 | 97 | |
duke@1 | 98 | /** |
bpatel@766 | 99 | * Depending upon the grouping information and their titles, add |
bpatel@766 | 100 | * separate table indices for each package group. |
duke@1 | 101 | * |
bpatel@766 | 102 | * @param body the documentation tree to which the index will be added |
duke@1 | 103 | */ |
bpatel@766 | 104 | protected void addIndex(Content body) { |
duke@1 | 105 | for (int i = 0; i < groupList.size(); i++) { |
jjg@198 | 106 | String groupname = groupList.get(i); |
jjg@74 | 107 | List<PackageDoc> list = groupPackageMap.get(groupname); |
duke@1 | 108 | if (list != null && list.size() > 0) { |
bpatel@766 | 109 | addIndexContents(list.toArray(new PackageDoc[list.size()]), |
bpatel@766 | 110 | groupname, configuration.getText("doclet.Member_Table_Summary", |
bpatel@766 | 111 | groupname, configuration.getText("doclet.packages")), body); |
duke@1 | 112 | } |
duke@1 | 113 | } |
duke@1 | 114 | } |
duke@1 | 115 | |
duke@1 | 116 | /** |
bpatel@766 | 117 | * {@inheritDoc} |
duke@1 | 118 | */ |
bpatel@766 | 119 | protected void addPackagesList(PackageDoc[] packages, String text, |
bpatel@766 | 120 | String tableSummary, Content body) { |
bpatel@766 | 121 | Content table = HtmlTree.TABLE(HtmlStyle.overviewSummary, 0, 3, 0, tableSummary, |
bpatel@766 | 122 | getTableCaption(text)); |
bpatel@766 | 123 | table.addContent(getSummaryTableHeader(packageTableHeader, "col")); |
bpatel@766 | 124 | Content tbody = new HtmlTree(HtmlTag.TBODY); |
bpatel@766 | 125 | addPackagesList(packages, tbody); |
bpatel@766 | 126 | table.addContent(tbody); |
bpatel@766 | 127 | Content div = HtmlTree.DIV(HtmlStyle.contentContainer, table); |
bpatel@766 | 128 | body.addContent(div); |
bpatel@766 | 129 | } |
bpatel@766 | 130 | |
bpatel@766 | 131 | /** |
bpatel@766 | 132 | * Adds list of packages in the index table. Generate link to each package. |
bpatel@766 | 133 | * |
bpatel@766 | 134 | * @param packages Packages to which link is to be generated |
bpatel@766 | 135 | * @param tbody the documentation tree to which the list will be added |
bpatel@766 | 136 | */ |
bpatel@766 | 137 | protected void addPackagesList(PackageDoc[] packages, Content tbody) { |
bpatel@766 | 138 | for (int i = 0; i < packages.length; i++) { |
bpatel@766 | 139 | if (packages[i] != null && packages[i].name().length() > 0) { |
bpatel@766 | 140 | Content packageLinkContent = getPackageLink(packages[i], |
bpatel@766 | 141 | getPackageName(packages[i])); |
bpatel@766 | 142 | Content tdPackage = HtmlTree.TD(HtmlStyle.colFirst, packageLinkContent); |
bpatel@766 | 143 | HtmlTree tdSummary = new HtmlTree(HtmlTag.TD); |
bpatel@766 | 144 | tdSummary.addStyle(HtmlStyle.colLast); |
bpatel@766 | 145 | addSummaryComment(packages[i], tdSummary); |
bpatel@766 | 146 | HtmlTree tr = HtmlTree.TR(tdPackage); |
bpatel@766 | 147 | tr.addContent(tdSummary); |
bpatel@766 | 148 | if (i%2 == 0) |
bpatel@766 | 149 | tr.addStyle(HtmlStyle.altColor); |
bpatel@766 | 150 | else |
bpatel@766 | 151 | tr.addStyle(HtmlStyle.rowColor); |
bpatel@766 | 152 | tbody.addContent(tr); |
bpatel@766 | 153 | } |
duke@1 | 154 | } |
duke@1 | 155 | } |
duke@1 | 156 | |
duke@1 | 157 | /** |
bpatel@766 | 158 | * Adds the overview summary comment for this documentation. Add one line |
bpatel@766 | 159 | * summary at the top of the page and generate a link to the description, |
bpatel@766 | 160 | * which is added at the end of this page. |
bpatel@766 | 161 | * |
bpatel@766 | 162 | * @param body the documentation tree to which the overview header will be added |
duke@1 | 163 | */ |
bpatel@766 | 164 | protected void addOverviewHeader(Content body) { |
duke@1 | 165 | if (root.inlineTags().length > 0) { |
bpatel@766 | 166 | HtmlTree p = new HtmlTree(HtmlTag.P); |
bpatel@766 | 167 | p.addStyle(HtmlStyle.subTitle); |
bpatel@766 | 168 | addSummaryComment(root, p); |
bpatel@766 | 169 | Content div = HtmlTree.DIV(HtmlStyle.header, p); |
bpatel@766 | 170 | Content see = seeLabel; |
bpatel@766 | 171 | see.addContent(" "); |
bpatel@766 | 172 | Content descPara = HtmlTree.P(see); |
bpatel@766 | 173 | Content descLink = getHyperLink("", "overview_description", |
bpatel@766 | 174 | descriptionLabel, "", ""); |
bpatel@766 | 175 | descPara.addContent(descLink); |
bpatel@766 | 176 | div.addContent(descPara); |
bpatel@766 | 177 | body.addContent(div); |
duke@1 | 178 | } |
duke@1 | 179 | } |
duke@1 | 180 | |
duke@1 | 181 | /** |
bpatel@766 | 182 | * Adds the overview comment as provided in the file specified by the |
bpatel@766 | 183 | * "-overview" option on the command line. |
bpatel@766 | 184 | * |
bpatel@766 | 185 | * @param htmltree the documentation tree to which the overview comment will |
bpatel@766 | 186 | * be added |
duke@1 | 187 | */ |
bpatel@766 | 188 | protected void addOverviewComment(Content htmltree) { |
bpatel@766 | 189 | if (root.inlineTags().length > 0) { |
bpatel@766 | 190 | htmltree.addContent(getMarkerAnchor("overview_description")); |
bpatel@766 | 191 | HtmlTree p = new HtmlTree(HtmlTag.P); |
bpatel@766 | 192 | p.addStyle(HtmlStyle.subTitle); |
bpatel@766 | 193 | addInlineComment(root, p); |
bpatel@766 | 194 | htmltree.addContent(p); |
bpatel@766 | 195 | } |
duke@1 | 196 | } |
duke@1 | 197 | |
duke@1 | 198 | /** |
bpatel@766 | 199 | * Adds the tag information as provided in the file specified by the |
bpatel@766 | 200 | * "-overview" option on the command line. |
bpatel@766 | 201 | * |
bpatel@766 | 202 | * @param body the documentation tree to which the overview will be added |
duke@1 | 203 | */ |
bpatel@766 | 204 | protected void addOverview(Content body) throws IOException { |
bpatel@766 | 205 | HtmlTree div = new HtmlTree(HtmlTag.DIV); |
bpatel@766 | 206 | div.addStyle(HtmlStyle.footer); |
bpatel@766 | 207 | addOverviewComment(div); |
bpatel@766 | 208 | addTagsInfo(root, div); |
bpatel@766 | 209 | body.addContent(div); |
duke@1 | 210 | } |
duke@1 | 211 | |
duke@1 | 212 | /** |
bpatel@766 | 213 | * Adds the top text (from the -top option), the upper |
bpatel@766 | 214 | * navigation bar, and then the title (from the"-title" |
bpatel@766 | 215 | * option), at the top of page. |
bpatel@766 | 216 | * |
bpatel@766 | 217 | * @body the documentation tree to which the navigation bar header will be added |
bpatel@766 | 218 | */ |
bpatel@766 | 219 | protected void addNavigationBarHeader(Content body) { |
bpatel@766 | 220 | addTop(body); |
bpatel@766 | 221 | addNavLinks(true, body); |
bpatel@766 | 222 | addConfigurationTitle(body); |
bpatel@766 | 223 | } |
bpatel@766 | 224 | |
bpatel@766 | 225 | /** |
bpatel@766 | 226 | * Adds the lower navigation bar and the bottom text |
duke@1 | 227 | * (from the -bottom option) at the bottom of page. |
bpatel@766 | 228 | * |
bpatel@766 | 229 | * @param the documentation tree to which the navigation bar footer will be added |
duke@1 | 230 | */ |
bpatel@766 | 231 | protected void addNavigationBarFooter(Content body) { |
bpatel@766 | 232 | addNavLinks(false, body); |
bpatel@766 | 233 | addBottom(body); |
duke@1 | 234 | } |
duke@1 | 235 | } |