-
Notifications
You must be signed in to change notification settings - Fork 5.4k
/
SubWriterHolderWriter.java
338 lines (307 loc) · 12.3 KB
/
SubWriterHolderWriter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
/*
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package jdk.javadoc.internal.doclets.formats.html;
import java.util.*;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import com.sun.source.doctree.DeprecatedTree;
import com.sun.source.doctree.DocTree;
import jdk.javadoc.internal.doclets.formats.html.markup.BodyContents;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlId;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
/**
* This abstract class exists to provide functionality needed in the
* the formatting of member information. Since AbstractSubWriter and its
* subclasses control this, they would be the logical place to put this.
* However, because each member type has its own subclass, subclassing
* can not be used effectively to change formatting. The concrete
* class subclass of this class can be subclassed to change formatting.
*
* <p><b>This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
* This code and its internal interfaces are subject to change or
* deletion without notice.</b>
*
* @see AbstractMemberWriter
* @see ClassWriterImpl
*/
public abstract class SubWriterHolderWriter extends HtmlDocletWriter {
/**
* The HTML builder for the body contents.
*/
protected BodyContents bodyContents = new BodyContents();
public SubWriterHolderWriter(HtmlConfiguration configuration, DocPath filename) {
super(configuration, filename);
}
/**
* Add the summary header.
*
* @param mw the writer for the member being documented
* @param memberTree the content tree to which the summary header will be added
*/
public void addSummaryHeader(AbstractMemberWriter mw, Content memberTree) {
mw.addSummaryLabel(memberTree);
}
/**
* Add the inherited summary header.
*
* @param mw the writer for the member being documented
* @param typeElement the te to be documented
* @param inheritedTree the content tree to which the inherited summary header will be added
*/
public void addInheritedSummaryHeader(AbstractMemberWriter mw, TypeElement typeElement,
Content inheritedTree) {
mw.addInheritedSummaryLabel(typeElement, inheritedTree);
}
/**
* Add the index comment.
*
* @param member the member being documented
* @param contentTree the content tree to which the comment will be added
*/
protected void addIndexComment(Element member, Content contentTree) {
List<? extends DocTree> tags = utils.getFirstSentenceTrees(member);
addIndexComment(member, tags, contentTree);
}
/**
* Add the index comment.
*
* @param member the member being documented
* @param firstSentenceTags the first sentence tags for the member to be documented
* @param tdSummary the content tree to which the comment will be added
*/
protected void addIndexComment(Element member, List<? extends DocTree> firstSentenceTags,
Content tdSummary) {
addPreviewSummary(member, tdSummary);
List<? extends DeprecatedTree> deprs = utils.getDeprecatedTrees(member);
Content div;
if (utils.isDeprecated(member)) {
Content deprLabel = HtmlTree.SPAN(HtmlStyle.deprecatedLabel, getDeprecatedPhrase(member));
div = HtmlTree.DIV(HtmlStyle.block, deprLabel);
if (!deprs.isEmpty()) {
addSummaryDeprecatedComment(member, deprs.get(0), div);
}
tdSummary.add(div);
return;
} else {
Element te = member.getEnclosingElement();
if (te != null && utils.isTypeElement(te) && utils.isDeprecated(te)) {
Content deprLabel = HtmlTree.SPAN(HtmlStyle.deprecatedLabel, getDeprecatedPhrase(te));
div = HtmlTree.DIV(HtmlStyle.block, deprLabel);
tdSummary.add(div);
}
}
addSummaryComment(member, firstSentenceTags, tdSummary);
}
/**
* Add the summary link for the member.
*
* @param mw the writer for the member being documented
* @param member the member to be documented
* @param contentTree the content tree to which the link will be added
*/
public void addSummaryLinkComment(AbstractMemberWriter mw, Element member, Content contentTree) {
List<? extends DocTree> tags = utils.getFirstSentenceTrees(member);
addSummaryLinkComment(mw, member, tags, contentTree);
}
/**
* Add the summary link comment.
*
* @param mw the writer for the member being documented
* @param member the member being documented
* @param firstSentenceTags the first sentence tags for the member to be documented
* @param tdSummary the content tree to which the comment will be added
*/
public void addSummaryLinkComment(AbstractMemberWriter mw,
Element member, List<? extends DocTree> firstSentenceTags, Content tdSummary) {
addIndexComment(member, firstSentenceTags, tdSummary);
}
/**
* Add the inherited member summary.
*
* @param mw the writer for the member being documented
* @param typeElement the class being documented
* @param member the member being documented
* @param isFirst true if its the first link being documented
* @param linksTree the content tree to which the summary will be added
*/
public void addInheritedMemberSummary(AbstractMemberWriter mw,
TypeElement typeElement,
Element member,
boolean isFirst,
Content linksTree) {
if (!isFirst) {
linksTree.add(", ");
}
mw.addInheritedSummaryLink(typeElement, member, linksTree);
}
/**
* Get the document content header tree
*
* @return a content tree the document content header
*/
public Content getContentHeader() {
return new ContentBuilder();
}
/**
* Add the class content tree.
*
* @param classContentTree class content tree which will be added to the content tree
*/
public void addClassContentTree(Content classContentTree) {
bodyContents.addMainContent(classContentTree);
}
/**
* Add the annotation content tree.
*
* @param annotationContentTree annotation content tree which will be added to the content tree
*/
public void addAnnotationContentTree(Content annotationContentTree) {
addClassContentTree(annotationContentTree);
}
/**
* Get the member header tree
*
* @return a content tree for the member header
*/
public Content getMemberTreeHeader() {
HtmlTree ul = new HtmlTree(TagName.UL);
ul.setStyle(HtmlStyle.blockList);
return ul;
}
/**
* Returns a list to be used for the list of summaries for members of a given kind.
*
* @return a list to be used for the list of summaries for members of a given kind
*/
public Content getSummariesList() {
return new HtmlTree(TagName.UL).setStyle(HtmlStyle.summaryList);
}
/**
* Returns an item for the list of summaries for members of a given kind.
*
* @param content content for the item
* @return an item for the list of summaries for members of a given kind
*/
public Content getSummariesListItem(Content content) {
return HtmlTree.LI(content);
}
/**
* Returns a list to be used for the list of details for members of a given kind.
*
* @return a list to be used for the list of details for members of a given kind
*/
public Content getDetailsList() {
return new HtmlTree(TagName.UL).setStyle(HtmlStyle.detailsList);
}
/**
* Returns an item for the list of details for members of a given kind.
*
* @param content content for the item
* @return an item for the list of details for members of a given kind
*/
public Content getDetailsListItem(Content content) {
return HtmlTree.LI(content);
}
/**
* Returns a list to be used for the list of members of a given kind.
*
* @return a list to be used for the list of members of a given kind
*/
public Content getMemberList() {
return new HtmlTree(TagName.UL).setStyle(HtmlStyle.memberList);
}
/**
* Returns an item for the list of elements of a given kind
*
* @param content content for the item
* @return an item for the list of elements of a given kind
*/
public Content getMemberListItem(Content content) {
return HtmlTree.LI(content);
}
public Content getMemberInheritedTree() {
HtmlTree div = new HtmlTree(TagName.DIV);
div.setStyle(HtmlStyle.inheritedList);
return div;
}
/**
* Adds a section for a summary tree with the given CSS {@code class} and {@code id} attribute.
*
* @param style the CSS class for the section
* @param htmlId the id for the section
* @param summariesList the list of summary sections to which the summary will be added
* @param content the content tree representing the summary
*/
public void addSummary(HtmlStyle style, HtmlId htmlId, Content summariesList, Content content) {
HtmlTree htmlTree = HtmlTree.SECTION(style, content)
.setId(htmlId);
summariesList.add(getSummariesListItem(htmlTree));
}
/**
* Get the member tree
*
* @param contentTree the tree used to generate the complete member tree
* @return a content tree for the member
*/
public Content getMemberTree(Content contentTree) {
return HtmlTree.LI(contentTree);
}
/**
* Get the member summary tree
*
* @param contentTree the tree used to generate the member summary tree
* @return a content tree for the member summary
*/
public Content getMemberSummaryTree(Content contentTree) {
return HtmlTree.SECTION(HtmlStyle.summary, contentTree);
}
/**
* Get the member details tree
*
* @param contentTree the tree used to generate the member details tree
* @return a content tree for the member details
*/
public Content getMemberDetailsTree(Content contentTree) {
return HtmlTree.SECTION(HtmlStyle.details, contentTree);
}
/**
* Get the member tree
*
* @param id the id to be used for the content tree
* @param style the style class to be added to the content tree
* @param contentTree the tree used to generate the complete member tree
* @return the member tree
*/
public Content getMemberTree(HtmlId id, HtmlStyle style, Content contentTree) {
return HtmlTree.SECTION(style, contentTree).setId(id);
}
}