Thu, 31 Aug 2017 15:17:03 +0800
merge
1 /*
2 * Copyright (c) 1998, 2013, 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 */
26 package com.sun.tools.doclets.formats.html;
28 import java.io.*;
29 import java.util.*;
31 import com.sun.javadoc.*;
32 import com.sun.tools.doclets.formats.html.markup.*;
33 import com.sun.tools.doclets.internal.toolkit.*;
34 import com.sun.tools.doclets.internal.toolkit.util.*;
36 /**
37 * Generate Index for all the Member Names with Indexing in
38 * Unicode Order. This class is a base class for {@link SingleIndexWriter} and
39 * {@link SplitIndexWriter}. It uses the functionality from
40 * {@link HtmlDocletWriter} to generate the Index Contents.
41 *
42 * <p><b>This is NOT part of any supported API.
43 * If you write code that depends on this, you do so at your own risk.
44 * This code and its internal interfaces are subject to change or
45 * deletion without notice.</b>
46 *
47 * @see IndexBuilder
48 * @author Atul M Dambalkar
49 * @author Bhavesh Patel (Modified)
50 */
51 public class AbstractIndexWriter extends HtmlDocletWriter {
53 /**
54 * The index of all the members with unicode character.
55 */
56 protected IndexBuilder indexbuilder;
58 /**
59 * This constructor will be used by {@link SplitIndexWriter}. Initializes
60 * path to this file and relative path from this file.
61 *
62 * @param configuration The current configuration
63 * @param path Path to the file which is getting generated.
64 * @param indexbuilder Unicode based Index from {@link IndexBuilder}
65 */
66 protected AbstractIndexWriter(ConfigurationImpl configuration,
67 DocPath path,
68 IndexBuilder indexbuilder)
69 throws IOException {
70 super(configuration, path);
71 this.indexbuilder = indexbuilder;
72 }
74 /**
75 * Get the index label for navigation bar.
76 *
77 * @return a content tree for the tree label
78 */
79 protected Content getNavLinkIndex() {
80 Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, indexLabel);
81 return li;
82 }
84 /**
85 * Add the member information for the unicode character along with the
86 * list of the members.
87 *
88 * @param unicode Unicode for which member list information to be generated
89 * @param memberlist List of members for the unicode character
90 * @param contentTree the content tree to which the information will be added
91 */
92 protected void addContents(Character uc, List<? extends Doc> memberlist,
93 Content contentTree) {
94 String unicode = uc.toString();
95 contentTree.addContent(getMarkerAnchorForIndex(unicode));
96 Content headContent = new StringContent(unicode);
97 Content heading = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, false,
98 HtmlStyle.title, headContent);
99 contentTree.addContent(heading);
100 int memberListSize = memberlist.size();
101 // Display the list only if there are elements to be displayed.
102 if (memberListSize > 0) {
103 Content dl = new HtmlTree(HtmlTag.DL);
104 for (int i = 0; i < memberListSize; i++) {
105 Doc element = memberlist.get(i);
106 if (element instanceof MemberDoc) {
107 addDescription((MemberDoc)element, dl);
108 } else if (element instanceof ClassDoc) {
109 addDescription((ClassDoc)element, dl);
110 } else if (element instanceof PackageDoc) {
111 addDescription((PackageDoc)element, dl);
112 }
113 }
114 contentTree.addContent(dl);
115 }
116 }
118 /**
119 * Add one line summary comment for the package.
120 *
121 * @param pkg the package to be documented
122 * @param dlTree the content tree to which the description will be added
123 */
124 protected void addDescription(PackageDoc pkg, Content dlTree) {
125 Content link = getPackageLink(pkg, new StringContent(Util.getPackageName(pkg)));
126 Content dt = HtmlTree.DT(link);
127 dt.addContent(" - ");
128 dt.addContent(getResource("doclet.package"));
129 dt.addContent(" " + pkg.name());
130 dlTree.addContent(dt);
131 Content dd = new HtmlTree(HtmlTag.DD);
132 addSummaryComment(pkg, dd);
133 dlTree.addContent(dd);
134 }
136 /**
137 * Add one line summary comment for the class.
138 *
139 * @param cd the class being documented
140 * @param dlTree the content tree to which the description will be added
141 */
142 protected void addDescription(ClassDoc cd, Content dlTree) {
143 Content link = getLink(new LinkInfoImpl(configuration,
144 LinkInfoImpl.Kind.INDEX, cd).strong(true));
145 Content dt = HtmlTree.DT(link);
146 dt.addContent(" - ");
147 addClassInfo(cd, dt);
148 dlTree.addContent(dt);
149 Content dd = new HtmlTree(HtmlTag.DD);
150 addComment(cd, dd);
151 dlTree.addContent(dd);
152 }
154 /**
155 * Add the classkind (class, interface, exception), error of the class
156 * passed.
157 *
158 * @param cd the class being documented
159 * @param contentTree the content tree to which the class info will be added
160 */
161 protected void addClassInfo(ClassDoc cd, Content contentTree) {
162 contentTree.addContent(getResource("doclet.in",
163 Util.getTypeName(configuration, cd, false),
164 getPackageLink(cd.containingPackage(),
165 Util.getPackageName(cd.containingPackage()))
166 ));
167 }
169 /**
170 * Add description for Class, Field, Method or Constructor.
171 *
172 * @param member MemberDoc for the member of the Class Kind
173 * @param dlTree the content tree to which the description will be added
174 */
175 protected void addDescription(MemberDoc member, Content dlTree) {
176 String name = (member instanceof ExecutableMemberDoc)?
177 member.name() + ((ExecutableMemberDoc)member).flatSignature() :
178 member.name();
179 Content span = HtmlTree.SPAN(HtmlStyle.memberNameLink,
180 getDocLink(LinkInfoImpl.Kind.INDEX, member, name));
181 Content dt = HtmlTree.DT(span);
182 dt.addContent(" - ");
183 addMemberDesc(member, dt);
184 dlTree.addContent(dt);
185 Content dd = new HtmlTree(HtmlTag.DD);
186 addComment(member, dd);
187 dlTree.addContent(dd);
188 }
190 /**
191 * Add comment for each element in the index. If the element is deprecated
192 * and it has a @deprecated tag, use that comment. Else if the containing
193 * class for this element is deprecated, then add the word "Deprecated." at
194 * the start and then print the normal comment.
195 *
196 * @param element Index element
197 * @param contentTree the content tree to which the comment will be added
198 */
199 protected void addComment(ProgramElementDoc element, Content contentTree) {
200 Tag[] tags;
201 Content span = HtmlTree.SPAN(HtmlStyle.deprecatedLabel, deprecatedPhrase);
202 HtmlTree div = new HtmlTree(HtmlTag.DIV);
203 div.addStyle(HtmlStyle.block);
204 if (Util.isDeprecated(element)) {
205 div.addContent(span);
206 if ((tags = element.tags("deprecated")).length > 0)
207 addInlineDeprecatedComment(element, tags[0], div);
208 contentTree.addContent(div);
209 } else {
210 ClassDoc cont = element.containingClass();
211 while (cont != null) {
212 if (Util.isDeprecated(cont)) {
213 div.addContent(span);
214 contentTree.addContent(div);
215 break;
216 }
217 cont = cont.containingClass();
218 }
219 addSummaryComment(element, contentTree);
220 }
221 }
223 /**
224 * Add description about the Static Varible/Method/Constructor for a
225 * member.
226 *
227 * @param member MemberDoc for the member within the Class Kind
228 * @param contentTree the content tree to which the member description will be added
229 */
230 protected void addMemberDesc(MemberDoc member, Content contentTree) {
231 ClassDoc containing = member.containingClass();
232 String classdesc = Util.getTypeName(
233 configuration, containing, true) + " ";
234 if (member.isField()) {
235 if (member.isStatic()) {
236 contentTree.addContent(
237 getResource("doclet.Static_variable_in", classdesc));
238 } else {
239 contentTree.addContent(
240 getResource("doclet.Variable_in", classdesc));
241 }
242 } else if (member.isConstructor()) {
243 contentTree.addContent(
244 getResource("doclet.Constructor_for", classdesc));
245 } else if (member.isMethod()) {
246 if (member.isStatic()) {
247 contentTree.addContent(
248 getResource("doclet.Static_method_in", classdesc));
249 } else {
250 contentTree.addContent(
251 getResource("doclet.Method_in", classdesc));
252 }
253 }
254 addPreQualifiedClassLink(LinkInfoImpl.Kind.INDEX, containing,
255 false, contentTree);
256 }
258 /**
259 * Get the marker anchor which will be added to the index documentation tree.
260 *
261 * @param anchorNameForIndex the anchor name attribute for index page
262 * @return a content tree for the marker anchor
263 */
264 public Content getMarkerAnchorForIndex(String anchorNameForIndex) {
265 return getMarkerAnchor(getNameForIndex(anchorNameForIndex), null);
266 }
268 /**
269 * Generate a valid HTML name for member index page.
270 *
271 * @param unicode the string that needs to be converted to valid HTML name.
272 * @return a valid HTML name string.
273 */
274 public String getNameForIndex(String unicode) {
275 return "I:" + getName(unicode);
276 }
277 }